Adding new preview API version 2022-10-preview by mayankagg9722 · Pull Request #20617 · Azure/azure-rest-api-specs

mayankagg9722 · 2022-09-07T06:57:14Z

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:

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

…on 2022-05-01

openapi-workflow-bot · 2022-09-07T06:57:17Z

Hi, @mayankagg9722 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. vscswagger@microsoft.com

openapi-pipeline-app · 2022-09-07T06:57:20Z

Swagger Validation Report

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

There are no breaking changes.

️❌Breaking Change(Cross-Version): 2 Errors, 0 Warnings failed [Detail]

The following breaking changes are detected by comparison with the latest stable version:

Rule	Message
`❌` Runtime Exception	"new":"https://github.com/Azure/azure-rest-api-specs/blob/342dfbb7a0b5d46bc925c885e7a827839bc498f6/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-10-01-preview/dataprotection.json", "old":"https://github.com/Azure/azure-rest-api-specs/blob/main/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-05-01/dataprotection.json", "details":"Command failed: node /mnt/vss/_work/_tasks/AzureApiValidation_5654d05d-82c1-48da-ad8f-161b817f6d41/0.0.38/common/temp/node_modules/.pnpm/@Azure+oad@0.9.7/node_modules/autorest/dist/app.js --v2 --input-file=specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-10-01-preview/dataprotection.json --output-artifact=swagger-document.json --output-artifact=swagger-document.map --output-file=new --output-folder=/tmp\nERROR: Schema violation: Array items are not unique (indexes 0 and 1)\n - file:///mnt/vss/_work/1/azure-rest-api-specs/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-10-01-preview/dataprotection.json:5822:12 ($.definitions.KubernetesClusterRestoreCriteria.properties.conflictPolicy.enum)\nFATAL: swagger-document/individual/schema-validator - FAILED\nFATAL: Error: [OperationAbortedException] Error occurred. Exiting.\nProcess() cancelled due to exception : [OperationAbortedException] Error occurred. Exiting.\n"

The following breaking changes are detected by comparison with the latest preview version:

Rule	Message
`❌` Runtime Exception	"new":"https://github.com/Azure/azure-rest-api-specs/blob/342dfbb7a0b5d46bc925c885e7a827839bc498f6/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-10-01-preview/dataprotection.json", "old":"https://github.com/Azure/azure-rest-api-specs/blob/main/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-03-31-preview/dataprotection.json", "details":"Command failed: node /mnt/vss/_work/_tasks/AzureApiValidation_5654d05d-82c1-48da-ad8f-161b817f6d41/0.0.38/common/temp/node_modules/.pnpm/@Azure+oad@0.9.7/node_modules/autorest/dist/app.js --v2 --input-file=specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-10-01-preview/dataprotection.json --output-artifact=swagger-document.json --output-artifact=swagger-document.map --output-file=new --output-folder=/tmp\nERROR: Schema violation: Array items are not unique (indexes 0 and 1)\n - file:///mnt/vss/_work/1/azure-rest-api-specs/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-10-01-preview/dataprotection.json:5822:12 ($.definitions.KubernetesClusterRestoreCriteria.properties.conflictPolicy.enum)\nFATAL: swagger-document/individual/schema-validator - FAILED\nFATAL: Error: [OperationAbortedException] Error occurred. Exiting.\nProcess() cancelled due to exception : [OperationAbortedException] Error occurred. Exiting.\n"

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

There is no credential detected.

️❌LintDiff: 2 Errors, 0 Warnings failed [Detail]

[must fix]The following errors/warnings are introduced by current PR:

Rule	Message	Related RPC [For API reviewers]
`❌` AutoRest exception	"location":"specification/dataprotection/resource-manager/readme.md", "tag":"package-2022-10-preview", "details":"swagger-document/individual/schema-validator - FAILED"
`❌` AutoRest exception	"location":"specification/dataprotection/resource-manager/readme.md", "tag":"package-2022-10-preview", "details":"Error: [OperationAbortedException] Error occurred. Exiting."

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

Validation passes for Avocado.

️❌ApiReadinessCheck: 1 Errors, 0 Warnings failed [Detail]

