Update REST documentation #24180

Seris370 · 2023-05-26T03:35:28Z

ARM API Information (Control Plane)

Changelog

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

What's the purpose of the update?
- new service onboarding
- new API version
- update existing version for new feature
- update existing version to fix swagger quality issue in s360
- Other, please clarify
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.
When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
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):

I commit to follow the Breaking Change Policy of "no breaking changes"
I have reviewed the documentation for the workflow.
Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?

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:

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
  -[ ] 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. Note that this doesn't apply if you are trying to merge a PR that was previously in the private repository.
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 · 2023-05-26T03:35:31Z

Hi, @Seris370 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 · 2023-05-26T03:35:32Z

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]

There are no breaking changes.

compared swaggers (via Oad v0.10.4)]	new version	base version
ManagedEnvironments.json	2022-01-01-preview(e49e515)	2022-01-01-preview(main)
ManagedEnvironments.json	2022-06-01-preview(e49e515)	2022-06-01-preview(main)
ManagedEnvironments.json	2022-11-01-preview(e49e515)	2022-11-01-preview(main)
ManagedEnvironments.json	2023-04-01-preview(e49e515)	2023-04-01-preview(main)
ManagedEnvironments.json	2022-03-01(e49e515)	2022-03-01(main)
ManagedEnvironments.json	2022-10-01(e49e515)	2022-10-01(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 tags (via openapi-validator v2.1.2)	new version	base version
package-2022-03	package-2022-03(e49e515)	package-2022-03(main)
package-2022-01-01-preview	package-2022-01-01-preview(e49e515)	package-2022-01-01-preview(main)
package-2022-10	package-2022-10(e49e515)	package-2022-10(main)
package-preview-2022-06	package-preview-2022-06(e49e515)	package-preview-2022-06(main)
package-preview-2023-04	package-preview-2023-04(e49e515)	package-preview-2023-04(main)
package-preview-2022-11	package-preview-2022-11(e49e515)	package-preview-2022-11(main)

The following errors/warnings exist before current PR submission:

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

Rule	Message
`❌` PutResponseSchemaDescription	Description of 200 response code of a PUT operation MUST include term 'update'. Location: Microsoft.App/preview/2022-01-01-preview/ManagedEnvironments.json#L181
`❌` LroErrorContent	Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.App/preview/2022-01-01-preview/ManagedEnvironments.json#L197
`❌` DeleteOperationAsyncResponseValidation	An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.App/preview/2022-01-01-preview/ManagedEnvironments.json#L208
`❌` LroLocationHeader	A 202 response should include an Location response header. Location: Microsoft.App/preview/2022-01-01-preview/ManagedEnvironments.json#L237
`❌` LroErrorContent	Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.App/preview/2022-01-01-preview/ManagedEnvironments.json#L246
`❌` ResourceNameRestriction	The resource name parameter 'managedEnvironmentName' should be defined with a 'pattern' restriction. Location: Microsoft.App/preview/2022-01-01-preview/ManagedEnvironments.json#L312
`❌` ResourceNameRestriction	The resource name parameter 'managedEnvironmentName' should be defined with a 'pattern' restriction. Location: Microsoft.App/preview/2022-01-01-preview/ManagedEnvironments.json#L362
`❌` PutResponseSchemaDescription	Any Put MUST contain 200 and 201 return codes. Location: Microsoft.App/preview/2022-01-01-preview/ManagedEnvironments.json#L455
`❌` ResourceNameRestriction	The resource name parameter 'environmentName' should be defined with a 'pattern' restriction. Location: Microsoft.App/preview/2022-06-01-preview/ManagedEnvironments.json#L101
`❌` PutResponseSchemaDescription	Description of 200 response code of a PUT operation MUST include term 'update'. Location: Microsoft.App/preview/2022-06-01-preview/ManagedEnvironments.json#L181
`❌` LroErrorContent	Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.App/preview/2022-06-01-preview/ManagedEnvironments.json#L197
`❌` LroLocationHeader	A 202 response should include an Location response header. Location: Microsoft.App/preview/2022-06-01-preview/ManagedEnvironments.json#L237
`❌` LroErrorContent	Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.App/preview/2022-06-01-preview/ManagedEnvironments.json#L246
`❌` UnSupportedPatchProperties	The patch operation body parameter schema should not contains property name. Location: Microsoft.App/preview/2022-06-01-preview/ManagedEnvironments.json#L278
`❌` UnSupportedPatchProperties	The patch operation body parameter schema should not contains property type. Location: Microsoft.App/preview/2022-06-01-preview/ManagedEnvironments.json#L278
`❌` UnSupportedPatchProperties	The patch operation body parameter schema should not contains property location. Location: Microsoft.App/preview/2022-06-01-preview/ManagedEnvironments.json#L278
`❌` PatchBodyParametersSchema	Properties of a PATCH request body must not be required, property:location. Location: Microsoft.App/preview/2022-06-01-preview/ManagedEnvironments.json#L283
`❌` LroLocationHeader	A 202 response should include an Location response header. Location: Microsoft.App/preview/2022-06-01-preview/ManagedEnvironments.json#L298
`❌` LroErrorContent	Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.App/preview/2022-06-01-preview/ManagedEnvironments.json#L304
`❌` ResourceNameRestriction	The resource name parameter 'environmentName' should be defined with a 'pattern' restriction. Location: Microsoft.App/preview/2022-06-01-preview/ManagedEnvironments.json#L316
`❌` ResourceNameRestriction	The resource name parameter 'environmentName' should be defined with a 'pattern' restriction. Location: Microsoft.App/preview/2022-06-01-preview/ManagedEnvironments.json#L366
`❌` ResourceNameRestriction	The resource name parameter 'certificateName' should be defined with a 'pattern' restriction. Location: Microsoft.App/preview/2022-06-01-preview/ManagedEnvironments.json#L366
`❌` PutResponseSchemaDescription	Any Put MUST contain 200 and 201 return codes. Location: Microsoft.App/preview/2022-06-01-preview/ManagedEnvironments.json#L459
`❌` ResourceNameRestriction	The resource name parameter 'environmentName' should be defined with a 'pattern' restriction. Location: Microsoft.App/preview/2022-06-01-preview/ManagedEnvironments.json#L594
`❌` ResourceNameRestriction	The resource name parameter 'environmentName' should be defined with a 'pattern' restriction. Location: Microsoft.App/preview/2022-06-01-preview/ManagedEnvironments.json#L653
`❌` ResourceNameRestriction	The resource name parameter 'environmentName' should be defined with a 'pattern' restriction. Location: Microsoft.App/preview/2022-06-01-preview/ManagedEnvironments.json#L700
`❌` ResourceNameRestriction	The resource name parameter 'environmentName' should be defined with a 'pattern' restriction. Location: Microsoft.App/preview/2022-11-01-preview/ManagedEnvironments.json#L101
`❌` PutResponseSchemaDescription	Description of 200 response code of a PUT operation MUST include term 'update'. Location: Microsoft.App/preview/2022-11-01-preview/ManagedEnvironments.json#L181
`❌` LroErrorContent	Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.App/preview/2022-11-01-preview/ManagedEnvironments.json#L197
`❌` LroLocationHeader	A 202 response should include an Location response header. Location: Microsoft.App/preview/2022-11-01-preview/ManagedEnvironments.json#L240

️️✔️Avocado succeeded [Detail] [Expand]

Validation passes for Avocado.

️️✔️ApiReadinessCheck succeeded [Detail] [Expand]

️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]

