azure-rest-api-specs
azure-rest-api-specs copied to clipboard
Azure
Adding new version 2024-01-01-preview for updating monitor Properties
ARM (Control Plane) API Specification Update Pull Request
[!TIP] Overwhelmed by all this guidance? See the
Getting helpsection at the bottom of this PR description.
[!NOTE] As of January 2024 there is no PR assignee. This is expected. See https://aka.ms/azsdk/pr-arm-review.
PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
Click here to see the details of Step 1
Breaking changes review (Diagram Step 1)
If the automation determines you have breaking changes, i.e. Step 1 from the diagram applies to you,
you must follow the breaking changes process.
IMPORTANT This applies even if:
- The tool fails while it shouldn't, e.g. due to runtime exception, or incorrect detection of breaking changes.
- You believe there is no need for you to request breaking change approval, for any reason. Such claims must be reviewed, and the process is the same.
Click here to see the details of Step 2
ARM API changes review (Diagram Step 2)
- For help with Step 2 / "ARM review", see https://aka.ms/azsdk/pr-arm-review.
Click here to see the diagram footnotes
Diagram footnotes
[1] See ARM review queue (for PR merge queues, see [2]).
[2] public repo merge queue, private repo merge queue (for ARM review queue, [1])
The ARM reviewer on-call engineer visits the merge queue twice a day, so the approximate ETA for merges is 12 - 24 hours.
Purpose of this PR
What's the purpose of this PR? Check the specific option that applies. This is mandatory!
- [ ] New resource provider.
- [x] New API version for an existing resource provider. (If API spec is not defined in TypeSpec, the PR should have been generated using OpenAPI Hub).
- [ ] Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
- [ ] Update existing version to fix swagger quality issues in S360.
- [ ] Other, please clarify:
- edit this with your clarification
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:
- [x] I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
- [x] I have reviewed following Resource Provider guidelines, including
ARM resource provider contract and
REST guidelines (estimated time: 4 hours).
I understand this is required before I can proceed to the Diagram Step 2, "ARM API changes Review", for this PR.
Additional information
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
- First, please carefully read through this PR description, from top to bottom. Please fill out the
Purpose of this PRandDue diligence checklist. - To understand what you must do next to merge this PR, see the
Next Steps to Mergecomment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state. - For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure and https://aka.ms/ci-fix.
- For help with PR workflow diagram Step 2 (ARM review), see https://aka.ms/azsdk/pr-arm-review.
- If the PR CI checks appear to be stuck in
queuedstate, please add a comment with contents/azp run. This should result in a new comment denoting aPR validation pipelinehas started and the checks should be updated after few minutes. - If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.
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).![openapi-pipeline-app[bot] avatar](https://avatars.githubusercontent.com/in/65541?v=4 "Published by a pub.dev verified publisher"){kind=small}
Swagger Validation Report
️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| NewRelic.json | 2024-01-01-preview(6d3e406) | 2022-07-01(main) |
| NewRelic.json | 2024-01-01-preview(6d3e406) | 2023-11-01-preview(main) |
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 0 Warnings warning [Detail]
| compared tags (via openapi-validator v2.1.6) | new version | base version |
|---|---|---|
| package-2024-01-01-preview | package-2024-01-01-preview(6d3e406) | 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 |
|---|---|
|
The resource name parameter 'monitorName' should be defined with a 'pattern' restriction. Location: NewRelic.Observability/preview/2024-01-01-preview/NewRelic.json#L325 |
|
provisioningState property must be set to readOnly. Location: NewRelic.Observability/preview/2024-01-01-preview/NewRelic.json#L353 |
|
provisioningState property must be set to readOnly. Location: NewRelic.Observability/preview/2024-01-01-preview/NewRelic.json#L406 |
|
provisioningState property must be set to readOnly. Location: NewRelic.Observability/preview/2024-01-01-preview/NewRelic.json#L419 |
|
provisioningState property must be set to readOnly. Location: NewRelic.Observability/preview/2024-01-01-preview/NewRelic.json#L476 |
|
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: NewRelic.Observability/preview/2024-01-01-preview/NewRelic.json#L493 |
|
A 202 response should include an Location response header. Location: NewRelic.Observability/preview/2024-01-01-preview/NewRelic.json#L526 |
|
The resource name parameter 'monitorName' should be defined with a 'pattern' restriction. Location: NewRelic.Observability/preview/2024-01-01-preview/NewRelic.json#L558 |
|
The resource name parameter 'monitorName' should be defined with a 'pattern' restriction. Location: NewRelic.Observability/preview/2024-01-01-preview/NewRelic.json#L610 |
|
The resource name parameter 'monitorName' should be defined with a 'pattern' restriction. Location: NewRelic.Observability/preview/2024-01-01-preview/NewRelic.json#L662 |
|
The resource name parameter 'monitorName' should be defined with a 'pattern' restriction. Location: NewRelic.Observability/preview/2024-01-01-preview/NewRelic.json#L717 |
|
Operations with a 202 response must specify x-ms-long-running-operation: true. GET operation is excluded from the validation as GET will have 202 only if it is a polling action & hence x-ms-long-running-operation wouldn't be definedLocation: NewRelic.Observability/preview/2024-01-01-preview/NewRelic.json#L718 |
|
An async POST operation must set ''x-ms-long-running-operation' : true'. Location: NewRelic.Observability/preview/2024-01-01-preview/NewRelic.json#L718 |
|
provisioningState property must be set to readOnly. Location: NewRelic.Observability/preview/2024-01-01-preview/NewRelic.json#L748 |
|
A 202 response should include an Location response header. Location: NewRelic.Observability/preview/2024-01-01-preview/NewRelic.json#L754 |
|
The resource name parameter 'monitorName' should be defined with a 'pattern' restriction. Location: NewRelic.Observability/preview/2024-01-01-preview/NewRelic.json#L782 |
|
The resource name parameter 'monitorName' should be defined with a 'pattern' restriction. Location: NewRelic.Observability/preview/2024-01-01-preview/NewRelic.json#L837 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Monitors' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: NewRelic.Observability/preview/2024-01-01-preview/NewRelic.json#L842 |
|
The resource name parameter 'monitorName' should be defined with a 'pattern' restriction. Location: NewRelic.Observability/preview/2024-01-01-preview/NewRelic.json#L1000 |
|
The resource name parameter 'monitorName' should be defined with a 'pattern' restriction. Location: NewRelic.Observability/preview/2024-01-01-preview/NewRelic.json#L1052 |
|
The resource name parameter 'ruleSetName' should be defined with a 'pattern' restriction. Location: NewRelic.Observability/preview/2024-01-01-preview/NewRelic.json#L1052 |
|
provisioningState property must be set to readOnly. Location: NewRelic.Observability/preview/2024-01-01-preview/NewRelic.json#L1087 |
|
provisioningState property must be set to readOnly. Location: NewRelic.Observability/preview/2024-01-01-preview/NewRelic.json#L1150 |
|
provisioningState property must be set to readOnly. Location: NewRelic.Observability/preview/2024-01-01-preview/NewRelic.json#L1163 |
|
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: NewRelic.Observability/preview/2024-01-01-preview/NewRelic.json#L1187 |
|
A 202 response should include an Location response header. Location: NewRelic.Observability/preview/2024-01-01-preview/NewRelic.json#L1224 |
|
provisioningState property must be set to readOnly. Location: NewRelic.Observability/preview/2024-01-01-preview/NewRelic.json#L1298 |
|
provisioningState property must be set to readOnly. Location: NewRelic.Observability/preview/2024-01-01-preview/NewRelic.json#L1419 |
|
provisioningState property must be set to readOnly. Location: NewRelic.Observability/preview/2024-01-01-preview/NewRelic.json#L1492 |
|
provisioningState property must be set to readOnly. Location: NewRelic.Observability/preview/2024-01-01-preview/NewRelic.json#L1498 |
️️✔️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.
️️✔️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
️️✔️ApiDocPreview succeeded [Detail] [Expand]
Please click here to preview with your @microsoft account.
️⚠️ azure-sdk-for-python warning [Detail]
⚠️Warning [Logs] Generate from c3f7c8fcba3b6a80ff2a44bb493697bca8bbe631. SDK Automation 14.0.0command sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json cmderr [automation_init.sh] WARNING: azure-devtools 1.2.1 does not provide the extra 'ci-tools' cmderr [automation_init.sh] WARNING: azure-devtools 1.2.1 does not provide the extra 'ci-tools' cmderr [automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed. command sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json cmderr [automation_generate.sh] cmderr [automation_generate.sh] npm notice New minor version of npm available! 10.2.3 -> 10.3.0 cmderr [automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.3.0> cmderr [automation_generate.sh] npm notice Run `npm install -g [email protected]` to update! cmderr [automation_generate.sh] npm notice
️✔️track2_azure-mgmt-newrelicobservability [View full logs] [Preview SDK Changes]- azure_mgmt_newrelicobservability-1.0.0b1-py3-none-any.whl
- azure-mgmt-newrelicobservability-1.0.0b1.zip
info [Changelog] ### Features Added info [Changelog] info [Changelog] - Added operation MonitorsOperations.list_linked_resources info [Changelog] - Added operation group BillingInfoOperations info [Changelog] - Added operation group ConnectedPartnerResourcesOperations info [Changelog] - Added operation group MonitoredSubscriptionsOperations info [Changelog] - Model NewRelicMonitorResource has a new parameter saa_s_azure_subscription_status info [Changelog] - Model NewRelicMonitorResource has a new parameter subscription_state
️⚠️ azure-sdk-for-java warning [Detail]
⚠️Warning [Logs] Generate from c3f7c8fcba3b6a80ff2a44bb493697bca8bbe631. SDK Automation 14.0.0command ./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json cmderr [init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.3.2 cmderr [init.sh] [notice] To update, run: pip install --upgrade pip cmderr [init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.3.2 cmderr [init.sh] [notice] To update, run: pip install --upgrade pip cmderr [init.sh] rd Average Speed Time Time Time Current cmderr [init.sh] Dload Upload Total Spent Left Speed cmderr [init.sh] 0 0 0 0 0 0 0 0 --:--:-- --:--:-- --:--:-- 0 cmderr [init.sh] Downloading https://nodejs.org/dist/v18.15.0/node-v18.15.0-linux-x64.tar.xz... cmderr [init.sh] Computing checksum with sha256sum cmderr [init.sh] Checksums matched! command ./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
️✔️azure-resourcemanager-newrelicobservability [View full logs] [Preview SDK Changes]
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
️✔️Succeeded [Logs] Generate from c3f7c8fcba3b6a80ff2a44bb493697bca8bbe631. SDK Automation 14.0.0command 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/newrelic/armnewrelicobservability [View full logs] [Preview SDK Changes]info [Changelog] ### Features Added info [Changelog] info [Changelog] - New enum type `ConfigurationName` with values `ConfigurationNameDefault` info [Changelog] - New enum type `PatchOperation` with values `PatchOperationActive`, `PatchOperationAddBegin`, `PatchOperationAddComplete`, `PatchOperationDeleteBegin`, `PatchOperationDeleteComplete` info [Changelog] - New enum type `Status` with values `StatusActive`, `StatusDeleting`, `StatusFailed`, `StatusInProgress` info [Changelog] - New function `NewBillingInfoClient(string, azcore.TokenCredential, *arm.ClientOptions) (*BillingInfoClient, error)` info [Changelog] - New function `*BillingInfoClient.Get(context.Context, string, string, *BillingInfoClientGetOptions) (BillingInfoClientGetResponse, error)` info [Changelog] - New function `*ClientFactory.NewBillingInfoClient() *BillingInfoClient` info [Changelog] - New function `*ClientFactory.NewConnectedPartnerResourcesClient() *ConnectedPartnerResourcesClient` info [Changelog] - New function `*ClientFactory.NewMonitoredSubscriptionsClient() *MonitoredSubscriptionsClient` info [Changelog] - New function `NewConnectedPartnerResourcesClient(string, azcore.TokenCredential, *arm.ClientOptions) (*ConnectedPartnerResourcesClient, error)` info [Changelog] - New function `*ConnectedPartnerResourcesClient.NewListPager(string, string, *ConnectedPartnerResourcesClientListOptions) *runtime.Pager[ConnectedPartnerResourcesClientListResponse]` info [Changelog] - New function `NewMonitoredSubscriptionsClient(string, azcore.TokenCredential, *arm.ClientOptions) (*MonitoredSubscriptionsClient, error)` info [Changelog] - New function `*MonitoredSubscriptionsClient.BeginCreateorUpdate(context.Context, string, string, ConfigurationName, MonitoredSubscriptionProperties, *MonitoredSubscriptionsClientBeginCreateorUpdateOptions) (*runtime.Poller[MonitoredSubscriptionsClientCreateorUpdateResponse], error)` info [Changelog] - New function `*MonitoredSubscriptionsClient.BeginDelete(context.Context, string, string, ConfigurationName, *MonitoredSubscriptionsClientBeginDeleteOptions) (*runtime.Poller[MonitoredSubscriptionsClientDeleteResponse], error)` info [Changelog] - New function `*MonitoredSubscriptionsClient.Get(context.Context, string, string, ConfigurationName, *MonitoredSubscriptionsClientGetOptions) (MonitoredSubscriptionsClientGetResponse, error)` info [Changelog] - New function `*MonitoredSubscriptionsClient.NewListPager(string, string, *MonitoredSubscriptionsClientListOptions) *runtime.Pager[MonitoredSubscriptionsClientListResponse]` info [Changelog] - New function `*MonitoredSubscriptionsClient.BeginUpdate(context.Context, string, string, ConfigurationName, MonitoredSubscriptionProperties, *MonitoredSubscriptionsClientBeginUpdateOptions) (*runtime.Poller[MonitoredSubscriptionsClientUpdateResponse], error)` info [Changelog] - New function `*MonitorsClient.NewListLinkedResourcesPager(string, string, *MonitorsClientListLinkedResourcesOptions) *runtime.Pager[MonitorsClientListLinkedResourcesResponse]` info [Changelog] - New struct `BillingInfoResponse` info [Changelog] - New struct `ConnectedPartnerResourceProperties` info [Changelog] - New struct `ConnectedPartnerResourcesListFormat` info [Changelog] - New struct `ConnectedPartnerResourcesListResponse` info [Changelog] - New struct `LinkedResource` info [Changelog] - New struct `LinkedResourceListResponse` info [Changelog] - New struct `MarketplaceSaaSInfo` info [Changelog] - New struct `MonitoredSubscription` info [Changelog] - New struct `MonitoredSubscriptionProperties` info [Changelog] - New struct `MonitoredSubscriptionPropertiesList` info [Changelog] - New struct `PartnerBillingEntity` info [Changelog] - New struct `SubscriptionList` info [Changelog] - New field `SaaSAzureSubscriptionStatus`, `SubscriptionState` in struct `MonitorProperties` info [Changelog] info [Changelog] Total 0 breaking change(s), 52 additive change(s).
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
️✔️Succeeded [Logs] Generate from c3f7c8fcba3b6a80ff2a44bb493697bca8bbe631. SDK Automation 14.0.0command 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-newrelicobservability [View full logs] [Preview SDK Changes]info [Changelog] **Features** info [Changelog] info [Changelog] - Added operation group BillingInfo info [Changelog] - Added operation group ConnectedPartnerResources info [Changelog] - Added operation group MonitoredSubscriptions info [Changelog] - Added operation Monitors.listLinkedResources info [Changelog] - Added Interface BillingInfoGetOptionalParams info [Changelog] - Added Interface BillingInfoResponse info [Changelog] - Added Interface ConnectedPartnerResourceProperties info [Changelog] - Added Interface ConnectedPartnerResourcesListFormat info [Changelog] - Added Interface ConnectedPartnerResourcesListNextOptionalParams info [Changelog] - Added Interface ConnectedPartnerResourcesListOptionalParams info [Changelog] - Added Interface ConnectedPartnerResourcesListResponse info [Changelog] - Added Interface LinkedResource info [Changelog] - Added Interface LinkedResourceListResponse info [Changelog] - Added Interface MarketplaceSaaSInfo info [Changelog] - Added Interface MonitoredSubscription info [Changelog] - Added Interface MonitoredSubscriptionProperties info [Changelog] - Added Interface MonitoredSubscriptionPropertiesList info [Changelog] - Added Interface MonitoredSubscriptionsCreateorUpdateOptionalParams info [Changelog] - Added Interface MonitoredSubscriptionsDeleteHeaders info [Changelog] - Added Interface MonitoredSubscriptionsDeleteOptionalParams info [Changelog] - Added Interface MonitoredSubscriptionsGetOptionalParams info [Changelog] - Added Interface MonitoredSubscriptionsListNextOptionalParams info [Changelog] - Added Interface MonitoredSubscriptionsListOptionalParams info [Changelog] - Added Interface MonitoredSubscriptionsUpdateHeaders info [Changelog] - Added Interface MonitoredSubscriptionsUpdateOptionalParams info [Changelog] - Added Interface MonitoringTagRulesProperties info [Changelog] - Added Interface MonitorsListLinkedResourcesNextOptionalParams info [Changelog] - Added Interface MonitorsListLinkedResourcesOptionalParams info [Changelog] - Added Interface PartnerBillingEntity info [Changelog] - Added Interface SubscriptionList info [Changelog] - Added Type Alias BillingInfoGetResponse info [Changelog] - Added Type Alias ConfigurationName info [Changelog] - Added Type Alias ConnectedPartnerResourcesListNextResponse info [Changelog] - Added Type Alias ConnectedPartnerResourcesListOperationResponse info [Changelog] - Added Type Alias MonitoredSubscriptionsCreateorUpdateResponse info [Changelog] - Added Type Alias MonitoredSubscriptionsDeleteResponse info [Changelog] - Added Type Alias MonitoredSubscriptionsGetResponse info [Changelog] - Added Type Alias MonitoredSubscriptionsListNextResponse info [Changelog] - Added Type Alias MonitoredSubscriptionsListResponse info [Changelog] - Added Type Alias MonitoredSubscriptionsUpdateResponse info [Changelog] - Added Type Alias MonitorsListLinkedResourcesNextResponse info [Changelog] - Added Type Alias MonitorsListLinkedResourcesResponse info [Changelog] - Added Type Alias PatchOperation info [Changelog] - Added Type Alias Status info [Changelog] - Interface NewRelicMonitorResource has a new optional parameter saaSAzureSubscriptionStatus info [Changelog] - Interface NewRelicMonitorResource has a new optional parameter subscriptionState info [Changelog] - Added Enum KnownConfigurationName info [Changelog] - Added Enum KnownPatchOperation info [Changelog] - Added Enum KnownStatus
Generated ApiView
| Language | Package Name | ApiView Link |
|---|---|---|
| Go | sdk/resourcemanager/newrelic/armnewrelicobservability | https://apiview.dev/Assemblies/Review/999df1ee7b8a464d88beb2308437bc4c?revisionId=69379adbbc7b492da9066d982a55f25c |
| Java | azure-resourcemanager-newrelicobservability | https://apiview.dev/Assemblies/Review/a18334d9d6724a52b30ae5636c89fc7b?revisionId=a0f31df985084359be6972d14877658f |
| JavaScript | @azure/arm-newrelicobservability | https://apiview.dev/Assemblies/Review/99967d8f3115439cb831bbe6453cefeb?revisionId=3b232126307d4ee7a3a847e67aa4ec88 |
| Swagger | NewRelic.Observability | https://apiview.dev/Assemblies/Review/4f1175ea3107425ea4de355730c7c98e?revisionId=d36ba85f350943e9b385006b5ccc0ece |
Hi @apoorvasingh130! 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.
![openapi-workflow-bot[bot] avatar](https://avatars.githubusercontent.com/in/81125?v=4 "Published by a pub.dev verified publisher"){kind=small}