Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

AAD Domain Services: add 09-01-2022 API version #20768

Merged
merged 9 commits into from
Nov 10, 2022

Conversation

ehunter1878
Copy link
Contributor

@ehunter1878 ehunter1878 commented Sep 19, 2022

ARM API Information (Control Plane)

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.

Changelog

Add a changelog entry for this PR by answering the following questions:

  1. What's the purpose of the update?
    • new service onboarding
    • [ X ] new API version
    • update existing version for new feature
    • update existing version to fix swagger quality issue in s360
    • Other, please clarify
  2. When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
    October 2022
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
    October 2022
  4. By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.

Contribution checklist (MS Employees Only):

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Applicability: ⚠️

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

  • Change to data plane APIs
  • Adding new properties
  • All removals

Otherwise your PR may be subject to ARM review requirements. Complete the following:

  • [ X ] Check this box if any of the following apply to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.

    • Adding a new service
    • Adding new API(s)
    • Adding a new API version
      -[ X ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki.
  • [ X ] Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.

  • If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.

Breaking Change Review Checklist

If you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.

NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)

Please follow the link to find more details on PR review process.

@openapi-workflow-bot
Copy link

Hi, @ehunter1878 Thanks for your PR. I am workflow bot for review process. Here are some small tips.

  • Please ensure to do self-check against checklists in first PR comment.
  • PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.
  • For specs comparison cross API versions, Use API Specs Comparison Report Generator
  • If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

  • Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected]

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Sep 19, 2022

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
    There are no breaking changes.
    compared swaggers (via Oad v0.10.2)] new version base version
    domainservices.json 2022-09-01(709e414) 2021-05-01(main)
    oucontainer.json 2022-09-01(709e414) 2021-05-01(main)
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️⚠️LintDiff: 0 Warnings warning [Detail]
    compared tags (via openapi-validator v2.0.0) new version base version
    package-2022-09 package-2022-09(709e414) default(main)

    The following errors/warnings exist before current PR submission:

    Only 30 items are listed, please refer to log for more details.

    Rule Message
    PathResourceProviderNamePascalCase Resource provider naming must follow the pascal case. Path: '/providers/Microsoft.AAD/operations'
    Location: Microsoft.AAD/stable/2022-09-01/domainservices.json#L30
    OperationsApiResponseSchema The response schema of operations API '/providers/Microsoft.AAD/operations' does not match the ARM specification. Please standardize the schema.
    Location: Microsoft.AAD/stable/2022-09-01/domainservices.json#L45
    PathResourceProviderNamePascalCase Resource provider naming must follow the pascal case. Path: '/subscriptions/{subscriptionId}/providers/Microsoft.AAD/domainServices'
    Location: Microsoft.AAD/stable/2022-09-01/domainservices.json#L66
    PathResourceProviderNamePascalCase Resource provider naming must follow the pascal case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AAD/domainServices'
    Location: Microsoft.AAD/stable/2022-09-01/domainservices.json#L106
    PathResourceProviderNamePascalCase Resource provider naming must follow the pascal case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AAD/domainServices/{domainServiceName}'
    Location: Microsoft.AAD/stable/2022-09-01/domainservices.json#L149
    ResourceNameRestriction The resource name parameter 'domainServiceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.AAD/stable/2022-09-01/domainservices.json#L149
    CreateOperationAsyncResponseValidation An async PUT operation must set long running operation options 'x-ms-long-running-operation-options'
    Location: Microsoft.AAD/stable/2022-09-01/domainservices.json#L150
    LongRunningResponseStatusCode A 'put' operation 'DomainServices_CreateOrUpdate' with x-ms-long-running-operation extension must have a valid terminal success status code 200 or 201.
    Location: Microsoft.AAD/stable/2022-09-01/domainservices.json#L150
    CreateOperationAsyncResponseValidation Only 201 is the supported response code for PUT async response.
    Location: Microsoft.AAD/stable/2022-09-01/domainservices.json#L193
    LroLocationHeader A 202 response should include an Location response header.
    Location: Microsoft.AAD/stable/2022-09-01/domainservices.json#L193
    DeleteOperationAsyncResponseValidation An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options'
    Location: Microsoft.AAD/stable/2022-09-01/domainservices.json#L254
    LroLocationHeader A 202 response should include an Location response header.
    Location: Microsoft.AAD/stable/2022-09-01/domainservices.json#L276
    UnSupportedPatchProperties The patch operation body parameter schema should not contains property name.
    Location: Microsoft.AAD/stable/2022-09-01/domainservices.json#L316
    UnSupportedPatchProperties The patch operation body parameter schema should not contains property type.
    Location: Microsoft.AAD/stable/2022-09-01/domainservices.json#L316
    UnSupportedPatchProperties The patch operation body parameter schema should not contains property location.
    Location: Microsoft.AAD/stable/2022-09-01/domainservices.json#L316
    LroLocationHeader A 202 response should include an Location response header.
    Location: Microsoft.AAD/stable/2022-09-01/domainservices.json#L333
    XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.AAD/stable/2022-09-01/domainservices.json#L465
    XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.AAD/stable/2022-09-01/domainservices.json#L766
    XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.AAD/stable/2022-09-01/domainservices.json#L974
    XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.AAD/stable/2022-09-01/domainservices.json#L1066
    XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.AAD/stable/2022-09-01/domainservices.json#L1080
    XmsParameterLocation The parameter 'SubscriptionIdParameter' is defined in global parameters section without 'x-ms-parameter-location' extension. This would add the parameter as the client property. Please ensure that this is exactly you want. If so, apply the extension 'x-ms-parameter-location': 'client'. Else, apply the extension 'x-ms-parameter-location': 'method'.
    Location: Microsoft.AAD/stable/2022-09-01/domainservices.json#L1136
    XmsParameterLocation The parameter 'ApiVersionParameter' is defined in global parameters section without 'x-ms-parameter-location' extension. This would add the parameter as the client property. Please ensure that this is exactly you want. If so, apply the extension 'x-ms-parameter-location': 'client'. Else, apply the extension 'x-ms-parameter-location': 'method'.
    Location: Microsoft.AAD/stable/2022-09-01/domainservices.json#L1143
    PathResourceProviderMatchNamespace The last resource provider 'Microsoft.Aad' doesn't match the namespace.
    Location: Microsoft.AAD/stable/2022-09-01/oucontainer.json#L30
    OperationsApiResponseSchema The response schema of operations API '/providers/Microsoft.Aad/operations' does not match the ARM specification. Please standardize the schema.
    Location: Microsoft.AAD/stable/2022-09-01/oucontainer.json#L51
    PathResourceProviderMatchNamespace The last resource provider 'Microsoft.Aad' doesn't match the namespace.
    Location: Microsoft.AAD/stable/2022-09-01/oucontainer.json#L66
    ResourceNameRestriction The resource name parameter 'domainServiceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.AAD/stable/2022-09-01/oucontainer.json#L66
    PathResourceProviderMatchNamespace The last resource provider 'Microsoft.Aad' doesn't match the namespace.
    Location: Microsoft.AAD/stable/2022-09-01/oucontainer.json#L112
    ResourceNameRestriction The resource name parameter 'domainServiceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.AAD/stable/2022-09-01/oucontainer.json#L112
    ResourceNameRestriction The resource name parameter 'ouContainerName' should be defined with a 'pattern' restriction.
    Location: Microsoft.AAD/stable/2022-09-01/oucontainer.json#L112
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
    ️❌~[Staging] ServiceAPIReadinessTest: 0 Errors, 0 Warnings failed [Detail]

    Tag package-2022-09; Prod region: Not deployed; Canary region: Not deployed

    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️️✔️PoliCheck succeeded [Detail] [Expand]
    Validation passed for PoliCheck.
    ️️✔️PrettierCheck succeeded [Detail] [Expand]
    Validation passes for PrettierCheck.
    ️️✔️SpellCheck succeeded [Detail] [Expand]
    Validation passes for SpellCheck.
    ️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
    Validation passes for Lint(RPaaS).
    ️️✔️CadlValidation succeeded [Detail] [Expand]
    Validation passes for CadlValidation.
    ️️✔️PR Summary succeeded [Detail] [Expand]
    Validation passes for Summary.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Sep 19, 2022

    Swagger Generation Artifacts

    ️️✔️ApiDocPreview succeeded [Detail] [Expand]
     Please click here to preview with your @microsoft account. 
    ️❌SDK Breaking Change Tracking failed [Detail]

    Breaking Changes Tracking

    azure-sdk-for-go - sdk/resourcemanager/domainservices/armdomainservices - Approved - 2.0.0
    +	Struct `CloudErrorBody` has been removed
    +	Struct `CloudError` has been removed

    ️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 8a20cee. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	sudo apt-get install -y dotnet-sdk-6.0
      command	autorest --version=2.0.4421 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION [email protected]/[email protected] --csharp-sdks-folder=/mnt/vss/_work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/domainservices/resource-manager/readme.md
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
    • ️✔️Microsoft.Azure.Management.DomainServices [View full logs]  [Release SDK Changes]
      warn	Skip artifact folder because it doesn't exist: artifacts/packages
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 8a20cee. SDK Automation 14.0.0
      command	sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
      command	generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
    • ️✔️sdk/resourcemanager/domainservices/armdomainservices [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog] - Struct `CloudError` has been removed
      info	[Changelog] - Struct `CloudErrorBody` has been removed
      info	[Changelog]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog] - New const `ChannelBindingDisabled`
      info	[Changelog] - New const `SyncScopeCloudOnly`
      info	[Changelog] - New const `LdapSigningEnabled`
      info	[Changelog] - New const `ChannelBindingEnabled`
      info	[Changelog] - New const `SyncScopeAll`
      info	[Changelog] - New const `LdapSigningDisabled`
      info	[Changelog] - New type alias `SyncScope`
      info	[Changelog] - New type alias `ChannelBinding`
      info	[Changelog] - New type alias `LdapSigning`
      info	[Changelog] - New function `PossibleLdapSigningValues() []LdapSigning`
      info	[Changelog] - New function `PossibleChannelBindingValues() []ChannelBinding`
      info	[Changelog] - New function `PossibleSyncScopeValues() []SyncScope`
      info	[Changelog] - New field `SyncScope` in struct `DomainServiceProperties`
      info	[Changelog] - New field `ChannelBinding` in struct `DomainSecuritySettings`
      info	[Changelog] - New field `LdapSigning` in struct `DomainSecuritySettings`
      info	[Changelog]
      info	[Changelog] Total 4 breaking change(s), 14 additive change(s).
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 8a20cee. SDK Automation 14.0.0
      command	sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json
      warn	File azure-sdk-for-js_tmp/initOutput.json not found to read
      command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json
    • ️✔️@azure/arm-domainservices [View full logs]  [Release SDK Changes]
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Added Interface DomainService
      info	[Changelog]   - Added Interface OuContainer
      info	[Changelog]   - Added Type Alias ChannelBinding
      info	[Changelog]   - Added Type Alias LdapSigning
      info	[Changelog]   - Added Type Alias SyncScope
      info	[Changelog]   - Interface DomainSecuritySettings has a new optional parameter channelBinding
      info	[Changelog]   - Interface DomainSecuritySettings has a new optional parameter ldapSigning
      info	[Changelog]   - Added Enum KnownChannelBinding
      info	[Changelog]   - Added Enum KnownLdapSigning
      info	[Changelog]   - Added Enum KnownSyncScope
    ️️✔️ azure-powershell succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 8a20cee. SDK Automation 14.0.0
      command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
      command	pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json
    • ️✔️Az.DomainServices [View full logs]  [Release SDK Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Sep 19, 2022

    Generated ApiView

    Language Package Name ApiView Link
    Go sdk/resourcemanager/domainservices/armdomainservices Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.
    JavaScript @azure/arm-domainservices Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.

    @ghost ghost added the customer-reported Issues that are reported by GitHub users external to the Azure organization. label Sep 19, 2022
    @ghost
    Copy link

    ghost commented Sep 19, 2022

    Thank you for your contribution ehunter1878! We will review the pull request and get back to you soon.

    @ruowan
    Copy link
    Member

    ruowan commented Sep 20, 2022

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    @openapi-workflow-bot
    Copy link

    Hi @ehunter1878, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.

    TaskHow to fixPriority
    AvocadoFix-AvocadoHigh
    Semantic validationFix-SemanticValidation-ErrorHigh
    Model validationFix-ModelValidation-ErrorHigh
    LintDiffFix-LintDiffhigh
    If you need further help, please feedback via swagger feedback.

    @mentat9 mentat9 added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Sep 27, 2022
    @openapi-workflow-bot
    Copy link

    Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove ARMChangesRequested

    @openapi-workflow-bot openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Sep 27, 2022
    @AzureRestAPISpecReview AzureRestAPISpecReview added the BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required label Oct 10, 2022
    @openapi-workflow-bot
    Copy link

    Hi @ehunter1878, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review.
    Action: To initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
    If you want to know the production traffic statistic, please see ARM Traffic statistic.
    If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback.
    Note: To avoid breaking change, you can refer to Shift Left Solution for detecting breaking change in early phase at your service code repository.

    @leniatgh leniatgh closed this Oct 21, 2022
    @leniatgh leniatgh reopened this Oct 21, 2022
    @leniatgh
    Copy link
    Contributor

    @ehunter1878 Can you try again? I closed and reopened this PR, following the comments in microsoft/ContributorLicenseAgreement#54

    @ehunter1878
    Copy link
    Contributor Author

    @microsoft-github-policy-service agree company="Microsoft"

    @leniatgh
    Copy link
    Contributor

    @raych1 please help check the ModelValidation errors

    @ehunter1878
    Copy link
    Contributor Author

    @raych1 could you help with the ModelValidation errors? I attempted a fix but that caused more problems.

    @ehunter1878
    Copy link
    Contributor Author

    @mentat9 is there anything else we need to do to get this reviewed and checked in?

    @rkmanda rkmanda removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Nov 8, 2022
    @openapi-workflow-bot openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Nov 8, 2022
    @rkmanda rkmanda added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Nov 9, 2022
    @openapi-workflow-bot openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Nov 9, 2022
    @leniatgh leniatgh removed the customer-reported Issues that are reported by GitHub users external to the Azure organization. label Nov 10, 2022
    @leniatgh
    Copy link
    Contributor

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    @openapi-pipeline-app openapi-pipeline-app bot added the customer-reported Issues that are reported by GitHub users external to the Azure organization. label Nov 10, 2022
    @leniatgh leniatgh merged commit 8a20cee into Azure:main Nov 10, 2022
    anandanthony pushed a commit to anandMicro/azure-rest-api-specs that referenced this pull request Dec 16, 2022
    * Add new API folder
    
    * Add new API 2022-09-01
    
    * Fixed casing and naming issues
    
    * Fixing Swagger Violations
    
    * Fix date-time invalid format
    
    * Fix DateTime attempt 2
    
    * Fix DateTime attempt 3
    
    * Fix Prettier Check
    
    * Fixing Swagger Violations for LRO
    kayousef-zz pushed a commit to kayousef-zz/azure-rest-api-specs that referenced this pull request Dec 21, 2022
    * Add new API folder
    
    * Add new API 2022-09-01
    
    * Fixed casing and naming issues
    
    * Fixing Swagger Violations
    
    * Fix date-time invalid format
    
    * Fix DateTime attempt 2
    
    * Fix DateTime attempt 3
    
    * Fix Prettier Check
    
    * Fixing Swagger Violations for LRO
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review CI-BreakingChange-Go CI-MissingBaseCommit customer-reported Issues that are reported by GitHub users external to the Azure organization. new-api-version ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    7 participants