-
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
Use format: arm-id in Redis and RedisEnterprise where appropriate #25517
Use format: arm-id in Redis and RedisEnterprise where appropriate #25517
Conversation
Next Steps to Merge✔️ All automated merging requirements have been met! Refer to step 4 in the PR workflow diagram (even if your PR is for data plane, not ARM). |
Swagger Validation Report
|
compared swaggers (via Oad v0.10.4)] | new version | base version |
---|---|---|
redis.json | 2023-04-01(63933c0) | 2023-04-01(main) |
redisenterprise.json | 2023-07-01(63933c0) | 2023-07-01(main) |
️️✔️
Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️
LintDiff: 0 Warnings warning [Detail]
compared tags (via openapi-validator v2.1.4) | new version | base version |
---|---|---|
package-2023-04 | package-2023-04(63933c0) | package-2023-04(main) |
package-2023-07 | package-2023-07(63933c0) | package-2023-07(main) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
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 |
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#L2080 |
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#L2095 |
MissingTypeObject |
The schema 'RedisCreateParameters' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2023-04-01/redis.json#L2178 |
MissingTypeObject |
The schema 'RedisUpdateParameters' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2023-04-01/redis.json#L2218 |
MissingTypeObject |
The schema 'RedisAccessKeys' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2023-04-01/redis.json#L2239 |
MissingTypeObject |
The schema 'RedisFirewallRule' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2023-04-01/redis.json#L2254 |
MissingTypeObject |
The schema 'RedisFirewallRuleProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2023-04-01/redis.json#L2280 |
MissingTypeObject |
The schema 'RedisFirewallRuleListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2023-04-01/redis.json#L2297 |
MissingTypeObject |
The schema 'RedisResource' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2023-04-01/redis.json#L2314 |
MissingTypeObject |
The schema 'RedisInstanceDetails' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2023-04-01/redis.json#L2343 |
MissingTypeObject |
The schema 'RedisListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2023-04-01/redis.json#L2381 |
MissingTypeObject |
The schema 'RedisRegenerateKeyParameters' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2023-04-01/redis.json#L2398 |
MissingTypeObject |
The schema 'RedisRebootParameters' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2023-04-01/redis.json#L2418 |
IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: Microsoft.Cache/stable/2023-04-01/redis.json#L2440 |
MissingTypeObject |
The schema 'ExportRDBParameters' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2023-04-01/redis.json#L2448 |
MissingTypeObject |
The schema 'ImportRDBParameters' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2023-04-01/redis.json#L2477 |
MissingTypeObject |
The schema 'ScheduleEntry' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2023-04-01/redis.json#L2504 |
MissingTypeObject |
The schema 'ScheduleEntries' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2023-04-01/redis.json#L2542 |
MissingTypeObject |
The schema 'RedisPatchSchedule' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2023-04-01/redis.json#L2559 |
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#L2559 |
MissingTypeObject |
The schema 'RedisPatchScheduleListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2023-04-01/redis.json#L2582 |
MissingTypeObject |
The schema 'RedisForceRebootResponse' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2023-04-01/redis.json#L2599 |
MissingTypeObject |
The schema 'RedisLinkedServer' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2023-04-01/redis.json#L2609 |
MissingTypeObject |
The schema 'RedisLinkedServerWithProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2023-04-01/redis.json#L2627 |
MissingTypeObject |
The schema 'RedisLinkedServerProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2023-04-01/redis.json#L2642 |
MissingTypeObject |
The schema 'RedisLinkedServerWithPropertiesList' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2023-04-01/redis.json#L2657 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
SwaggerAPIView 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).
️️✔️
PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️
Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
|
Generated ApiView
|
Please address or respond to feedback from the ARM API reviewer. |
@@ -1700,6 +1700,7 @@ | |||
"properties": { | |||
"id": { | |||
"type": "string", | |||
"format": "arm-id", |
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 think we need to also add make changes in "ForceUnlinkParameters" properties, since it also have array of redis databases
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.
We should I think add this attribute whenever we use arm-id for databases ARM ID.
"x-ms-arm-id-details": {
"allowedResources": [
{
"type": "Microsoft.Cache/redisEnterprise/databases"
}
]
}
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.
Added the x-ms-arm-id-details
here w/ entry "Microsoft.Cache/redisEnterprise/databases" and also added for ForceUnlinkParameters
.
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.
Pls make changes to use arm-id format wherever we use data base resource ID
35f8372
to
af446d2
Compare
af446d2
to
63933c0
Compare
I've updated the |
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.
/pr RequestMerge |
"type": "Microsoft.Network/virtualNetworks/subnets" | ||
}, | ||
{ | ||
"type": "Microsoft.ClassicNetwork/virtualNetworks/subnets" |
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.
nonblocking question since from conservatism point of view its fine...
Is ClassicNetwork still supported? I think the plan is to deprecate it soon?
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'm not sure, but I don't think it hurts to have it here as all this is really saying is that "we would accept ClassicNetwork if you give it to us" - even if you can't make new ones maybe legacy existing ones are still allowed for a while?
Agree that it might be nice to be able to remove this once it really is deprecated, though not sure how to actually accomplish that in practice when the time comes.
Swagger pipeline restarted successfully, please wait for status update in this comment. |
ARM (Control Plane) API Specification Update Pull Request
PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
[1] ARM review queue (for merge queues, see [4])
The PRs are processed by time opened, ascending. Your PR may show up on 2nd or later page.
If you addressed Step 1 from the diagram and your PR is not showing up in the queue, ensure the label
ARMChangesRequested
is removed from your PR. This should cause the label
WaitForARMFeedback
to be added.[2] https://aka.ms/azsdk/support/specreview-channel
[3] List of SDK breaking changes approvers in pinned Teams announcement
[4] public repo merge queue, private repo merge queue (for ARM review queue, [1])
If you need further help with anything, see
Getting help
section below.Purpose of this PR
What's the purpose of this PR? Check all that apply. This is mandatory!
Due diligence checklist
To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:
ARM resource provider contract and
REST guidelines (estimated time: 4 hours).
I understand this is required before I can proceed to Step 2, "ARM Review", for this PR.
Breaking changes review (Step 1)
you must follow the breaking changes process.
IMPORTANT This applies even if:
Such claims must be reviewed, and the process is the same.
ARM API changes review (Step 2)
ARMReview
label.Viewing API changes
For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the
Generated ApiView
comment added to this PR. You can use ApiView to show API versions diff.Suppressing failures
If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
Swagger-Suppression-Process
to get approval.
Getting help
and https://aka.ms/ci-fix.