-
Notifications
You must be signed in to change notification settings - Fork 5.6k
API 2023-04-01: A new property "storage-subscription-id" added in redisConfiguration #23726
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
Conversation
… to version 2023-04-01
|
Hi, @ajtiwari07 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. vscswagger@microsoft.com |
|
Hi, @ajtiwari07 your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| redis.json | 2023-04-01(3255cf3) | 2022-06-01(main) |
| redis.json | 2023-04-01(3255cf3) | 2019-07-01(main) |
The following breaking changes are detected by comparison with the latest preview version:
| Rule | Message |
|---|---|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/listUpgradeNotifications' removed or restructured? Old: Microsoft.Cache/preview/2019-07-01/redis.json#L103:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}' removed or restructured? Old: Microsoft.Cache/preview/2019-07-01/redis.json#L155:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis' removed or restructured? Old: Microsoft.Cache/preview/2019-07-01/redis.json#L354:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/providers/Microsoft.Cache/Redis' removed or restructured? Old: Microsoft.Cache/preview/2019-07-01/redis.json#L394:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/listKeys' removed or restructured? Old: Microsoft.Cache/preview/2019-07-01/redis.json#L427:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/regenerateKey' removed or restructured? Old: Microsoft.Cache/preview/2019-07-01/redis.json#L471:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/forceReboot' removed or restructured? Old: Microsoft.Cache/preview/2019-07-01/redis.json#L524:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/import' removed or restructured? Old: Microsoft.Cache/preview/2019-07-01/redis.json#L577:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/export' removed or restructured? Old: Microsoft.Cache/preview/2019-07-01/redis.json#L634:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{cacheName}/firewallRules' removed or restructured? Old: Microsoft.Cache/preview/2019-07-01/redis.json#L691:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{cacheName}/firewallRules/{ruleName}' removed or restructured? Old: Microsoft.Cache/preview/2019-07-01/redis.json#L739:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{cacheName}/patchSchedules' removed or restructured? Old: Microsoft.Cache/preview/2019-07-01/redis.json#L906:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/patchSchedules/{default}' removed or restructured? Old: Microsoft.Cache/preview/2019-07-01/redis.json#L954:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/linkedServers/{linkedServerName}' removed or restructured? Old: Microsoft.Cache/preview/2019-07-01/redis.json#L1142:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/linkedServers' removed or restructured? Old: Microsoft.Cache/preview/2019-07-01/redis.json#L1304:5 |
|
| The new version adds a response code 'default'. New: Microsoft.Cache/stable/2023-04-01/redis.json#L61:11 |
|
| The new version adds a response code 'default'. New: Microsoft.Cache/stable/2023-04-01/redis.json#L106:11 |
|
| The new version has a different type '' than the previous one 'string'. New: Microsoft.Cache/stable/2023-04-01/redis.json#L1973:11 Old: Microsoft.Cache/preview/2019-07-01/redis.json#L1397:11 |
|
| The new version has a different type '' than the previous one 'string'. New: Microsoft.Cache/stable/2023-04-01/redis.json#L1973:11 Old: Microsoft.Cache/preview/2019-07-01/redis.json#L1397:11 |
|
| The new version has a different type '' than the previous one 'string'. New: Microsoft.Cache/stable/2023-04-01/redis.json#L1973:11 Old: Microsoft.Cache/preview/2019-07-01/redis.json#L1397:11 |
|
| The new version has a different type '' than the previous one 'string'. New: Microsoft.Cache/stable/2023-04-01/redis.json#L1973:11 Old: Microsoft.Cache/preview/2019-07-01/redis.json#L1397:11 |
|
| The new version has a different default value than the previous one. New: Microsoft.Cache/stable/2023-04-01/redis.json#L1980:9 Old: Microsoft.Cache/preview/2019-07-01/redis.json#L1402:9 |
|
| The new version has a different default value than the previous one. New: Microsoft.Cache/stable/2023-04-01/redis.json#L1980:9 Old: Microsoft.Cache/preview/2019-07-01/redis.json#L1402:9 |
|
| The new version has a different default value than the previous one. New: Microsoft.Cache/stable/2023-04-01/redis.json#L1980:9 Old: Microsoft.Cache/preview/2019-07-01/redis.json#L1402:9 |
|
| The new version has a different default value than the previous one. New: Microsoft.Cache/stable/2023-04-01/redis.json#L1980:9 Old: Microsoft.Cache/preview/2019-07-01/redis.json#L1402:9 |
|
| The read only property has changed from 'true' to 'false'. New: Microsoft.Cache/stable/2023-04-01/redis.json#L1976:9 Old: Microsoft.Cache/preview/2019-07-01/redis.json#L1485:9 |
|
| The new version has a different 'allOf' property than the previous one. New: Microsoft.Cache/stable/2023-04-01/redis.json#L2261:5 Old: Microsoft.Cache/preview/2019-07-01/redis.json#L1708:5 |
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 0 Warnings warning [Detail]
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-2023-04 | package-2023-04(3255cf3) | default(main) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
OperationsApiResponseSchema |
The response schema of operations API '/providers/Microsoft.Cache/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.Cache/stable/2023-04-01/redis.json#L57 |
PathResourceTypeNameCamelCase |
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/providers/Microsoft.Cache/CheckNameAvailability' Location: Microsoft.Cache/stable/2023-04-01/redis.json#L73 |
CreateOperationAsyncResponseValidation |
An async PUT operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.Cache/stable/2023-04-01/redis.json#L177 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.Cache/stable/2023-04-01/redis.json#L297 |
DeleteOperationAsyncResponseValidation |
An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.Cache/stable/2023-04-01/redis.json#L311 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.Cache/stable/2023-04-01/redis.json#L349 |
PostOperationAsyncResponseValidation |
An async POST operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.Cache/stable/2023-04-01/redis.json#L666 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.Cache/stable/2023-04-01/redis.json#L710 |
PostOperationAsyncResponseValidation |
An async POST operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.Cache/stable/2023-04-01/redis.json#L729 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.Cache/stable/2023-04-01/redis.json#L773 |
ResourceNameRestriction |
The resource name parameter 'cacheName' should be defined with a 'pattern' restriction. Location: Microsoft.Cache/stable/2023-04-01/redis.json#L791 |
ResourceNameRestriction |
The resource name parameter 'cacheName' should be defined with a 'pattern' restriction. Location: Microsoft.Cache/stable/2023-04-01/redis.json#L845 |
ResourceNameRestriction |
The resource name parameter 'ruleName' should be defined with a 'pattern' restriction. Location: Microsoft.Cache/stable/2023-04-01/redis.json#L845 |
ResourceNameRestriction |
The resource name parameter 'cacheName' should be defined with a 'pattern' restriction. Location: Microsoft.Cache/stable/2023-04-01/redis.json#L1030 |
TrackedResourcePatchOperation |
Tracked resource 'RedisPatchSchedule' must have patch operation that at least supports the update of tags. Location: Microsoft.Cache/stable/2023-04-01/redis.json#L1084 |
ResourceNameRestriction |
The resource name parameter 'linkedServerName' should be defined with a 'pattern' restriction. Location: Microsoft.Cache/stable/2023-04-01/redis.json#L1290 |
CreateOperationAsyncResponseValidation |
An async PUT operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.Cache/stable/2023-04-01/redis.json#L1291 |
DeleteOperationAsyncResponseValidation |
An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.Cache/stable/2023-04-01/redis.json#L1362 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.Cache/stable/2023-04-01/redis.json#L1407 |
GetCollectionResponseSchema |
The response in the GET collection operation 'PrivateEndpointConnections_List' does not match the response definition in the individual GET operation 'PrivateEndpointConnections_Get' . Location: Microsoft.Cache/stable/2023-04-01/redis.json#L1527 |
ResourceNameRestriction |
The resource name parameter 'cacheName' should be defined with a 'pattern' restriction. Location: Microsoft.Cache/stable/2023-04-01/redis.json#L1527 |
ResourceNameRestriction |
The resource name parameter 'cacheName' should be defined with a 'pattern' restriction. Location: Microsoft.Cache/stable/2023-04-01/redis.json#L1580 |
ResourceNameRestriction |
The resource name parameter 'privateEndpointConnectionName' should be defined with a 'pattern' restriction. Location: Microsoft.Cache/stable/2023-04-01/redis.json#L1580 |
CreateOperationAsyncResponseValidation |
An async PUT operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.Cache/stable/2023-04-01/redis.json#L1632 |
ResourceNameRestriction |
The resource name parameter 'cacheName' should be defined with a 'pattern' restriction. Location: Microsoft.Cache/stable/2023-04-01/redis.json#L1751 |
MissingTypeObject |
The schema 'Sku' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2023-04-01/redis.json#L1856 |
MissingTypeObject |
The schema 'RedisCommonProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2023-04-01/redis.json#L1896 |
MissingTypeObject |
The schema 'RedisCreateProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2023-04-01/redis.json#L2037 |
MissingTypeObject |
The schema 'RedisUpdateProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2023-04-01/redis.json#L2069 |
MissingTypeObject |
The schema 'RedisProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2023-04-01/redis.json#L2084 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️❌~[Staging] ServiceAPIReadinessTest: 28 Errors, 0 Warnings failed [Detail]
Tag package-2023-04; Prod region: Deployed
Test run on region: westcentralus; Operation coverage: total: 32, untested: 0, failed: 28, passed: 4
Service API Readiness Test failed. Check pipeline artifact for detail report.
| Rule | Message |
|---|---|
CLIENT_ERROR |
statusCode: 403, errorCode: LinkedAuthorizationFailed, errorMessage: The client '7904a8be-825f-480e-a728-80a70579dba4' with object id '7904a8be-825f-480e-a728-80a70579dba4' has permission to perform action 'Microsoft.Cache/redis/write' on scope '/subscriptions/db5eb68e-73e2-4fa8-b18a-46cd1be4cce5/resourceGroups/apiTest-miZshj-23726/providers/Microsoft.Cache/redis/name88wksm'; however, it does not have permission to perform action 'join/action' on the linked scope(s) '/subscriptions/db5eb68e-73e2-4fa8-b18a-46cd1be4cce5/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/network1/subnets/subnet1' or the linked scope(s) are invalid. Source: runtime OperationId: Redis_Create |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.Cache/Redis/name88wksm' under resource group 'apiTest-miZshj-23726' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: Redis_Get |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.Cache/Redis/name88wksm' under resource group 'apiTest-miZshj-23726' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: Redis_ListUpgradeNotifications |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.Cache/Redis/name88wksm' under resource group 'apiTest-miZshj-23726' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: Redis_Update |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.Cache/Redis/name88wksm' under resource group 'apiTest-miZshj-23726' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: Redis_RegenerateKey |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.Cache/Redis/name88wksm' under resource group 'apiTest-miZshj-23726' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: Redis_ListKeys |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.Cache/Redis/name88wksm' under resource group 'apiTest-miZshj-23726' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: Redis_ForceReboot |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.Cache/Redis/name88wksm' under resource group 'apiTest-miZshj-23726' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: Redis_ImportData |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.Cache/Redis/name88wksm' under resource group 'apiTest-miZshj-23726' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: Redis_ExportData |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.Cache/Redis/name88wksm' under resource group 'apiTest-miZshj-23726' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: LinkedServer_Create |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.Cache/Redis/name88wksm' under resource group 'apiTest-miZshj-23726' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: LinkedServer_List |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.Cache/Redis/name88wksm' under resource group 'apiTest-miZshj-23726' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: LinkedServer_Get |
CLIENT_ERROR |
statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'cachenamf7b0ta' not found. Source: runtime OperationId: PrivateEndpointConnections_Put |
CLIENT_ERROR |
statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'cachenamf7b0ta' not found. Source: runtime OperationId: PrivateEndpointConnections_List |
CLIENT_ERROR |
statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'cachenamf7b0ta' not found. Source: runtime OperationId: PrivateEndpointConnections_Get |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.Cache/Redis/cachenamf7b0ta' under resource group 'apiTest-miZshj-23726' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: FirewallRules_CreateOrUpdate |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.Cache/Redis/cachenamf7b0ta' under resource group 'apiTest-miZshj-23726' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: FirewallRules_List |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.Cache/Redis/cachenamf7b0ta' under resource group 'apiTest-miZshj-23726' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: FirewallRules_Get |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.Cache/Redis/name88wksm' under resource group 'apiTest-miZshj-23726' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: PatchSchedules_CreateOrUpdate |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.Cache/Redis/cachenamf7b0ta' under resource group 'apiTest-miZshj-23726' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: PatchSchedules_ListByRedisResource |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.Cache/Redis/name88wksm' under resource group 'apiTest-miZshj-23726' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: PatchSchedules_Get |
OBJECT_ADDITIONAL_PROPERTIES |
Additional properties not allowed: properties Source: response OperationId: Operations_List |
CLIENT_ERROR |
statusCode: 404, errorCode: NotFound, errorMessage: A requested resource could not be found. It may already have been deleted. RequestID=b083e1a1-c789-46d7-ba65-55552679e2db Source: runtime OperationId: AsyncOperationStatus_Get |
CLIENT_ERROR |
statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'cachenamf7b0ta' not found. Source: runtime OperationId: PrivateLinkResources_ListByRedisCache |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.Cache/Redis/name88wksm' under resource group 'apiTest-miZshj-23726' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: PatchSchedules_Delete |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.Cache/Redis/cachenamf7b0ta' under resource group 'apiTest-miZshj-23726' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: FirewallRules_Delete |
CLIENT_ERROR |
statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'cachenamf7b0ta' not found. Source: runtime OperationId: PrivateEndpointConnections_Delete |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.Cache/Redis/name88wksm' under resource group 'apiTest-miZshj-23726' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: LinkedServer_Delete |
️️✔️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.
Swagger Generation Artifacts
|
Generated ApiView
|
|
Hi, @ajtiwari07, For review efficiency consideration, when creating a new api version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki. Or you could onboard API spec pipeline |
| }, | ||
| "storage-subscription-id": { | ||
| "type": "string", | ||
| "description": "SubscriptionId of the storage account for persistence (aof/rdb) using ManagedIdentity. Default value is subscriptionId of the cache." |
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.
I have a doubt about whether it makes sense to say that the default value is the subscription id of the cache. Because that would imply that on a GET request, the subscription id of the cache will come back, if the storage subscription id wasn't already specified by a PUT with this new api version...
AND that wouldn't seem intuitive for that subscription id to be claimed to be the cache's subscription if the storage account is NOT really in the cache's subscription.
(In other words, if someone provided a storage account earlier, and no subscription id (or configured it with an old api version), can you know that it is really in the subscription id of the cache, and that that is a sensible default, for you to return, when someone does a later request with this api-version?)
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.
Good point, i can definitely see the implication of mentioning default value.
I was thinking about rephrasing with a mention of "when subscription id is different from cache subscription id" but that wouldn't complete since it excludes scenario of passing cache subscriptionId in this parameter.
I have removed the mention of default value.
|
Why do you need the subscription ID of the storage account (and not the full resource ID)? |
|
Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove |
We use the subscription Id to request Storage RP to provide further details about the storage account in the said subscription. We could have used resourceID but then we would have to extract subscription Id from it to fulfill the request. |
What request are you making exactly? |
We were already making request to this Storage Account List API https://learn.microsoft.com/en-us/rest/api/storagerp/storage-accounts/list?tabs=HTTP#storageaccount. |
There can be 5000 storage accounts per region in a subscription. Listing all of them to find the one you care about is extremely inefficient. If this is cross-subscription there is no guarantee your RP is going to be registered in the other subscription to allow you to make this call with your first party identity as well. There is also a 100 LIST calls per 5 minute throttling limit in storage RP according to their public docs. If there are a bunch of paginated results you could consume a lot of that. The API change itself is fine but please consider the other feedback. I'd prefer to see the storage account resource ID but if you are already consuming the storage account without it it would be awkward to add the resource ID in a back-compat way. |
Yes, we are aware that using this particular API call is inefficient. The cross-subscription implementation doesn't make any additional calls but from performance standpoint we do have a task in hand to make use of resource graph to retrieve storage account details instead. Unfortunately, we are already consuming subscription ID of the storage account. |
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
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:
The new api version is deployed to all public regions.
As soon as the new api version is updated in swagger.
Contribution checklist (MS Employees Only):
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 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.
-[x] 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.