API Test is not triggered due to precheck failure. Check pipeline log for details.

️️✔️SwaggerAPIView succeeded [Detail] [Expand]

️️✔️CadlAPIView 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.

️️✔️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.

️️✔️TypeSpec Validation succeeded [Detail] [Expand]

Validation passes for TypeSpec Validation.

️️✔️PR Summary succeeded [Detail] [Expand]

Validation passes for Summary.

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2023-05-26T03:35:33Z

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/appcontainers/armappcontainers - Approved - 2.0.0-beta.4

+	Function `*JobsClient.BeginStopMultipleExecutions` parameter(s) have been changed from `(context.Context, string, string, JobExecutionNamesCollection, *JobsClientBeginStopMultipleExecutionsOptions)` to `(context.Context, string, string, *JobsClientBeginStopMultipleExecutionsOptions)`

❌azure-sdk-for-python-track2 - track2_azure-mgmt-appcontainers - Approved - 3.0.0b1

+	Operation JobsOperations.begin_stop_multiple_executions no longer has parameter job_execution_name

❌azure-sdk-for-js - @azure/arm-appcontainers - 2.0.0-beta.4

+	Interface ContainerAppsRevisionsListRevisionsNextOptionalParams no longer has parameter filter
+	Interface VnetConfiguration no longer has parameter runtimeSubnetId
+	Type of parameter customDomainVerificationFailureInfo of interface CustomHostnameAnalysisResult is changed from DefaultErrorResponse to CustomHostnameAnalysisResultCustomDomainVerificationFailureInfo
+	Type of parameter value of interface DaprSecretsCollection is changed from Secret[] to DaprSecret[]

