Skip to content

Conversation

@ajtiwari07
Copy link
Contributor

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:

  1. 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
  2. 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.
    The new api version is deployed to all public regions.
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
    As soon as the new api version is updated in swagger.
  4. 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):

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

@openapi-workflow-bot
Copy link

Hi, @ajtiwari07 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-workflow-bot openapi-workflow-bot bot added ARMReview WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Apr 25, 2023
    @openapi-workflow-bot
    Copy link

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

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Apr 25, 2023

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️⚠️Breaking Change(Cross-Version): 27 Warnings warning [Detail]
    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
    ⚠️ 1005 - RemovedPath 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
    ⚠️ 1005 - RemovedPath 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
    ⚠️ 1005 - RemovedPath 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
    ⚠️ 1005 - RemovedPath 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
    ⚠️ 1005 - RemovedPath 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
    ⚠️ 1005 - RemovedPath 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
    ⚠️ 1005 - RemovedPath 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
    ⚠️ 1005 - RemovedPath 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
    ⚠️ 1005 - RemovedPath 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
    ⚠️ 1005 - RemovedPath 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
    ⚠️ 1005 - RemovedPath 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
    ⚠️ 1005 - RemovedPath 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
    ⚠️ 1005 - RemovedPath 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
    ⚠️ 1005 - RemovedPath 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
    ⚠️ 1005 - RemovedPath 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
    ⚠️ 1011 - AddingResponseCode The new version adds a response code 'default'.
    New: Microsoft.Cache/stable/2023-04-01/redis.json#L61:11
    ⚠️ 1011 - AddingResponseCode The new version adds a response code 'default'.
    New: Microsoft.Cache/stable/2023-04-01/redis.json#L106:11
    ⚠️ 1026 - TypeChanged 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
    ⚠️ 1026 - TypeChanged 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
    ⚠️ 1026 - TypeChanged 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
    ⚠️ 1026 - TypeChanged 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
    ⚠️ 1027 - DefaultValueChanged 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
    ⚠️ 1027 - DefaultValueChanged 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
    ⚠️ 1027 - DefaultValueChanged 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
    ⚠️ 1027 - DefaultValueChanged 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
    ⚠️ 1029 - ReadonlyPropertyChanged 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
    ⚠️ 1032 - DifferentAllOf 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.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Apr 25, 2023

    Swagger Generation Artifacts

    ️️✔️ApiDocPreview succeeded [Detail] [Expand]
     Please click here to preview with your @microsoft account. 
    ️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

    Breaking Changes Tracking




    ️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from fd36ce7. 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.Redis [View full logs]  [Release SDK Changes]
      info	[Changelog]
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from fd36ce7. 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.6.6
      cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.6.6>
      cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@9.6.6` to update!
      cmderr	[automation_generate.sh] npm notice
    • ️✔️track2_azure-mgmt-redis [View full logs]  [Release SDK Changes]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog]   - Model ExportRDBParameters has a new parameter storage_subscription_id
      info	[Changelog]   - Model ImportRDBParameters has a new parameter storage_subscription_id
      info	[Changelog]   - Model RedisCommonPropertiesRedisConfiguration has a new parameter storage_subscription_id
    ️⚠️ azure-sdk-for-java warning [Detail]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from fd36ce7. 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/redis/armredis [View full logs]  [Release SDK Changes]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog] - New field `StorageSubscriptionID` in struct `CommonPropertiesRedisConfiguration`
      info	[Changelog] - New field `StorageSubscriptionID` in struct `ExportRDBParameters`
      info	[Changelog] - New field `StorageSubscriptionID` in struct `ImportRDBParameters`
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 3 additive change(s).
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from fd36ce7. 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-rediscache [View full logs]  [Release SDK Changes]
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Interface ExportRDBParameters has a new optional parameter storageSubscriptionId
      info	[Changelog]   - Interface ImportRDBParameters has a new optional parameter storageSubscriptionId
      info	[Changelog]   - Interface RedisCommonPropertiesRedisConfiguration has a new optional parameter storageSubscriptionId
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from fd36ce7. Schema Automation 14.0.0
      command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
      cmderr	[initScript.sh] WARN old lockfile
      cmderr	[initScript.sh] npm WARN old lockfile The package-lock.json file was created with an old version of npm,
      cmderr	[initScript.sh] npm WARN old lockfile so supplemental metadata must be fetched from the registry.
      cmderr	[initScript.sh] npm WARN old lockfile
      cmderr	[initScript.sh] npm WARN old lockfile This is a one-time fix-up, please be patient...
      cmderr	[initScript.sh] npm WARN old lockfile
      warn	File azure-resource-manager-schemas_tmp/initOutput.json not found to read
      command	.sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json
    ️❌ azure-powershell failed [Detail]
    • Pipeline Framework Failed [Logs]Release - Generate from fd36ce7. 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.redis.DefaultTag [View full logs
      error	Fatal error: SSL error: syscall failure: Broken pipe
      error	The following packages are still pending:
      error		Az.redis.DefaultTag
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Apr 25, 2023

    Generated ApiView

    Language Package Name ApiView Link
    Go sdk/resourcemanager/redis/armredis https://apiview.dev/Assemblies/Review/d26e402d09d64bd98be2b9df54844b16
    Java azure-resourcemanager-redis-generated https://apiview.dev/Assemblies/Review/a4ad21381f2543fa93fdc642279dc1ff
    .Net Azure.ResourceManager.Redis https://apiview.dev/Assemblies/Review/5122c8b0688649ebae6767a946356f76
    JavaScript @azure/arm-rediscache https://apiview.dev/Assemblies/Review/ec6a1017fc164c95bdcc10c0e2094bba

    @openapi-workflow-bot
    Copy link

    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."
    Copy link
    Member

    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?)

    Copy link
    Contributor Author

    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.

    @pilor
    Copy link
    Contributor

    pilor commented Apr 26, 2023

    Why do you need the subscription ID of the storage account (and not the full resource ID)?

    @openapi-workflow-bot
    Copy link

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

    @openapi-workflow-bot openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Apr 26, 2023
    @ajtiwari07
    Copy link
    Contributor Author

    Why do you need the subscription ID of the storage account (and not the full resource ID)?

    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.

    @pilor
    Copy link
    Contributor

    pilor commented Apr 26, 2023

    Why do you need the subscription ID of the storage account (and not the full resource ID)?

    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?

    @ajtiwari07
    Copy link
    Contributor Author

    ajtiwari07 commented Apr 26, 2023

    Why do you need the subscription ID of the storage account (and not the full resource ID)?

    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.
    But now instead of assuming storage account exists in cache subscription, we use the subscription Id parameter.

    @pilor
    Copy link
    Contributor

    pilor commented Apr 26, 2023

    Why do you need the subscription ID of the storage account (and not the full resource ID)?

    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. But now instead of assuming storage account exists in cache subscription, we use the subscription Id parameter.

    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.

    @pilor pilor added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Apr 26, 2023
    @ajtiwari07
    Copy link
    Contributor Author

    ajtiwari07 commented Apr 26, 2023

    Why do you need the subscription ID of the storage account (and not the full resource ID)?

    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. But now instead of assuming storage account exists in cache subscription, we use the subscription Id parameter.

    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.
    Also, the cross subscription only applies to subscription in the same tenant as the cache.

    @TimLovellSmith
    Copy link
    Member

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Labels

    ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review CI-MissingBaseCommit new-api-version ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test Redis Cache resource-manager

    Projects

    None yet

    Development

    Successfully merging this pull request may close these issues.

    7 participants