Rule	Message
`❌` API Readiness check failed. Please make sure your service is deployed.	"code: InvalidResourceType, message: The resource type 'operations' could not be found in the namespace 'Microsoft.DataProtection' for api version '2022-10-01-preview'. The supported api-versions are '2020-01-01-alpha, 2021-02-01-preview, 2021-06-01-preview, 2021-01-01, 2021-07-01, 2021-10-01-preview, 2021-12-01-preview, 2022-01-01, 2022-02-01-preview, 2022-03-01, 2022-04-01, 2022-05-01'."

️❌~[Staging] ServiceAPIReadinessTest: 1 Errors, 0 Warnings failed [Detail]

Rule	Message
`❌` ASSERTION_ERROR	"ResourceType 'backupVaults' should be deployed in 'West Central US' on apiVersion '2022-10-01-preview'.: expected [ Array(9) ] to satisfy [Function]"

️❌~[Staging] TrafficValidation: 1 Errors, 0 Warnings failed [Detail]

Rule	Message
`❌` ASSERTION_ERROR	"ResourceType 'backupVaults' should be deployed in 'West Central US' on apiVersion '2022-10-01-preview'.: expected [ Array(9) ] to satisfy [Function]"

️❌ModelValidation: 2 Errors, 0 Warnings failed [Detail]

Rule	Message
`❌` unacceptable kind of an object to dump [object Error]	"role":"Model Validation", "url":"https://github.com/Azure/azure-rest-api-specs/blob/342dfbb7a0b5d46bc925c885e7a827839bc498f6/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-10-01-preview/dataprotection.json"
`❌` unacceptable kind of an object to dump [object Error]	"role":"Model Validation", "url":"https://github.com/Azure/azure-rest-api-specs/blob/342dfbb7a0b5d46bc925c885e7a827839bc498f6/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-10-01-preview/dataprotection.json"

️❌SemanticValidation: 1 Errors, 0 Warnings failed [Detail]

Rule	Message
`❌` ARRAY_UNIQUE	Array items are not unique (indexes 1 and 0) JsonUrl: Microsoft.DataProtection/preview/2022-10-01-preview/dataprotection.json#L5822:21

️️✔️PoliCheck succeeded [Detail] [Expand]

Validation passed for PoliCheck.

️️✔️SDK Track2 Validation succeeded [Detail] [Expand]

Validation passes for SDKTrack2Validation

The following tags are being changed in this PR

"https://github.com/Azure/azure-rest-api-specs/blob/342dfbb7a0b5d46bc925c885e7a827839bc498f6/specification/dataprotection/resource-manager/readme.md#tag-package-2022-10-preview">dataprotection/resource-manager/readme.md#package-2022-10-preview

️❌PrettierCheck: 1 Errors, 0 Warnings failed [Detail]

Rule	Message
`❌` HowToFix	Code style issues found path: Microsoft.DataProtection/preview/2022-10-01-preview/dataprotection.json

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

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

openapi-pipeline-app · 2022-09-07T06:57:20Z

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/dataprotection/armdataprotection - 2.0.0

+	Struct `CloudError` has been removed

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

❌Failed [Logs] Generate from c1803b8cae52064d284568f2ea814e4e9df611c6. 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 --use=@microsoft.azure/autorest.csharp@2.3.82 --csharp-sdks-folder=/mnt/vss/_work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/dataprotection/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
cmderr	[Autorest] No usable version of the libssl was found
cmderr	[Autorest] FATAL: csharp/simplifier - FAILED
cmderr	[Autorest] FATAL: Error: [Exception] AutoRest extension '@microsoft.azure/autorest.csharp' terminated.
cmderr	[Autorest] Process() cancelled due to exception : [Exception] AutoRest extension '@microsoft.azure/autorest.csharp' terminated.
error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-net]: autorest
warn	Skip package processing as generation is failed

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