️⚠️ azure-sdk-for-python-track2 warning [Detail]

⚠️Warning [Logs]Release - Generate from 280a956. SDK Automation 14.0.0

command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
cmderr	[automation_generate.sh]
cmderr	[automation_generate.sh] npm notice New minor version of npm available! 9.5.1 -> 9.6.7
cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.6.7>
cmderr	[automation_generate.sh] npm notice Run `npm install -g [email protected]` to update!
cmderr	[automation_generate.sh] npm notice

️✔️track2_azure-mgmt-appcontainers [View full logs] [Release SDK Changes] Breaking Change Detected

info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog]   - Added operation ContainerAppsOperations.begin_start
info	[Changelog]   - Added operation ContainerAppsOperations.begin_stop
info	[Changelog]   - Added operation group ContainerAppsAPIClientOperationsMixin
info	[Changelog]   - Model AzureCredentials has a new parameter kind
info	[Changelog]   - Model Configuration has a new parameter service
info	[Changelog]   - Model GithubActionConfiguration has a new parameter github_personal_access_token
info	[Changelog]   - Model JobConfiguration has a new parameter event_trigger_config
info	[Changelog]   - Model ManagedEnvironment has a new parameter peer_authentication
info	[Changelog]   - Model Replica has a new parameter init_containers
info	[Changelog]   - Model Replica has a new parameter running_state
info	[Changelog]   - Model Replica has a new parameter running_state_details
info	[Changelog]   - Model ReplicaContainer has a new parameter running_state
info	[Changelog]   - Model ReplicaContainer has a new parameter running_state_details
info	[Changelog]   - Model Revision has a new parameter running_state
info	[Changelog]   - Model Template has a new parameter service_binds
info	[Changelog]   - Model Template has a new parameter termination_grace_period_seconds
info	[Changelog]   - Model Volume has a new parameter mount_options
info	[Changelog]   - Model VolumeMount has a new parameter sub_path
info	[Changelog]
info	[Changelog] ### Breaking Changes
info	[Changelog]
info	[Changelog]   - Operation JobsOperations.begin_stop_multiple_executions no longer has parameter job_execution_name

️⚠️ azure-sdk-for-java warning [Detail]

⚠️Warning [Logs]Release - Generate from 280a956. SDK Automation 14.0.0

command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.1.2
cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.1.2
cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json

️✔️azure-resourcemanager-appcontainers [View full logs] [Release SDK Changes]

️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 280a956. 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/appcontainers/armappcontainers [View full logs] [Release SDK Changes] Breaking Change Detected

