azure-rest-api-specs
azure-rest-api-specs copied to clipboard
Azure
Release cpim microsoft.azure active directory preview/2023 05 17 preview docs update
ARM (Control Plane) API Specification Update Pull Request
[!TIP] Overwhelmed by all this guidance? See the
Getting helpsection at the bottom of this PR description.
PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
Purpose of this PR
What's the purpose of this PR? Check the specific option that applies. This is mandatory!
- [ ] New resource provider.
- [ ] New API version for an existing resource provider. (If API spec is not defined in TypeSpec, the PR should have been created in adherence to OpenAPI specs PR creation guidance).
- [ ] Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
- [ ] Update existing version to fix OpenAPI spec quality issues in S360.
- [X] Other, please clarify:
- Updating api docs with new name for product
Due diligence checklist
To merge this PR, you must go through the following checklist and confirm you understood and followed the instructions by checking all the boxes:
- [X] I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
- [X] I have reviewed following Resource Provider guidelines, including
ARM resource provider contract and
REST guidelines (estimated time: 4 hours).
I understand this is required before I can proceed to the diagram Step 2, "ARM API changes review", for this PR.
Additional information
Viewing API changes
For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.
Suppressing failures
If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the suppressions guide to get approval.
Getting help
- First, please carefully read through this PR description, from top to bottom. Please fill out the
Purpose of this PRandDue diligence checklist. - If you don't have permissions to remove or add labels to the PR, request
write accessper aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories - To understand what you must do next to merge this PR, see the
Next Steps to Mergecomment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state. - For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure and https://aka.ms/ci-fix.
- For help with ARM review (PR workflow diagram Step 2), see https://aka.ms/azsdk/pr-arm-review.
- If the PR CI checks appear to be stuck in
queuedstate, please add a comment with contents/azp run. This should result in a new comment denoting aPR validation pipelinehas started and the checks should be updated after few minutes. - If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.
Next Steps to Merge
Next steps that must be taken to merge this PR:- ❌ This is the public specs repo
mainbranch which is not intended for iterative development.
You must acknowledge that you understand that after this PR is merged, you won't be able to stop your changes from being published to Azure customers.
If this is what you intend, addPublishToCustomerslabel to your PR.
Otherwise, retarget this PR onto a feature branch, i.e. with prefixrelease-(see aka.ms/azsdk/api-versions#release--branches). - ❌ This PR is in purview of the ARM review (label:
ARMReview). This PR must getARMSignedOfflabel from an ARM reviewer.
This PR is not ready for ARM review (label:NotReadyForARMReview). This PR will not be reviewed by ARM until relevant problems are fixed. Consult the rest of thisNext Steps to Mergecomment for details.
Once the blocking problems are addressed, add to the PR a comment with contents/azp run. Automation will re-evaluate this PR and if everything looks good, it will addWaitForARMFeedbacklabel which will put this PR on the ARM review queue.
For details of the ARM review, see aka.ms/azsdk/pr-arm-review - ❌ This PR is
NotReadyForARMReviewbecause it has theVersioningReviewRequiredlabel. - ❌ This PR has at least one change violating Azure versioning policy (label:
VersioningReviewRequired).
To unblock this PR, either a) introduce a new API version with these changes instead of modifying an existing API version, or b) follow the process at aka.ms/brch. - ❌ The required check named
Swagger BreakingChangehas failed. To unblock this PR, follow the process at aka.ms/brch.
![openapi-pipeline-app[bot] avatar](https://avatars.githubusercontent.com/in/65541?v=4 "Published by a pub.dev verified publisher"){kind=small}
Swagger Validation Report
️❌BreakingChange: 29 Errors, 0 Warnings failed [Detail]
| Compared specs (v0.10.12) | new version | base version |
|---|---|---|
| externalIdentities.json | 2023-05-17-preview(3fe7eb4) | 2023-05-17-preview(main) |
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 0 Warnings warning [Detail]
| Compared specs (v2.2.2) | new version | base version |
|---|---|---|
| package-preview-2023-05 | package-preview-2023-05(3fe7eb4) | package-preview-2023-05(main) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.AzureActiveDirectory/preview/2023-05-17-preview/externalIdentities.json#L110 |
|
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.AzureActiveDirectory/preview/2023-05-17-preview/externalIdentities.json#L149 |
|
The resource name parameter 'resourceName' should be defined with a 'pattern' restriction. Location: Microsoft.AzureActiveDirectory/preview/2023-05-17-preview/externalIdentities.json#L165 |
|
200 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes. Location: Microsoft.AzureActiveDirectory/preview/2023-05-17-preview/externalIdentities.json#L206 |
|
201 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes. Location: Microsoft.AzureActiveDirectory/preview/2023-05-17-preview/externalIdentities.json#L206 |
|
A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'B2CTenants_Create' Request Model: 'parameters[4].schema' Response Model: 'responses[200].schema' Location: Microsoft.AzureActiveDirectory/preview/2023-05-17-preview/externalIdentities.json#L206 |
|
Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: Microsoft.AzureActiveDirectory/preview/2023-05-17-preview/externalIdentities.json#L206 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.AzureActiveDirectory/preview/2023-05-17-preview/externalIdentities.json#L261 |
|
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.AzureActiveDirectory/preview/2023-05-17-preview/externalIdentities.json#L317 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.AzureActiveDirectory/preview/2023-05-17-preview/externalIdentities.json#L365 |
|
Operations API path must follow the schema provided in the common types. Location: Microsoft.AzureActiveDirectory/preview/2023-05-17-preview/externalIdentities.json#L396 |
|
The resource name parameter 'resourceName' should be defined with a 'pattern' restriction. Location: Microsoft.AzureActiveDirectory/preview/2023-05-17-preview/externalIdentities.json#L411 |
|
Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: Microsoft.AzureActiveDirectory/preview/2023-05-17-preview/externalIdentities.json#L412 |
|
Properties of a PATCH request body must not be required, property:name. Location: Microsoft.AzureActiveDirectory/preview/2023-05-17-preview/externalIdentities.json#L895 |
|
Properties of a PATCH request body must not be required, property:tier. Location: Microsoft.AzureActiveDirectory/preview/2023-05-17-preview/externalIdentities.json#L895 |
|
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.AzureActiveDirectory/preview/2023-05-17-preview/externalIdentities.json#L1767 |
|
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.AzureActiveDirectory/preview/2023-05-17-preview/externalIdentities.json#L1790 |
| :warning: PreviewVersionOverOneYear | The API version:2023-05-17-preview having been in a preview state over one year , please move it to GA or retire. Location: Microsoft.AzureActiveDirectory/preview/2023-05-17-preview/externalIdentities.json#L5 |
| :warning: ParameterDescription | Parameter should have a description. Location: Microsoft.AzureActiveDirectory/preview/2023-05-17-preview/externalIdentities.json#L60 |
| :warning: ParameterDescription | Parameter should have a description. Location: Microsoft.AzureActiveDirectory/preview/2023-05-17-preview/externalIdentities.json#L230 |
| :warning: ParameterDescription | Parameter should have a description. Location: Microsoft.AzureActiveDirectory/preview/2023-05-17-preview/externalIdentities.json#L294 |
| :warning: EnumInsteadOfBoolean | Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.AzureActiveDirectory/preview/2023-05-17-preview/externalIdentities.json#L1005 |
| :warning: AvoidNestedProperties | Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.AzureActiveDirectory/preview/2023-05-17-preview/externalIdentities.json#L1048 |
| :warning: EnumInsteadOfBoolean | Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.AzureActiveDirectory/preview/2023-05-17-preview/externalIdentities.json#L1148 |
| :warning: SchemaDescriptionOrTitle | Schema should have a description or title. Location: Microsoft.AzureActiveDirectory/preview/2023-05-17-preview/externalIdentities.json#L1217 |
| :warning: LatestVersionOfCommonTypesMustBeUsed | Use the latest version v5 of types.json. Location: Microsoft.AzureActiveDirectory/preview/2023-05-17-preview/externalIdentities.json#L1277 |
| :warning: LocationMustHaveXmsMutability | Property location must have 'x-ms-mutability':['read', 'create'] extension defined.Location: Microsoft.AzureActiveDirectory/preview/2023-05-17-preview/externalIdentities.json#L1306 |
| :warning: EnumInsteadOfBoolean | Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.AzureActiveDirectory/preview/2023-05-17-preview/externalIdentities.json#L1352 |
| :warning: LatestVersionOfCommonTypesMustBeUsed | Use the latest version v5 of types.json. Location: Microsoft.AzureActiveDirectory/preview/2023-05-17-preview/externalIdentities.json#L1406 |
| :warning: LatestVersionOfCommonTypesMustBeUsed | Use the latest version v5 of types.json. Location: Microsoft.AzureActiveDirectory/preview/2023-05-17-preview/externalIdentities.json#L1450 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
️️✔️ApiDocPreview succeeded [Detail] [Expand]
Please click here to preview with your @microsoft account.
️⚠️ azure-sdk-for-python warning [Detail]
- For more instructions, please refer to the FAQ .
⚠️Warning in generating from eb3fa812c49a363722bb76aa4570fc2eef4bf03b. SDK Automation 14.0.0command sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json cmderr [automation_init.sh] W: Target Packages (main/binary-amd64/Packages) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1 cmderr [automation_init.sh] W: Target Packages (main/binary-all/Packages) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1 cmderr [automation_init.sh] W: Target Translations (main/i18n/Translation-en) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1 cmderr [automation_init.sh] W: Target CNF (main/cnf/Commands-amd64) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1 cmderr [automation_init.sh] W: Target CNF (main/cnf/Commands-all) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1 cmderr [automation_init.sh] W: Target Packages (main/binary-amd64/Packages) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1 cmderr [automation_init.sh] W: Target Packages (main/binary-all/Packages) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1 cmderr [automation_init.sh] W: Target Translations (main/i18n/Translation-en) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1 cmderr [automation_init.sh] W: Target CNF (main/cnf/Commands-amd64) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1 cmderr [automation_init.sh] W: Target CNF (main/cnf/Commands-all) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1 cmderr [automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed. cmderr [automation_init.sh] npm notice cmderr [automation_init.sh] npm notice New minor version of npm available! 10.7.0 -> 10.8.1 cmderr [automation_init.sh] npm notice Changelog: https://github.com/npm/cli/releases/tag/v10.8.1 cmderr [automation_init.sh] npm notice To update run: npm install -g [email protected] cmderr [automation_init.sh] npm notice command sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json warn Warning: No file changes detected after the generation. Please refer to the generation errors to understand the reasons. warn Warning: No package detected after generation. Please refer to the above logs to understand why the package hasn't been generated.
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
- For more instructions, please refer to the FAQ .
️✔️Succeeded in generating from eb3fa812c49a363722bb76aa4570fc2eef4bf03b. SDK Automation 14.0.0command 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/azureadexternalidentities/armazureadexternalidentities [Preview SDK Changes]
️⚠️ azure-powershell warning [Detail]
- For more instructions, please refer to the FAQ .
⚠️Warning in generating from eb3fa812c49a363722bb76aa4570fc2eef4bf03b. SDK Automation 14.0.0command 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.cpim.DefaultTag [Preview SDK Changes]
Generated ApiView
| Language | Package Name | ApiView Link |
|---|---|---|
| Go | sdk/resourcemanager/azureadexternalidentities/armazureadexternalidentities | https://apiview.dev/Assemblies/Review/f3c85d82874c41dd9b1c2d237f1914eb?revisionId=f27bf4172eab4de99b817bc52ea36664 |
| Swagger | Microsoft.AzureActiveDirectory | https://apiview.dev/Assemblies/Review/72c5a63d154b4daf9225a0fbcd66930a?revisionId=0101e82615df4c45919902f363a5a20b |
Hi, @AndresZourelli. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.
![microsoft-github-policy-service[bot] avatar](https://avatars.githubusercontent.com/in/95686?v=4 "Published by a pub.dev verified publisher"){kind=small}
Hi, @AndresZourelli. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee.