update putDeployment example #24486

tianxin-ms · 2023-06-16T20:23:34Z

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-06-16T20:23:38Z

Hi, @tianxin-ms 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-06-16T20:23:38Z

Swagger Validation Report

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

There are no breaking changes.

️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️CredScan succeeded [Detail] [Expand]

There is no credential detected.

️️✔️LintDiff succeeded [Detail] [Expand]

Validation passes for LintDiff.

️️✔️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-06-16T20:23:39Z

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]

️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

Breaking Changes Tracking

️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from a72e896. SDK Automation 14.0.0

command	pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json
command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json

️✔️Azure.ResourceManager.CognitiveServices [View full logs] [Release SDK Changes]
- Azure.ResourceManager.CognitiveServices.1.3.0-alpha.20230621.1.nupkg
```
info	[Changelog]
```

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

⚠️Warning [Logs]Release - Generate from a72e896. 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] npm notice
cmderr	[automation_generate.sh] npm notice New minor version of npm available! 9.5.1 -> 9.7.1
cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.7.1>
cmderr	[automation_generate.sh] npm notice Run `npm install -g [email protected]` to update!
cmderr	[automation_generate.sh] npm notice

️✔️track2_azure-mgmt-cognitiveservices [View full logs] [Release SDK Changes]

info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog]   - Added operation group ModelsOperations
info	[Changelog]   - Added operation group UsagesOperations
info	[Changelog]   - Model AccountModel has a new parameter is_default_version
info	[Changelog]   - Model AccountModel has a new parameter skus
info	[Changelog]   - Model AccountModel has a new parameter source
info	[Changelog]   - Model AccountProperties has a new parameter abuse_penalty
info	[Changelog]   - Model CommitmentPlanProperties has a new parameter provisioning_issues
info	[Changelog]   - Model Deployment has a new parameter sku
info	[Changelog]   - Model DeploymentModel has a new parameter source
info	[Changelog]   - Model DeploymentProperties has a new parameter rate_limits
info	[Changelog]   - Model DeploymentProperties has a new parameter version_upgrade_option
info	[Changelog]   - Model UsageListResult has a new parameter next_link

️❌ azure-sdk-for-java failed [Detail]

❌Failed [Logs]Release - Generate from a72e896. 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-cognitiveservices [View full logs] [Release SDK Changes]
- pom.xml

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

️✔️Succeeded [Logs]Release - Generate from a72e896. 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/cognitiveservices/armcognitiveservices [View full logs] [Release SDK Changes]

info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog] - New value `DeploymentProvisioningStateCanceled`, `DeploymentProvisioningStateDisabled` added to enum type `DeploymentProvisioningState`
info	[Changelog] - New value `HostingModelProvisionedWeb` added to enum type `HostingModel`
info	[Changelog] - New enum type `AbusePenaltyAction` with values `AbusePenaltyActionBlock`, `AbusePenaltyActionThrottle`
info	[Changelog] - New enum type `DeploymentModelVersionUpgradeOption` with values `DeploymentModelVersionUpgradeOptionNoAutoUpgrade`, `DeploymentModelVersionUpgradeOptionOnceCurrentVersionExpired`, `DeploymentModelVersionUpgradeOptionOnceNewDefaultVersionAvailable`
info	[Changelog] - New function `*ClientFactory.NewModelsClient() *ModelsClient`
info	[Changelog] - New function `*ClientFactory.NewUsagesClient() *UsagesClient`
info	[Changelog] - New function `NewModelsClient(string, azcore.TokenCredential, *arm.ClientOptions) (*ModelsClient, error)`
info	[Changelog] - New function `*ModelsClient.NewListPager(string, *ModelsClientListOptions) *runtime.Pager[ModelsClientListResponse]`
info	[Changelog] - New function `NewUsagesClient(string, azcore.TokenCredential, *arm.ClientOptions) (*UsagesClient, error)`
info	[Changelog] - New function `*UsagesClient.NewListPager(string, *UsagesClientListOptions) *runtime.Pager[UsagesClientListResponse]`
info	[Changelog] - New struct `AbusePenalty`
info	[Changelog] - New struct `CapacityConfig`
info	[Changelog] - New struct `Model`
info	[Changelog] - New struct `ModelListResult`
info	[Changelog] - New struct `ModelSKU`
info	[Changelog] - New field `IsDefaultVersion`, `SKUs`, `Source` in struct `AccountModel`
info	[Changelog] - New field `AbusePenalty` in struct `AccountProperties`
info	[Changelog] - New field `ProvisioningIssues` in struct `CommitmentPlanProperties`
info	[Changelog] - New field `SKU` in struct `Deployment`
info	[Changelog] - New field `Source` in struct `DeploymentModel`
info	[Changelog] - New field `RateLimits`, `VersionUpgradeOption` in struct `DeploymentProperties`
info	[Changelog] - New field `NextLink` in struct `UsageListResult`
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 33 additive change(s).

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

️✔️Succeeded [Logs]Release - Generate from a72e896. 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-cognitiveservices [View full logs] [Release SDK Changes]

azure-arm-cognitiveservices-7.5.0.tgz