info	[Changelog] ### Breaking Changes
info	[Changelog]
info	[Changelog] - Function `*JobsClient.BeginStopMultipleExecutions` parameter(s) have been changed from `(context.Context, string, string, JobExecutionNamesCollection, *JobsClientBeginStopMultipleExecutionsOptions)` to `(context.Context, string, string, *JobsClientBeginStopMultipleExecutionsOptions)`
info	[Changelog]
info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog] - New enum type `ContainerAppContainerRunningState` with values `ContainerAppContainerRunningStateRunning`, `ContainerAppContainerRunningStateTerminated`, `ContainerAppContainerRunningStateWaiting`
info	[Changelog] - New enum type `ContainerAppReplicaRunningState` with values `ContainerAppReplicaRunningStateNotRunning`, `ContainerAppReplicaRunningStateRunning`, `ContainerAppReplicaRunningStateUnknown`
info	[Changelog] - New enum type `RevisionRunningState` with values `RevisionRunningStateDegraded`, `RevisionRunningStateFailed`, `RevisionRunningStateProcessing`, `RevisionRunningStateRunning`, `RevisionRunningStateStopped`, `RevisionRunningStateUnknown`
info	[Changelog] - New function `*ClientFactory.NewContainerAppsAPIClient() *ContainerAppsAPIClient`
info	[Changelog] - New function `NewContainerAppsAPIClient(string, azcore.TokenCredential, *arm.ClientOptions) (*ContainerAppsAPIClient, error)`
info	[Changelog] - New function `*ContainerAppsAPIClient.JobExecution(context.Context, string, string, string, *ContainerAppsAPIClientJobExecutionOptions) (ContainerAppsAPIClientJobExecutionResponse, error)`
info	[Changelog] - New function `*ContainerAppsClient.BeginStart(context.Context, string, string, *ContainerAppsClientBeginStartOptions) (*runtime.Poller[ContainerAppsClientStartResponse], error)`
info	[Changelog] - New function `*ContainerAppsClient.BeginStop(context.Context, string, string, *ContainerAppsClientBeginStopOptions) (*runtime.Poller[ContainerAppsClientStopResponse], error)`
info	[Changelog] - New struct `JobConfigurationEventTriggerConfig`
info	[Changelog] - New struct `JobScale`
info	[Changelog] - New struct `JobScaleRule`
info	[Changelog] - New struct `ManagedEnvironmentPropertiesPeerAuthentication`
info	[Changelog] - New struct `Mtls`
info	[Changelog] - New struct `Service`
info	[Changelog] - New struct `ServiceBind`
info	[Changelog] - New field `Kind` in struct `AzureCredentials`
info	[Changelog] - New field `Service` in struct `Configuration`
info	[Changelog] - New field `GithubPersonalAccessToken` in struct `GithubActionConfiguration`
info	[Changelog] - New field `EventTriggerConfig` in struct `JobConfiguration`
info	[Changelog] - New field `PeerAuthentication` in struct `ManagedEnvironmentProperties`
info	[Changelog] - New field `RunningState`, `RunningStateDetails` in struct `ReplicaContainer`
info	[Changelog] - New field `InitContainers`, `RunningState`, `RunningStateDetails` in struct `ReplicaProperties`
info	[Changelog] - New field `RunningState` in struct `RevisionProperties`
info	[Changelog] - New field `ServiceBinds`, `TerminationGracePeriodSeconds` in struct `Template`
info	[Changelog] - New field `MountOptions` in struct `Volume`
info	[Changelog] - New field `SubPath` in struct `VolumeMount`
info	[Changelog]
info	[Changelog] Total 1 breaking change(s), 45 additive change(s).

️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 280a956. 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-appcontainers [View full logs] [Release SDK Changes] Breaking Change Detected

azure-arm-appcontainers-2.0.0-beta.4.tgz

Only show 120 items here, please refer to log for details.