⚠️Warning [Logs] Generate from c1803b8cae52064d284568f2ea814e4e9df611c6. 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! 8.15.0 -> 8.19.2
cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v8.19.2>
cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@8.19.2` to update!
cmderr	[automation_generate.sh] npm notice

️✔️track2_azure-mgmt-dataprotection [View full logs] [Preview SDK Changes]

info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog]   - Added operation BackupInstancesOperations.begin_resume_backups
info	[Changelog]   - Added operation BackupInstancesOperations.begin_resume_protection
info	[Changelog]   - Added operation BackupInstancesOperations.begin_stop_protection
info	[Changelog]   - Added operation BackupInstancesOperations.begin_suspend_backups
info	[Changelog]   - Added operation BackupInstancesOperations.begin_sync_backup_instance
info	[Changelog]   - Added operation BackupInstancesOperations.get_backup_instance_operation_result
info	[Changelog]   - Added operation group OperationStatusBackupVaultContextOperations
info	[Changelog]   - Added operation group OperationStatusResourceGroupContextOperations
info	[Changelog]   - Model AzureBackupRecoveryPointBasedRestoreRequest has a new parameter source_resource_id
info	[Changelog]   - Model AzureBackupRecoveryTimeBasedRestoreRequest has a new parameter source_resource_id
info	[Changelog]   - Model AzureBackupRestoreRequest has a new parameter source_resource_id
info	[Changelog]   - Model AzureBackupRestoreWithRehydrationRequest has a new parameter source_resource_id
info	[Changelog]   - Model BackupInstance has a new parameter validation_type
info	[Changelog]   - Model BackupInstanceResource has a new parameter tags
info	[Changelog]   - Model BackupVault has a new parameter is_vault_protected_by_resource_guard
info	[Changelog]   - Model BackupVault has a new parameter monitoring_settings
info	[Changelog]   - Model PatchResourceRequestInput has a new parameter properties
info	[Changelog]   - Model SecretStoreResource has a new parameter value

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

️✔️Succeeded [Logs] Generate from c1803b8cae52064d284568f2ea814e4e9df611c6. 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
command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json

️✔️azure-resourcemanager-dataprotection [View full logs] [Preview SDK Changes]

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

️✔️Succeeded [Logs] Generate from c1803b8cae52064d284568f2ea814e4e9df611c6. 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/dataprotection/armdataprotection [View full logs] [Preview SDK Changes] Breaking Change Detected

info	[Changelog] ### Breaking Changes
info	[Changelog]
info	[Changelog] - Struct `CloudError` has been removed
info	[Changelog]
info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog] - New const `StorageSettingTypesZoneRedundant`
info	[Changelog] - New struct `DppProxyResource`
info	[Changelog] - New field `Tags` in struct `BackupInstanceResource`
info	[Changelog] - New field `IsVaultProtectedByResourceGuard` in struct `BackupVault`
info	[Changelog]
info	[Changelog] Total 2 breaking change(s), 5 additive change(s).

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

️✔️Succeeded [Logs] Generate from c1803b8cae52064d284568f2ea814e4e9df611c6. 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-dataprotectionplatform [View full logs] [Preview SDK Changes]
- azure-arm-dataprotectionplatform-1.0.0.tgz
```
info	[Changelog]
error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.
```

️❌ azure-powershell failed [Detail]

❌Failed [Logs] Generate from c1803b8cae52064d284568f2ea814e4e9df611c6. 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.dataprotection [View full logs] [Preview SDK Changes]

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

openapi-pipeline-app · 2022-09-07T06:57:21Z

Generated ApiView

Language	Package Name	ApiView Link
Go	sdk/resourcemanager/dataprotection/armdataprotection	https://apiview.dev/Assemblies/Review/6a467fef19be4521a926b641db7a05d2
Java	azure-resourcemanager-dataprotection	Create ApiView failed. Please ask PR assignee for help
JavaScript	@azure/arm-dataprotectionplatform	https://apiview.dev/Assemblies/Review/b7fdad475f09407299590bee8ddafb23

openapi-workflow-bot · 2022-09-07T07:00:21Z

Hi @mayankagg9722, 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.

Task	How to fix	Priority
Avocado	Fix-Avocado	High
Semantic validation	Fix-SemanticValidation-Error	High
Model validation	Fix-ModelValidation-Error	High
LintDiff	Fix-LintDiff	high

If you need further help, please feedback via swagger feedback.

openapi-workflow-bot · 2022-09-07T07:00:38Z

Hi, @mayankagg9722 your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com).

mayankagg9722 · 2022-09-07T07:13:21Z

Please do not merge this PR for now as we are planning to add 1 more preview swagger with "2022-09 version"

ruowan · 2022-09-07T07:46:05Z

/azp run

azure-pipelines · 2022-09-07T07:46:15Z

Azure Pipelines successfully started running 1 pipeline(s).

mentat9 · 2022-09-08T02:07:01Z

  "discriminator": "objectType"

Recommend using a string enum rather than unconstrained string for discriminator. Also a less generic name would be better, e.g. backupType, datasourceType, backupDatasourceType, etc.

Refers to: specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-10-01-preview/dataprotection.json:4860 in 4bb5da8. [](commit_id = 4bb5da8, deletion_comment = False)

mentat9 · 2022-09-08T02:07:11Z

    "snapshotVolumes": {

ARM recommends string enums over boolean. Generally enums make better properties than booleans. They are more descriptive, flexible and future-proof while being easier for customers to discover, understand and use. Ref: https://armwiki.azurewebsites.net/rp_onboarding/process/api_review_best_practices.html?q=boolean#common-issues-found-in-review. They also allow adding values later without requiring a new API version (e.g. "Unknown", "Default", etc.), and allow values other than just true/false. Even if you only ever want two values, you can have a string enum with True/False (or Enabled/Disabled, etc.).

In this case you could have one enum: backupType: { "Basic", "BasicAndVolumes", "BasicAndScopeResources", "BasicVolumesAndScopeResources" }. Alternatively, you could keep two enums with two values each.

Refers to: specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-10-01-preview/dataprotection.json:4058 in 4bb5da8. [](commit_id = 4bb5da8, deletion_comment = False)

mentat9 · 2022-09-08T02:07:17Z

        "additionalProperties": {

Generally, this pattern should only be used when needed and the object properties are dynamic, unknown, or user defined. Ref: https://armwiki.azurewebsites.net/api_contracts/guidelines/openapi.html#oapi032-only-use-additionalproperties-when-the-object-properties-are-dynamic-unknown-or-user-defined.

ARM favors stronger typing wherever possible because it allows all consumers of your API to reason about it. This has benefits for everyone that interacts with your API including basic infrastructure, other Azure features, SDK owners, and customers. Unschematized objects are essentially API contracts that bypass Azure versioning infrastructure.

For example, customers will not be able to manage these objects using Azure Policy, or query them using ARG, both of which are standard Azure features. Customers expect to be able to use all common Azure features against all of their resources.

Refers to: specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-10-01-preview/dataprotection.json:5835 in 4bb5da8. [](commit_id = 4bb5da8, deletion_comment = False)

openapi-workflow-bot · 2022-09-08T02:07:53Z

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

mayankagg9722 · 2022-09-08T05:30:56Z

4860
  "discriminator": "objectType"
Recommend using a string enum rather than unconstrained string for discriminator. Also a less generic name would be better, e.g. backupType, datasourceType, backupDatasourceType, etc.

Refers to: specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-10-01-preview/dataprotection.json:4860 in 4bb5da8. [](commit_id = 4bb5da8, deletion_comment = False)

Hi @mentat9, this is the base object and will be is very similar to other base objects. eg. "DataStoreParameters" #4818

mayankagg9722 · 2022-09-08T05:46:14Z

        "additionalProperties": {
Generally, this pattern should only be used when needed and the object properties are dynamic, unknown, or user defined. Ref: https://armwiki.azurewebsites.net/api_contracts/guidelines/openapi.html#oapi032-only-use-additionalproperties-when-the-object-properties-are-dynamic-unknown-or-user-defined.

ARM favors stronger typing wherever possible because it allows all consumers of your API to reason about it. This has benefits for everyone that interacts with your API including basic infrastructure, other Azure features, SDK owners, and customers. Unschematized objects are essentially API contracts that bypass Azure versioning infrastructure.

For example, customers will not be able to manage these objects using Azure Policy, or query them using ARG, both of which are standard Azure features. Customers expect to be able to use all common Azure features against all of their resources.

Refers to: specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-10-01-preview/dataprotection.json:5835 in 4bb5da8. [](commit_id = 4bb5da8, deletion_comment = False)

Hi @mentat9, This property will be all three i.e. dynamic, unknown, and user defined. This is of format Dictionary<string,string> which user only will use to define the mappings.

mayankagg9722 · 2022-09-08T09:29:24Z

    "snapshotVolumes": {
ARM recommends string enums over boolean. Generally enums make better properties than booleans. They are more descriptive, flexible and future-proof while being easier for customers to discover, understand and use. Ref: https://armwiki.azurewebsites.net/rp_onboarding/process/api_review_best_practices.html?q=boolean#common-issues-found-in-review. They also allow adding values later without requiring a new API version (e.g. "Unknown", "Default", etc.), and allow values other than just true/false. Even if you only ever want two values, you can have a string enum with True/False (or Enabled/Disabled, etc.).

In this case you could have one enum: backupType: { "Basic", "BasicAndVolumes", "BasicAndScopeResources", "BasicVolumesAndScopeResources" }. Alternatively, you could keep two enums with two values each.

Refers to: specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-10-01-preview/dataprotection.json:4058 in 4bb5da8. [](commit_id = 4bb5da8, deletion_comment = False)

Hi @mentat9, currently we need to only use this property as a booleen as there are not other types that needs to come up under this. This is very similar to other property in the payload we have added "includeClusterResources".

mayankagg9722 added 3 commits September 7, 2022 12:15

base commit: 2022-05-01

01ea08d

adding new api version 2022-10-01-preview on top of stable base versi…

3cef8d4

…on 2022-05-01

readme changes

d6e85e2

mayankagg9722 requested a review from ArcturusZhang as a code owner September 7, 2022 06:57

openapi-assignment-bot bot assigned xiaoxuqi-ms Sep 7, 2022

openapi-pipeline-app bot added resource-manager CI-FixRequiredOnFailure labels Sep 7, 2022

openapi-workflow-bot bot added ARMReview WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Sep 7, 2022

changes

4bb5da8

mentat9 added the ARMChangesRequested label Sep 8, 2022

openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Sep 8, 2022

mayankagg9722 added the DoNotMerge <valid label in PR review process> use to hold merge after approval label Sep 14, 2022

Update dataprotection.json

342dfbb

openapi-pipeline-app bot added the CI-BreakingChange-Go label Sep 15, 2022

mayankagg9722 marked this pull request as draft September 15, 2022 07:45

mayankagg9722 marked this pull request as ready for review September 15, 2022 07:49

mayankagg9722 marked this pull request as draft September 15, 2022 15:00

mayankagg9722 closed this by deleting the head repository Oct 3, 2022

Conversation

mayankagg9722 commented Sep 7, 2022 • 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 Sep 7, 2022

Uh oh!

openapi-pipeline-app bot commented Sep 7, 2022 • 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 Sep 7, 2022 • 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 Sep 7, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Generated ApiView

Uh oh!

openapi-workflow-bot bot commented Sep 7, 2022

Uh oh!

openapi-workflow-bot bot commented Sep 7, 2022

Uh oh!

mayankagg9722 commented Sep 7, 2022

Uh oh!

ruowan commented Sep 7, 2022

Uh oh!

azure-pipelines bot commented Sep 7, 2022

Uh oh!

mentat9 commented Sep 8, 2022

Uh oh!

mentat9 commented Sep 8, 2022

Uh oh!

mentat9 commented Sep 8, 2022

Uh oh!

openapi-workflow-bot bot commented Sep 8, 2022

Uh oh!

mayankagg9722 commented Sep 8, 2022

Uh oh!

mayankagg9722 commented Sep 8, 2022

Uh oh!

mayankagg9722 commented Sep 8, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

mayankagg9722 commented Sep 7, 2022 •

edited

Loading

openapi-pipeline-app bot commented Sep 7, 2022 •

edited

Loading

openapi-pipeline-app bot commented Sep 7, 2022 •

edited

Loading

openapi-pipeline-app bot commented Sep 7, 2022 •

edited

Loading