info	[Changelog] **Features**
info	[Changelog]
info	[Changelog]   - Added operation group Models
info	[Changelog]   - Added operation group Usages
info	[Changelog]   - Added Interface AbusePenalty
info	[Changelog]   - Added Interface CapacityConfig
info	[Changelog]   - Added Interface Model
info	[Changelog]   - Added Interface ModelListResult
info	[Changelog]   - Added Interface ModelSku
info	[Changelog]   - Added Interface ModelsListNextOptionalParams
info	[Changelog]   - Added Interface ModelsListOptionalParams
info	[Changelog]   - Added Interface UsagesListNextOptionalParams
info	[Changelog]   - Added Interface UsagesListOptionalParams
info	[Changelog]   - Added Type Alias AbusePenaltyAction
info	[Changelog]   - Added Type Alias DeploymentModelVersionUpgradeOption
info	[Changelog]   - Added Type Alias ModelsListNextResponse
info	[Changelog]   - Added Type Alias ModelsListResponse
info	[Changelog]   - Added Type Alias UsagesListNextResponse
info	[Changelog]   - Added Type Alias UsagesListResponse
info	[Changelog]   - Interface AccountModel has a new optional parameter isDefaultVersion
info	[Changelog]   - Interface AccountModel has a new optional parameter skus
info	[Changelog]   - Interface AccountProperties has a new optional parameter abusePenalty
info	[Changelog]   - Interface CommitmentPlanProperties has a new optional parameter provisioningIssues
info	[Changelog]   - Interface Deployment has a new optional parameter sku
info	[Changelog]   - Interface DeploymentModel has a new optional parameter source
info	[Changelog]   - Interface DeploymentProperties has a new optional parameter rateLimits
info	[Changelog]   - Interface DeploymentProperties has a new optional parameter versionUpgradeOption
info	[Changelog]   - Interface UsageListResult has a new optional parameter nextLink
info	[Changelog]   - Added Enum KnownAbusePenaltyAction
info	[Changelog]   - Added Enum KnownDeploymentModelVersionUpgradeOption
info	[Changelog]   - Enum KnownDeploymentProvisioningState has a new value Canceled
info	[Changelog]   - Enum KnownDeploymentProvisioningState has a new value Disabled
info	[Changelog]   - Enum KnownHostingModel has a new value ProvisionedWeb

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

⚠️Warning [Logs]Release - Generate from a72e896. 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]  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
warn	No file changes detected after generation

️✔️cognitiveservices [View full logs]

️❌ azure-powershell failed [Detail]

❌Pipeline Framework Failed [Logs]Release - Generate from a72e896. 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.cognitiveservices.DefaultTag [View full logs]

Az.CognitiveServices.0.1.0.nupkg

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

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

openapi-pipeline-app · 2023-06-16T20:23:40Z

Generated ApiView

Language	Package Name	ApiView Link
Go	sdk/resourcemanager/cognitiveservices/armcognitiveservices	Create ApiView failed. Please ask PR assignee for help
JavaScript	@azure/arm-cognitiveservices	Create ApiView failed. Please ask PR assignee for help
.Net	Azure.ResourceManager.CognitiveServices	Create ApiView failed. Please ask PR assignee for help

tianxin-ms · 2023-06-16T20:46:20Z

This PR is just an update of an example.

* update putdeployment example * remove ScaleSettings from example

update putdeployment example

ea885df

tianxin-ms requested a review from yangyuan as a code owner June 16, 2023 20:23

openapi-assignment-bot bot assigned v-jiaodi Jun 16, 2023

ghost added the Cognitive Services label Jun 16, 2023

azure-sdk mentioned this pull request Jun 16, 2023

[AutoPR sdk/resourcemanager/cognitiveservices/armcognitiveservices] update putDeployment example azure-sdk/azure-sdk-for-go#6157

Closed

AzureRestAPISpecReview added the resource-manager label Jun 16, 2023

remove ScaleSettings from example

c0c778e

v-jiaodi approved these changes Jun 19, 2023

View reviewed changes

v-jiaodi added the Approved-OkToMerge <valid label in PR review process>add this label when assignee approve to merge the updates label Jun 19, 2023

yangyuan approved these changes Jun 20, 2023

View reviewed changes

weidongxu-microsoft merged commit a72e896 into Azure:main Jun 21, 2023

harryli0108 pushed a commit to harryli0108/azure-rest-api-specs that referenced this pull request Jul 28, 2023

update putDeployment example (Azure#24486)

ac2b666

* update putdeployment example * remove ScaleSettings from example

tianxin-ms deleted the tianxinliu/update-putdeployment-example branch October 2, 2023 21:04

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

update putDeployment example #24486

update putDeployment example #24486

Uh oh!

tianxin-ms commented Jun 16, 2023 •

edited

Loading

Uh oh!

openapi-workflow-bot bot commented Jun 16, 2023

Uh oh!

openapi-pipeline-app bot commented Jun 16, 2023 •

edited

Loading

Uh oh!

openapi-pipeline-app bot commented Jun 16, 2023 •

edited

Loading

Breaking Changes Tracking

Uh oh!

openapi-pipeline-app bot commented Jun 16, 2023 •

edited

Loading

Uh oh!

tianxin-ms commented Jun 16, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

update putDeployment example #24486

update putDeployment example #24486

Uh oh!

Conversation

tianxin-ms commented Jun 16, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

ARM API Information (Control Plane)

Changelog

Contribution checklist (MS Employees Only):

ARM API Review Checklist

Breaking Change Review Checklist

Uh oh!

openapi-workflow-bot bot commented Jun 16, 2023

Uh oh!

openapi-pipeline-app bot commented Jun 16, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Swagger Validation Report

Uh oh!

openapi-pipeline-app bot commented Jun 16, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Swagger Generation Artifacts

Breaking Changes Tracking

Uh oh!

openapi-pipeline-app bot commented Jun 16, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Generated ApiView

Uh oh!

tianxin-ms commented Jun 16, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

tianxin-ms commented Jun 16, 2023 •

edited

Loading

openapi-pipeline-app bot commented Jun 16, 2023 •

edited

Loading

openapi-pipeline-app bot commented Jun 16, 2023 •

edited

Loading

openapi-pipeline-app bot commented Jun 16, 2023 •

edited

Loading