info	[Changelog]   - Added Type Alias ContainerAppReplicaRunningState
info	[Changelog]   - Added Type Alias ContainerAppsDiagnosticsGetDetectorResponse
info	[Changelog]   - Added Type Alias ContainerAppsDiagnosticsGetRevisionResponse
info	[Changelog]   - Added Type Alias ContainerAppsDiagnosticsGetRootResponse
info	[Changelog]   - Added Type Alias ContainerAppsDiagnosticsListDetectorsNextResponse
info	[Changelog]   - Added Type Alias ContainerAppsDiagnosticsListDetectorsResponse
info	[Changelog]   - Added Type Alias ContainerAppsDiagnosticsListRevisionsNextResponse
info	[Changelog]   - Added Type Alias ContainerAppsDiagnosticsListRevisionsResponse
info	[Changelog]   - Added Type Alias ContainerAppsGetAuthTokenResponse
info	[Changelog]   - Added Type Alias ContainerAppsStartResponse
info	[Changelog]   - Added Type Alias ContainerAppsStopResponse
info	[Changelog]   - Added Type Alias ContainerAppsUpdateResponse
info	[Changelog]   - Added Type Alias ExtendedLocationTypes
info	[Changelog]   - Added Type Alias IngressClientCertificateMode
info	[Changelog]   - Added Type Alias JobExecutionResponse
info	[Changelog]   - Added Type Alias JobExecutionRunningState
info	[Changelog]   - Added Type Alias JobProvisioningState
info	[Changelog]   - Added Type Alias JobsCreateOrUpdateResponse
info	[Changelog]   - Added Type Alias JobsExecutionsListNextResponse
info	[Changelog]   - Added Type Alias JobsExecutionsListResponse
info	[Changelog]   - Added Type Alias JobsGetResponse
info	[Changelog]   - Added Type Alias JobsListByResourceGroupNextResponse
info	[Changelog]   - Added Type Alias JobsListByResourceGroupResponse
info	[Changelog]   - Added Type Alias JobsListBySubscriptionNextResponse
info	[Changelog]   - Added Type Alias JobsListBySubscriptionResponse
info	[Changelog]   - Added Type Alias JobsListSecretsResponse
info	[Changelog]   - Added Type Alias JobsStartResponse
info	[Changelog]   - Added Type Alias JobsStopMultipleExecutionsResponse
info	[Changelog]   - Added Type Alias JobsUpdateResponse
info	[Changelog]   - Added Type Alias LogLevel
info	[Changelog]   - Added Type Alias ManagedCertificateDomainControlValidation
info	[Changelog]   - Added Type Alias ManagedCertificatesCreateOrUpdateResponse
info	[Changelog]   - Added Type Alias ManagedCertificatesGetResponse
info	[Changelog]   - Added Type Alias ManagedCertificatesListNextResponse
info	[Changelog]   - Added Type Alias ManagedCertificatesListResponse
info	[Changelog]   - Added Type Alias ManagedCertificatesUpdateResponse
info	[Changelog]   - Added Type Alias ManagedEnvironmentDiagnosticsGetDetectorResponse
info	[Changelog]   - Added Type Alias ManagedEnvironmentDiagnosticsListDetectorsResponse
info	[Changelog]   - Added Type Alias ManagedEnvironmentsDiagnosticsGetRootResponse
info	[Changelog]   - Added Type Alias ManagedEnvironmentsGetAuthTokenResponse
info	[Changelog]   - Added Type Alias ManagedEnvironmentsListWorkloadProfileStatesNextResponse
info	[Changelog]   - Added Type Alias ManagedEnvironmentsListWorkloadProfileStatesResponse
info	[Changelog]   - Added Type Alias ManagedEnvironmentsUpdateResponse
info	[Changelog]   - Added Type Alias RevisionRunningState
info	[Changelog]   - Added Type Alias TriggerType
info	[Changelog]   - Interface AzureCredentials has a new optional parameter kind
info	[Changelog]   - Interface CertificateProperties has a new optional parameter subjectAlternativeNames
info	[Changelog]   - Interface Configuration has a new optional parameter maxInactiveRevisions
info	[Changelog]   - Interface Configuration has a new optional parameter service
info	[Changelog]   - Interface ContainerApp has a new optional parameter environmentId
info	[Changelog]   - Interface ContainerApp has a new optional parameter eventStreamEndpoint
info	[Changelog]   - Interface ContainerApp has a new optional parameter extendedLocation
info	[Changelog]   - Interface ContainerApp has a new optional parameter latestReadyRevisionName
info	[Changelog]   - Interface ContainerApp has a new optional parameter managedBy
info	[Changelog]   - Interface ContainerApp has a new optional parameter workloadProfileName
info	[Changelog]   - Interface ContainerAppSecret has a new optional parameter identity
info	[Changelog]   - Interface ContainerAppSecret has a new optional parameter keyVaultUrl
info	[Changelog]   - Interface CustomHostnameAnalysisResult has a new optional parameter conflictWithEnvironmentCustomDomain
info	[Changelog]   - Interface Dapr has a new optional parameter enableApiLogging
info	[Changelog]   - Interface Dapr has a new optional parameter httpMaxRequestSize
info	[Changelog]   - Interface Dapr has a new optional parameter httpReadBufferSize
info	[Changelog]   - Interface Dapr has a new optional parameter logLevel
info	[Changelog]   - Interface DaprComponent has a new optional parameter secretStoreComponent
info	[Changelog]   - Interface GithubActionConfiguration has a new optional parameter githubPersonalAccessToken
info	[Changelog]   - Interface Ingress has a new optional parameter clientCertificateMode
info	[Changelog]   - Interface Ingress has a new optional parameter corsPolicy
info	[Changelog]   - Interface Ingress has a new optional parameter exposedPort
info	[Changelog]   - Interface Ingress has a new optional parameter ipSecurityRestrictions
info	[Changelog]   - Interface Ingress has a new optional parameter stickySessions
info	[Changelog]   - Interface ManagedEnvironment has a new optional parameter customDomainConfiguration
info	[Changelog]   - Interface ManagedEnvironment has a new optional parameter daprConfiguration
info	[Changelog]   - Interface ManagedEnvironment has a new optional parameter eventStreamEndpoint
info	[Changelog]   - Interface ManagedEnvironment has a new optional parameter infrastructureResourceGroup
info	[Changelog]   - Interface ManagedEnvironment has a new optional parameter kedaConfiguration
info	[Changelog]   - Interface ManagedEnvironment has a new optional parameter kind
info	[Changelog]   - Interface ManagedEnvironment has a new optional parameter peerAuthentication
info	[Changelog]   - Interface ManagedEnvironment has a new optional parameter workloadProfiles
info	[Changelog]   - Interface Replica has a new optional parameter initContainers
info	[Changelog]   - Interface Replica has a new optional parameter runningState
info	[Changelog]   - Interface Replica has a new optional parameter runningStateDetails
info	[Changelog]   - Interface ReplicaContainer has a new optional parameter execEndpoint
info	[Changelog]   - Interface ReplicaContainer has a new optional parameter logStreamEndpoint
info	[Changelog]   - Interface ReplicaContainer has a new optional parameter runningState
info	[Changelog]   - Interface ReplicaContainer has a new optional parameter runningStateDetails
info	[Changelog]   - Interface Revision has a new optional parameter lastActiveTime
info	[Changelog]   - Interface Revision has a new optional parameter runningState
info	[Changelog]   - Interface ScaleRule has a new optional parameter tcp
info	[Changelog]   - Interface Secret has a new optional parameter identity
info	[Changelog]   - Interface Secret has a new optional parameter keyVaultUrl
info	[Changelog]   - Interface Template has a new optional parameter initContainers
info	[Changelog]   - Interface Template has a new optional parameter serviceBinds
info	[Changelog]   - Interface Template has a new optional parameter terminationGracePeriodSeconds
info	[Changelog]   - Interface Volume has a new optional parameter mountOptions
info	[Changelog]   - Interface Volume has a new optional parameter secrets
info	[Changelog]   - Interface VolumeMount has a new optional parameter subPath
info	[Changelog]   - Added Enum KnownAction
info	[Changelog]   - Added Enum KnownAffinity
info	[Changelog]   - Added Enum KnownApplicability
info	[Changelog]   - Added Enum KnownConnectedEnvironmentProvisioningState
info	[Changelog]   - Added Enum KnownContainerAppContainerRunningState
info	[Changelog]   - Added Enum KnownContainerAppReplicaRunningState
info	[Changelog]   - Added Enum KnownExtendedLocationTypes
info	[Changelog]   - Added Enum KnownIngressClientCertificateMode
info	[Changelog]   - Added Enum KnownJobExecutionRunningState
info	[Changelog]   - Added Enum KnownJobProvisioningState
info	[Changelog]   - Added Enum KnownLogLevel
info	[Changelog]   - Added Enum KnownManagedCertificateDomainControlValidation
info	[Changelog]   - Added Enum KnownRevisionRunningState
info	[Changelog]   - Added Enum KnownTriggerType
info	[Changelog]   - Enum KnownContainerAppProvisioningState has a new value Deleting
info	[Changelog]   - Enum KnownIngressTransportMethod has a new value Tcp
info	[Changelog]   - Enum KnownStorageType has a new value Secret
info	[Changelog]   - Added function getContinuationToken
info	[Changelog]
info	[Changelog] **Breaking Changes**
info	[Changelog]
info	[Changelog]   - Interface ContainerAppsRevisionsListRevisionsNextOptionalParams no longer has parameter filter
info	[Changelog]   - Interface VnetConfiguration no longer has parameter runtimeSubnetId
info	[Changelog]   - Type of parameter customDomainVerificationFailureInfo of interface CustomHostnameAnalysisResult is changed from DefaultErrorResponse to CustomHostnameAnalysisResultCustomDomainVerificationFailureInfo
info	[Changelog]   - Type of parameter value of interface DaprSecretsCollection is changed from Secret[] to DaprSecret[]

