-
Notifications
You must be signed in to change notification settings - Fork 5.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Adding new Tracked Resource Type for Microsoft.Migrate RP with new Ap… #19045
Adding new Tracked Resource Type for Microsoft.Migrate RP with new Ap… #19045
Conversation
Hi, @sumukha100 Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected] |
Hi, @sumukha100 your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]). |
Swagger Validation Report
|
compared swaggers (via Oad v0.10.4)] | new version | base version |
---|---|---|
hubmigrate.json | 2020-05-01(cb56d1c) | 2020-05-01(main) |
migrate.json | 2020-07-07(cb56d1c) | 2020-07-07(main) |
️️✔️
Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️❌
LintDiff: 217 Errors, 236 Warnings failed [Detail]
compared tags (via openapi-validator v2.0.0) | new version | base version |
---|---|---|
package-migrate-2018-02 | package-migrate-2018-02(cb56d1c) | default(main) |
package-migrate-2019-10 | package-migrate-2019-10(cb56d1c) | default(main) |
package-migrate-2020-01 | package-migrate-2020-01(cb56d1c) | default(main) |
package-hubmigrate-2020-05 | package-hubmigrate-2020-05(cb56d1c) | default(main) |
package-migrate-2020-07 | package-migrate-2020-07(cb56d1c) | default(main) |
package-migrateengine-2022-05 | package-migrateengine-2022-05(cb56d1c) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
Only 30 items are listed, please refer to log for more details.
Rule | Message | Related RPC [For API reviewers] |
---|---|---|
XmsParameterLocation |
The parameter 'subscriptionId' 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.Migrate/stable/2020-05-01/hubmigrate.json#L18 |
|
ResourceNameRestriction |
The resource name parameter 'migrateProjectName' should be defined with a 'pattern' restriction. Location: Microsoft.Migrate/stable/2020-05-01/hubmigrate.json#L61 |
RPC-Uri-V1-05 |
UnSupportedPatchProperties |
The patch operation body parameter schema should not contains property name. Location: Microsoft.Migrate/stable/2020-05-01/hubmigrate.json#L226 |
RPC-Patch-V1-02 |
UnSupportedPatchProperties |
The patch operation body parameter schema should not contains property type. Location: Microsoft.Migrate/stable/2020-05-01/hubmigrate.json#L226 |
RPC-Patch-V1-02 |
UnSupportedPatchProperties |
The patch operation body parameter schema should not contains property location. Location: Microsoft.Migrate/stable/2020-05-01/hubmigrate.json#L226 |
RPC-Patch-V1-02 |
ResourceNameRestriction |
The resource name parameter 'migrateProjectName' should be defined with a 'pattern' restriction. Location: Microsoft.Migrate/stable/2020-05-01/hubmigrate.json#L265 |
RPC-Uri-V1-05 |
ResourceNameRestriction |
The resource name parameter 'migrateProjectName' should be defined with a 'pattern' restriction. Location: Microsoft.Migrate/stable/2020-05-01/hubmigrate.json#L320 |
RPC-Uri-V1-05 |
ResourceNameRestriction |
The resource name parameter 'peConnectionName' should be defined with a 'pattern' restriction. Location: Microsoft.Migrate/stable/2020-05-01/hubmigrate.json#L320 |
RPC-Uri-V1-05 |
ResourceNameRestriction |
The resource name parameter 'migrateProjectName' should be defined with a 'pattern' restriction. Location: Microsoft.Migrate/stable/2020-05-01/hubmigrate.json#L490 |
RPC-Uri-V1-05 |
ResourceNameRestriction |
The resource name parameter 'privateLinkResourceName' should be defined with a 'pattern' restriction. Location: Microsoft.Migrate/stable/2020-05-01/hubmigrate.json#L490 |
RPC-Uri-V1-05 |
ResourceNameRestriction |
The resource name parameter 'migrateProjectName' should be defined with a 'pattern' restriction. Location: Microsoft.Migrate/stable/2020-05-01/hubmigrate.json#L545 |
RPC-Uri-V1-05 |
SubscriptionsAndResourceGroupCasing |
The path segment resourcegroups should be resourceGroups. Location: Microsoft.Migrate/stable/2020-05-01/hubmigrate.json#L640 |
|
ApiVersionParameterRequired |
Operation should include an 'api-version' parameter. Location: Microsoft.Migrate/stable/2020-05-01/hubmigrate.json#L691 |
RPC-Uri-V1-08 |
XmsIdentifierValidation |
Missing identifier id in array item property Location: Microsoft.Migrate/stable/2020-05-01/hubmigrate.json#L751 |
|
XmsEnumValidation |
The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.Migrate/stable/2020-05-01/hubmigrate.json#L876 |
|
ProvisioningStateValidation |
ProvisioningState must have terminal states: Succeeded, Failed and Canceled. Location: Microsoft.Migrate/stable/2020-05-01/hubmigrate.json#L935 |
RPC-Async-V1-03 |
XmsEnumValidation |
The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.Migrate/stable/2020-05-01/hubmigrate.json#L935 |
|
XmsEnumValidation |
The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.Migrate/stable/2020-05-01/hubmigrate.json#L1066 |
|
XmsIdentifierValidation |
Missing identifier id in array item property Location: Microsoft.Migrate/stable/2020-05-01/hubmigrate.json#L1116 |
|
PathResourceTypeNameCamelCase |
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/HyperVSites/{siteName}/clusters/{clusterName}' Location: Microsoft.OffAzure/stable/2020-07-07/migrate.json#L44 |
|
PutGetPatchResponseSchema |
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/HyperVSites/{siteName}/clusters/{clusterName} has different responses for PUT/GET/PATCH operations. The PUT/GET/PATCH operations must have same schema response. Location: Microsoft.OffAzure/stable/2020-07-07/migrate.json#L44 |
RPC-Put-V1-12 |
ResourceNameRestriction |
The resource name parameter 'siteName' should be defined with a 'pattern' restriction. Location: Microsoft.OffAzure/stable/2020-07-07/migrate.json#L44 |
RPC-Uri-V1-05 |
ResourceNameRestriction |
The resource name parameter 'clusterName' should be defined with a 'pattern' restriction. Location: Microsoft.OffAzure/stable/2020-07-07/migrate.json#L44 |
RPC-Uri-V1-05 |
CreateOperationAsyncResponseValidation |
Only 201 is the supported response code for PUT async response. Location: Microsoft.OffAzure/stable/2020-07-07/migrate.json#L164 |
RPC-Async-V1-01 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.OffAzure/stable/2020-07-07/migrate.json#L166 |
RPC-Async-V1-07 |
PathResourceTypeNameCamelCase |
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/HyperVSites/{siteName}/clusters' Location: Microsoft.OffAzure/stable/2020-07-07/migrate.json#L188 |
|
ResourceNameRestriction |
The resource name parameter 'siteName' should be defined with a 'pattern' restriction. Location: Microsoft.OffAzure/stable/2020-07-07/migrate.json#L188 |
RPC-Uri-V1-05 |
PathResourceTypeNameCamelCase |
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/HyperVSites/{siteName}/hosts/{hostName}' Location: Microsoft.OffAzure/stable/2020-07-07/migrate.json#L256 |
|
PutGetPatchResponseSchema |
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/HyperVSites/{siteName}/hosts/{hostName} has different responses for PUT/GET/PATCH operations. The PUT/GET/PATCH operations must have same schema response. Location: Microsoft.OffAzure/stable/2020-07-07/migrate.json#L256 |
RPC-Put-V1-12 |
ResourceNameRestriction |
The resource name parameter 'siteName' should be defined with a 'pattern' restriction. Location: Microsoft.OffAzure/stable/2020-07-07/migrate.json#L256 |
RPC-Uri-V1-05 |
The following errors/warnings exist before current PR submission:
Rule | Message |
---|---|
XmsParameterLocation |
The parameter 'subscriptionId' 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.OffAzure/stable/2020-07-07/migrate.json#L17 |
ProvisioningStateValidation |
ProvisioningState must have terminal states: Succeeded, Failed and Canceled. Location: Microsoft.OffAzure/stable/2020-07-07/migrate.json#L5845 |
XmsEnumValidation |
The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.OffAzure/stable/2020-07-07/migrate.json#L5845 |
XmsEnumValidation |
The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.OffAzure/stable/2020-07-07/migrate.json#L5876 |
MissingTypeObject |
The schema 'CloudError' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.OffAzure/stable/2020-07-07/migrate.json#L6424 |
MissingTypeObject |
The schema 'CloudErrorBody' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.OffAzure/stable/2020-07-07/migrate.json#L6433 |
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.OffAzure/stable/2020-07-07/migrate.json#L5831 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.OffAzure/stable/2020-07-07/migrate.json#L5931 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
ApiReadinessCheck succeeded [Detail] [Expand]
️️✔️
~[Staging] ServiceAPIReadinessTest succeeded [Detail] [Expand]
Validation passes for ServiceAPIReadinessTest.
️️✔️
SwaggerAPIView succeeded [Detail] [Expand]
️️✔️
CadlAPIView 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.
️️✔️
PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Hi @sumukha100, Your PR has some issues. Please fix the CI sequentially by following the order of
|
@sumukha100 Can you fix those CI failures ? Thanks |
Also, there's a WaitForARMFeedback label, let's wait for their feedback. |
Adding an overview of the resource model: MigrateAgents: An agent resource, which is installed on the customer premises to perform the migration journey actions. The agent bootstrapping is done by the customer as part of onboarding process in Azure Migrate, which requires setting up an appliance in customer environment. WorkloadInstances: Resource representing a particular workload instance customer wants to migrate. As part of PUT action, we initiate the replication process of the workload instance. The replication process is triggered as a job on a selected migrate agent configured by the customer. WorkloadDeployments: Post replicating a workload instance, a customer can select a target platform to deploy the instance and create a workload deployment resource. Supported post actions: DeployedResources: A read only resource capturing details of azure resources created in migrating a workload deployment. Jobs: A read only resource capturing details of long running operation triggered within the MigrateDataCenter resource. |
Is this valid? What is the difference between calling PUT on this resource with updated values and calling PATCH with updated values? Generally, PATCH is used to update a small subset of properties (common values to update: tags) In reply to: 1129458473 Refers to: specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/migrateEngine.json:684 in 8fe9e43. [](commit_id = 8fe9e43, deletion_comment = False) |
Make sure to adhere to our RPC: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/async-api-reference.md#creatingupdating-using-put For example the recommended response code on an initial PUT is 201 you are returning 201 & 202 Refers to: specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/migrateEngine.json:586 in 8fe9e43. [](commit_id = 8fe9e43, deletion_comment = False) |
|
@@ -2775,45 +2755,6 @@ | |||
} | |||
} | |||
}, | |||
"AuthenticationProperties": { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Reviewed, should be removed.
@@ -4383,15 +4296,6 @@ | |||
} | |||
} | |||
}, | |||
"SecureString": { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Reviewed, can be removed.
azure-sdk-for-net-track2 failure is caused by a known pipeline issue, please ignore it. |
/azp run |
Azure Pipelines successfully started running 1 pipeline(s). |
…grate RP with new Ap… (#2785) Create to sync Azure/azure-rest-api-specs#19045 [ReCreate this PR](https://github.com/azure-resource-manager-schemas/compare/main...azure-sdk:sdkAuto/migrate?expand=1)
Azure#19045) * Adding new Tracked Resource Type for Microsoft.Migrate RP with new Api Version * Adding tag in readme and IISAKS to custom words * Restructuring example files * Renaming files * Fixing Avocado error * Rectifying swagger model validation * Addressing code style and validation issues * Implementing review comment * fixing prettier check * Deleting patch operations for proxy resources * Modifying readme.md to accomodate new resourcetype * Resolving errors * Resolving errors * Chankging tracked resource name from migrateDataCenter to modernizeProject * Reverting addition of id fiels in migrate and hubmigrate.json * . * Delete non-existing x-ms-examples from swagger * Auto-generate examples * run prettier changes * . * prettier * fix: Deleting and modifying examples * fix: Generated new examples to remove some errors * fix: Added x-ms-long-running-operation-options * refactor: Ran prettier fix * fix: Spell check error * fix: Removed 2 unnecessary filenames from inputfiles section under 'package-2022-05' tag. * feat: Latest Swagger updated. New examples generated. * fix: Resolving LintDiff Errors * fix: Ran prettier fix * fix: fixing model validation errors * fix: model validation error fix * fix: Removed patch operation and updated camelCase * fix: updated 'name' and restore readme.md * fix: removed tag: package-2022-05 and reverted the default tag to 2019-10 * fix: OperationsAPIImplementation * fix: OperationsAPI Implementaiton shifted to migrateEngine file * fix: ran prettier fix on 2 new example files * fix: updated package-2019 with package-migrate-2019 * refactor: Changed random guid to reopen the PR * fix: Updated the swagger till date 19Jan * fix: added 'fareast' in custom-words * fix: Recreated examples * fix: ran prettier command * fix: camelCase at 3 places * fix: Re generated examples * fix: Removed the Loglink from ContainerImageProperties * fix: Regenerated examples * Added GMSA Configuration State * fix: Added two DeployedResourcesProperties: isCleanUpDone, isTestMigration * fix: Removed spellcheck * fix: Added Produces in operations * fix: schema error * fix: Removed unnecessary configurations --------- Co-authored-by: Shishir Gupta <[email protected]> Co-authored-by: Shreyas Mali <[email protected]> Co-authored-by: shishir-msft <[email protected]> Co-authored-by: shreyasmalims <[email protected]>
…i Version
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Changelog
Add a changelog entry for this PR by answering the following questions:
June 2022
June 2022
Contribution checklist:
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Otherwise your PR may be subject to ARM review requirements. Complete the following:
Check this box if any of the following appy 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.
-[ ] To review changes efficiently, ensure you are using OpenAPIHub to initialize the PR for adding a new version. 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 any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
Please follow the link to find more details on PR review process.