️⚠️ azure-resource-manager-schemas warning [Detail]

⚠️Warning [Logs]Release - Generate from 280a956. Schema Automation 14.0.0

command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
cmderr	[initScript.sh] WARN old lockfile
cmderr	[initScript.sh] npm WARN old lockfile The package-lock.json file was created with an old version of npm,
cmderr	[initScript.sh] npm WARN old lockfile so supplemental metadata must be fetched from the registry.
cmderr	[initScript.sh] npm WARN old lockfile
cmderr	[initScript.sh] npm WARN old lockfile This is a one-time fix-up, please be patient...
cmderr	[initScript.sh] npm WARN old lockfile
warn	File azure-resource-manager-schemas_tmp/initOutput.json not found to read
command	.sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json

️✔️app [View full logs] [Release Schema Changes]

️❌ azure-powershell failed [Detail]

❌Pipeline Framework Failed [Logs]Release - Generate from 280a956. 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
SSL error: syscall failure: Broken pipe
Error: SSL error: syscall failure: Broken pipe

️✔️Az.app.DefaultTag [View full logs]

Az.ContainerAppsApi.0.1.0.nupkg

error	Fatal error: SSL error: syscall failure: Broken pipe
error	The following packages are still pending:
error		Az.app.DefaultTag

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2023-05-26T03:35:34Z

Generated ApiView

Language	Package Name	ApiView Link
Go	sdk/resourcemanager/appcontainers/armappcontainers	Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.
Java	azure-resourcemanager-appcontainers	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-appcontainers	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 · 2023-05-26T03:35:34Z

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

Seris370 · 2023-05-26T08:19:00Z

@Wzb123456789 Could you please help with breaking change review? Thanks

Wzb123456789 · 2023-05-29T09:02:48Z

Reviewer to approve this PR before I can do a BreakingChange review.

openapi-assignment-bot bot assigned Wzb123456789 May 26, 2023

ghost added the customer-reported Issues that are reported by GitHub users external to the Azure organization. label May 26, 2023

This was referenced May 26, 2023

[AutoPR sdk/resourcemanager/appcontainers/armappcontainers] Update REST documentation azure-sdk/azure-sdk-for-go#5883

Closed

[AutoPR app] Update REST documentation azure-sdk/azure-resource-manager-schemas#2659

Closed

AzureRestAPISpecReview added the resource-manager label May 26, 2023

Seris370 changed the title ~~modify doc~~ Update REST documentation May 26, 2023

openapi-pipeline-app bot added CI-BreakingChange-Go CI-BreakingChange-Python-Track2 CI-BreakingChange-JavaScript labels May 26, 2023

Chenghui Yu added 3 commits May 26, 2023 14:49

modify doc

def17b3

change all api versions

c3e0c8c

change description

e49e515

Seris370 force-pushed the doc-main branch from 4d5a047 to e49e515 Compare May 26, 2023 06:51

Juliehzl approved these changes May 29, 2023

View reviewed changes

tadelesh added the Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go label May 29, 2023

msyyc added the Approved-SdkBreakingChange-Python label May 29, 2023

chunyu3 merged commit 280a956 into Azure:main May 29, 2023

This was referenced May 29, 2023

[ReleasePR track2_azure-mgmt-appcontainers] Release app microsoft.app 2023 08 01 preview Azure/azure-sdk-for-python#24305

Closed

[ReleasePR azure-resourcemanager-appcontainers] Release app microsoft.app 2023 08 01 preview Azure/azure-sdk-for-java#28566

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update REST documentation #24180

Update REST documentation #24180

Seris370 commented May 26, 2023 •

edited

Loading

openapi-workflow-bot bot commented May 26, 2023

openapi-pipeline-app bot commented May 26, 2023 •

edited

Loading

openapi-pipeline-app bot commented May 26, 2023 •

edited

Loading

Breaking Changes Tracking

openapi-pipeline-app bot commented May 26, 2023 •

edited

Loading

ghost commented May 26, 2023

Seris370 commented May 26, 2023

Wzb123456789 commented May 29, 2023

Update REST documentation #24180

Update REST documentation #24180

Conversation

Seris370 commented May 26, 2023 • edited Loading

ARM API Information (Control Plane)

Changelog

Contribution checklist (MS Employees Only):

ARM API Review Checklist

Breaking Change Review Checklist

openapi-workflow-bot bot commented May 26, 2023

openapi-pipeline-app bot commented May 26, 2023 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented May 26, 2023 • edited Loading

Swagger Generation Artifacts

Breaking Changes Tracking

openapi-pipeline-app bot commented May 26, 2023 • edited Loading

Generated ApiView

ghost commented May 26, 2023

Seris370 commented May 26, 2023

Wzb123456789 commented May 29, 2023

Seris370 commented May 26, 2023 •

edited

Loading

openapi-pipeline-app bot commented May 26, 2023 •

edited

Loading

openapi-pipeline-app bot commented May 26, 2023 •

edited

Loading

openapi-pipeline-app bot commented May 26, 2023 •

edited

Loading