azure-rest-api-specs
azure-rest-api-specs copied to clipboard
Azure
Add stable api version 2023-12-01 for ScheduledQueryRules
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.
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)
- If this PR is in purview of ARM review then automation will add the
ARMReviewlabel. - If you want to force ARM review, add the label yourself.
- Proceed according to the diagram at the top of this comment.
Click here to see the diagram footnotes
Diagram footnotes
[1] ARM review queue (for merge queues, see [2])
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] 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!
- [x] New API version. (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.
- 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! To get your PR merged, see https://aka.ms/azsdk/specreview/merge.![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): 6 Warnings warning [Detail]
| Compared specs (v0.10.7) | new version | base version |
|---|---|---|
| scheduledQueryRule_API.json | 2023-12-01(757f113) | 2022-06-15(main) |
| scheduledQueryRule_API.json | 2023-12-01(757f113) | 2023-03-15-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
| Rule | Message |
|---|---|
| :warning: 1017 - ReferenceRedirection | The '$ref' property points to different models in the old and new versions. New: monitor/common-types/v2/commonMonitoringTypes.json#L236:9 Old: Microsoft.Insights/stable/2022-06-15/scheduledQueryRule_API.json#L686:9 |
| :warning: 1017 - ReferenceRedirection | The '$ref' property points to different models in the old and new versions. New: common-types/resource-management/v1/types.json#L308:11 Old: Microsoft.Insights/stable/2022-06-15/scheduledQueryRule_API.json#L715:11 |
| :warning: 1017 - ReferenceRedirection | The '$ref' property points to different models in the old and new versions. New: common-types/resource-management/v1/types.json#L320:11 Old: Microsoft.Insights/stable/2022-06-15/scheduledQueryRule_API.json#L727:11 |
The following breaking changes are detected by comparison with the latest preview version:
| Rule | Message |
|---|---|
| :warning: 1017 - ReferenceRedirection | The '$ref' property points to different models in the old and new versions. New: monitor/common-types/v2/commonMonitoringTypes.json#L236:9 Old: Microsoft.Insights/preview/2023-03-15-preview/scheduledQueryRule_API.json#L722:9 |
| :warning: 1017 - ReferenceRedirection | The '$ref' property points to different models in the old and new versions. New: common-types/resource-management/v1/types.json#L308:11 Old: Microsoft.Insights/preview/2023-03-15-preview/scheduledQueryRule_API.json#L751:11 |
| :warning: 1017 - ReferenceRedirection | The '$ref' property points to different models in the old and new versions. New: common-types/resource-management/v1/types.json#L320:11 Old: Microsoft.Insights/preview/2023-03-15-preview/scheduledQueryRule_API.json#L763:11 |
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️❌LintDiff: 4 Errors, 0 Warnings failed [Detail]
| Compared specs (v2.2.0) | new version | base version |
|---|---|---|
| package-2024-02 | package-2024-02(757f113) | package-2024-02(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
|
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.Insights/stable/2023-12-01/scheduledQueryRule_API.json#L435 |
RPC-Policy-V1-05, RPC-Put-V1-23 |
|
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.Insights/stable/2023-12-01/scheduledQueryRule_API.json#L533 |
RPC-Policy-V1-05, RPC-Put-V1-23 |
|
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.Insights/stable/2023-12-01/scheduledQueryRule_API.json#L561 |
RPC-Policy-V1-05, RPC-Put-V1-23 |
|
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.Insights/stable/2023-12-01/scheduledQueryRule_API.json#L574 |
RPC-Policy-V1-05, RPC-Put-V1-23 |
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 'ruleName' should be defined with a 'pattern' restriction. Location: Microsoft.Insights/stable/2023-12-01/scheduledQueryRule_API.json#L118 |
|
Properties of a PATCH request body must not be required, property:type. Location: Microsoft.Insights/stable/2023-12-01/scheduledQueryRule_API.json#L243 |
|
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.Insights/stable/2023-12-01/scheduledQueryRule_API.json#L323 |
|
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.Insights/stable/2023-12-01/scheduledQueryRule_API.json#L435 |
|
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.Insights/stable/2023-12-01/scheduledQueryRule_API.json#L533 |
|
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.Insights/stable/2023-12-01/scheduledQueryRule_API.json#L561 |
|
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.Insights/stable/2023-12-01/scheduledQueryRule_API.json#L574 |
| :warning: LatestVersionOfCommonTypesMustBeUsed | Use the latest version v5 of types.json. Location: Microsoft.Insights/stable/2023-12-01/scheduledQueryRule_API.json#L46 |
| :warning: LatestVersionOfCommonTypesMustBeUsed | Use the latest version v5 of types.json. Location: Microsoft.Insights/stable/2023-12-01/scheduledQueryRule_API.json#L49 |
| :warning: LatestVersionOfCommonTypesMustBeUsed | Use the latest version v5 of types.json. Location: Microsoft.Insights/stable/2023-12-01/scheduledQueryRule_API.json#L85 |
| :warning: LatestVersionOfCommonTypesMustBeUsed | Use the latest version v5 of types.json. Location: Microsoft.Insights/stable/2023-12-01/scheduledQueryRule_API.json#L88 |
| :warning: LatestVersionOfCommonTypesMustBeUsed | Use the latest version v5 of types.json. Location: Microsoft.Insights/stable/2023-12-01/scheduledQueryRule_API.json#L91 |
| :warning: LatestVersionOfCommonTypesMustBeUsed | Use the latest version v5 of types.json. Location: Microsoft.Insights/stable/2023-12-01/scheduledQueryRule_API.json#L127 |
| :warning: LatestVersionOfCommonTypesMustBeUsed | Use the latest version v5 of types.json. Location: Microsoft.Insights/stable/2023-12-01/scheduledQueryRule_API.json#L130 |
| :warning: LatestVersionOfCommonTypesMustBeUsed | Use the latest version v5 of types.json. Location: Microsoft.Insights/stable/2023-12-01/scheduledQueryRule_API.json#L136 |
| :warning: LatestVersionOfCommonTypesMustBeUsed | Use the latest version v5 of types.json. Location: Microsoft.Insights/stable/2023-12-01/scheduledQueryRule_API.json#L167 |
| :warning: LatestVersionOfCommonTypesMustBeUsed | Use the latest version v5 of types.json. Location: Microsoft.Insights/stable/2023-12-01/scheduledQueryRule_API.json#L170 |
| :warning: LatestVersionOfCommonTypesMustBeUsed | Use the latest version v5 of types.json. Location: Microsoft.Insights/stable/2023-12-01/scheduledQueryRule_API.json#L176 |
| :warning: LatestVersionOfCommonTypesMustBeUsed | Use the latest version v5 of types.json. Location: Microsoft.Insights/stable/2023-12-01/scheduledQueryRule_API.json#L228 |
| :warning: LatestVersionOfCommonTypesMustBeUsed | Use the latest version v5 of types.json. Location: Microsoft.Insights/stable/2023-12-01/scheduledQueryRule_API.json#L231 |
| :warning: LatestVersionOfCommonTypesMustBeUsed | Use the latest version v5 of types.json. Location: Microsoft.Insights/stable/2023-12-01/scheduledQueryRule_API.json#L237 |
| :warning: LatestVersionOfCommonTypesMustBeUsed | Use the latest version v5 of types.json. Location: Microsoft.Insights/stable/2023-12-01/scheduledQueryRule_API.json#L277 |
| :warning: LatestVersionOfCommonTypesMustBeUsed | Use the latest version v5 of types.json. Location: Microsoft.Insights/stable/2023-12-01/scheduledQueryRule_API.json#L280 |
| :warning: LatestVersionOfCommonTypesMustBeUsed | Use the latest version v5 of types.json. Location: Microsoft.Insights/stable/2023-12-01/scheduledQueryRule_API.json#L286 |
| :warning: EnumInsteadOfBoolean | Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.Insights/stable/2023-12-01/scheduledQueryRule_API.json#L345 |
| :warning: EnumInsteadOfBoolean | Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.Insights/stable/2023-12-01/scheduledQueryRule_API.json#L364 |
| :warning: EnumInsteadOfBoolean | Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.Insights/stable/2023-12-01/scheduledQueryRule_API.json#L393 |
| :warning: EnumInsteadOfBoolean | Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.Insights/stable/2023-12-01/scheduledQueryRule_API.json#L440 |
| :warning: EnumInsteadOfBoolean | Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.Insights/stable/2023-12-01/scheduledQueryRule_API.json#L445 |
| :warning: EnumInsteadOfBoolean | Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.Insights/stable/2023-12-01/scheduledQueryRule_API.json#L449 |
️⚠️Avocado: 1 Warnings warning [Detail]
| Rule | Message |
|---|---|
| :warning: MULTIPLE_API_VERSION | The default tag contains multiple API versions swaggers. readme: specification/monitor/resource-manager/readme.md tag: specification/monitor/resource-manager/readme.md#tag-package-2024-02 |
️️✔️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-net-track2 succeeded [Detail] [Expand]
️✔️Succeeded [Logs] Generate from 49dc94fe35067b1192cfef725129688d3ba057e3. SDK Automation 14.0.0command 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.Monitor [View full logs] [Preview SDK Changes]info [Changelog]
️⚠️ azure-sdk-for-python warning [Detail]
⚠️Warning [Logs] Generate from 49dc94fe35067b1192cfef725129688d3ba057e3. 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: 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] notice cmderr [automation_generate.sh] npm notice New minor version of npm available! 10.2.4 -> 10.5.0 cmderr [automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.5.0> cmderr [automation_generate.sh] npm notice Run `npm install -g [email protected]` to update! cmderr [automation_generate.sh] npm notice
️✔️track2_azure-mgmt-monitor [View full logs] [Preview SDK Changes]info [Changelog]
️⚠️ azure-sdk-for-java warning [Detail]
⚠️Warning [Logs] Generate from 49dc94fe35067b1192cfef725129688d3ba057e3. 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 -> 24.0 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 -> 24.0 cmderr [init.sh] [notice] To update, run: pip install --upgrade pip cmderr [init.sh] Current cmderr [init.sh] Dload Upload Total Spent Left Speed cmderr [init.sh] 0 0 0 0 0 0 0 0 15916 0 0 160k 0 --:--:-- --:--:-- --:--:-- 160k cmderr [init.sh] npm notice cmderr [init.sh] npm notice New minor version of npm available! 10.2.4 -> 10.5.0 cmderr [init.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.5.0> cmderr [init.sh] npm notice Run `npm install -g [email protected]` to update! cmderr [init.sh] npm notice 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-monitor-generated [View full logs] [Preview SDK Changes]
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
️✔️Succeeded [Logs] Generate from 49dc94fe35067b1192cfef725129688d3ba057e3. 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/monitor/armmonitor [View full logs] [Preview SDK Changes] Breaking Change Detectedinfo [Changelog] ### Breaking Changes info [Changelog] info [Changelog] - Function `*PrivateEndpointConnectionsClient.BeginCreateOrUpdate` parameter(s) have been changed from `(context.Context, string, string, string, PrivateEndpointConnection, *PrivateEndpointConnectionsClientBeginCreateOrUpdateOptions)` to `(context.Context, string, string, string, PrivateEndpointConnectionAutoGenerated, *PrivateEndpointConnectionsClientBeginCreateOrUpdateOptions)` info [Changelog] - Type of `AzureMonitorPrivateLinkScopeProperties.PrivateEndpointConnections` has been changed from `[]*PrivateEndpointConnection` to `[]*PrivateEndpointConnectionAutoGenerated` info [Changelog] - Type of `DefaultErrorResponse.Error` has been changed from `*ErrorDetail` to `*ErrorDetailAutoGenerated` info [Changelog] - Type of `ErrorContract.Error` has been changed from `*ErrorResponse` to `*ErrorResponseAutoGenerated` info [Changelog] - Type of `ErrorResponseAutoGenerated2.Error` has been changed from `*ErrorDetailAutoGenerated` to `*ErrorDetail` info [Changelog] - Type of `ErrorResponseCommonV2.Error` has been changed from `*ErrorDetail` to `*ErrorDetailAutoGenerated` info [Changelog] - Type of `EventCategoryCollection.Value` has been changed from `[]*LocalizableString` to `[]*LocalizableStringAutoGenerated` info [Changelog] - Type of `EventData.Category` has been changed from `*LocalizableString` to `*LocalizableStringAutoGenerated` info [Changelog] - Type of `EventData.EventName` has been changed from `*LocalizableString` to `*LocalizableStringAutoGenerated` info [Changelog] - Type of `EventData.OperationName` has been changed from `*LocalizableString` to `*LocalizableStringAutoGenerated` info [Changelog] - Type of `EventData.ResourceProviderName` has been changed from `*LocalizableString` to `*LocalizableStringAutoGenerated` info [Changelog] - Type of `EventData.ResourceType` has been changed from `*LocalizableString` to `*LocalizableStringAutoGenerated` info [Changelog] - Type of `EventData.Status` has been changed from `*LocalizableString` to `*LocalizableStringAutoGenerated` info [Changelog] - Type of `EventData.SubStatus` has been changed from `*LocalizableString` to `*LocalizableStringAutoGenerated` info [Changelog] - Type of `Metric.Unit` has been changed from `*Unit` to `*MetricUnit` info [Changelog] - Type of `OperationStatus.Error` has been changed from `*ErrorDetail` to `*ErrorDetailAutoGenerated` info [Changelog] - Type of `PrivateEndpointConnectionListResult.Value` has been changed from `[]*PrivateEndpointConnection` to `[]*PrivateEndpointConnectionAutoGenerated` info [Changelog] - Type of `SubscriptionScopeMetricsRequestBodyParameters.Timespan` has been changed from `*time.Time` to `*string` info [Changelog] - `PublicNetworkAccessSecuredByPerimeter` from enum `PublicNetworkAccess` has been removed info [Changelog] - Enum `Unit` has been removed info [Changelog] - Operation `*AzureMonitorWorkspacesClient.Delete` has been changed to LRO, use `*AzureMonitorWorkspacesClient.BeginDelete` instead. info [Changelog] - Struct `ErrorContractAutoGenerated` has been removed info [Changelog] - Struct `ErrorResponseAdditionalInfo` has been removed info [Changelog] - Struct `ErrorResponseDetails` has been removed info [Changelog] - Struct `SubscriptionScopeMetric` has been removed info [Changelog] - Struct `SubscriptionScopeMetricResponse` has been removed info [Changelog] - Field `SubscriptionScopeMetricResponse` of struct `MetricsClientListAtSubscriptionScopePostResponse` has been removed info [Changelog] - Field `SubscriptionScopeMetricResponse` of struct `MetricsClientListAtSubscriptionScopeResponse` has been removed info [Changelog] - Field `ActionType`, `IsDataAction`, `Origin` of struct `OperationAutoGenerated` has been removed info [Changelog] - Field `Description` of struct `OperationDisplayAutoGenerated` has been removed info [Changelog] - Field `OperationListResult` of struct `OperationsClientListResponse` has been removed info [Changelog] - Field `OperationListResultAutoGenerated` of struct `OperationsForMonitorClientListResponse` has been removed info [Changelog] - Field `PrivateEndpointConnection` of struct `PrivateEndpointConnectionsClientCreateOrUpdateResponse` has been removed info [Changelog] - Field `PrivateEndpointConnection` of struct `PrivateEndpointConnectionsClientGetResponse` has been removed info [Changelog] - Field `Location`, `Tags` of struct `Resource` has been removed info [Changelog] - Field `Location`, `Tags` of struct `ResourceAutoGenerated` has been removed info [Changelog] - Field `SystemData` of struct `ResourceAutoGenerated5` has been removed info [Changelog] - Field `PublicNetworkAccess` of struct `ScheduledQueryRuleProperties` has been removed info [Changelog] - Field `SystemData` of struct `TrackedResourceAutoGenerated` has been removed info [Changelog] info [Changelog] ### Features Added info [Changelog] info [Changelog] - New value `KnownSyslogDataSourceFacilityNamesAlert`, `KnownSyslogDataSourceFacilityNamesAudit`, `KnownSyslogDataSourceFacilityNamesClock`, `KnownSyslogDataSourceFacilityNamesFtp`, `KnownSyslogDataSourceFacilityNamesNopri`, `KnownSyslogDataSourceFacilityNamesNtp` added to enum type `KnownSyslogDataSourceFacilityNames` info [Changelog] - New function `NewClient(azcore.TokenCredential, *arm.ClientOptions) (*Client, error)` info [Changelog] - New function `*Client.BeginCreateNotificationsAtTenantActionGroupResourceLevel(context.Context, string, string, string, TenantNotificationRequestBody, *ClientBeginCreateNotificationsAtTenantActionGroupResourceLevelOptions) (*runtime.Poller[ClientCreateNotificationsAtTenantActionGroupResourceLevelResponse], error)` info [Changelog] - New function `*Client.GetTestNotificationsAtTenantActionGroupResourceLevel(context.Context, string, string, string, string, *ClientGetTestNotificationsAtTenantActionGroupResourceLevelOptions) (ClientGetTestNotificationsAtTenantActionGroupResourceLevelResponse, error)` info [Changelog] - New function `*ClientFactory.NewClient() *Client` info [Changelog] - New struct `ActionDetailAutoGenerated` info [Changelog] - New struct `ErrorResponseAutoGenerated3` info [Changelog] - New struct `ErrorResponseAutoGenerated4` info [Changelog] - New struct `LocalizableStringAutoGenerated` info [Changelog] - New struct `PrivateEndpointAutoGenerated` info [Changelog] - New struct `PrivateEndpointConnectionAutoGenerated` info [Changelog] - New struct `PrivateEndpointConnectionPropertiesAutoGenerated` info [Changelog] - New struct `ResourceAutoGenerated6` info [Changelog] - New struct `TenantNotificationRequestBody` info [Changelog] - New struct `TestNotificationDetailsResponseAutoGenerated` info [Changelog] - New field `ActionProperties` in struct `Actions` info [Changelog] - New field `PrivateEndpointConnections`, `PublicNetworkAccess` in struct `AzureMonitorWorkspace` info [Changelog] - New field `PrivateEndpointConnections`, `PublicNetworkAccess` in struct `AzureMonitorWorkspaceResourceProperties` info [Changelog] - New field `AdditionalInfo`, `Details`, `Target` in struct `ErrorResponseAutoGenerated` info [Changelog] - New field `Rollupby` in struct `MetricsClientListAtSubscriptionScopeOptions` info [Changelog] - New field `Rollupby` in struct `MetricsClientListAtSubscriptionScopePostOptions` info [Changelog] - New anonymous field `Response` in struct `MetricsClientListAtSubscriptionScopePostResponse` info [Changelog] - New anonymous field `Response` in struct `MetricsClientListAtSubscriptionScopeResponse` info [Changelog] - New field `Rollupby` in struct `MetricsClientListOptions` info [Changelog] - New field `ActionType`, `IsDataAction`, `Origin` in struct `Operation` info [Changelog] - New field `Description` in struct `OperationDisplay` info [Changelog] - New anonymous field `OperationListResultAutoGenerated` in struct `OperationsClientListResponse` info [Changelog] - New anonymous field `OperationListResult` in struct `OperationsForMonitorClientListResponse` info [Changelog] - New field `SystemData` in struct `PrivateEndpointConnection` info [Changelog] - New field `GroupIDs` in struct `PrivateEndpointConnectionProperties` info [Changelog] - New anonymous field `PrivateEndpointConnectionAutoGenerated` in struct `PrivateEndpointConnectionsClientCreateOrUpdateResponse` info [Changelog] - New anonymous field `PrivateEndpointConnectionAutoGenerated` in struct `PrivateEndpointConnectionsClientGetResponse` info [Changelog] - New field `SystemData` in struct `ResourceAutoGenerated` info [Changelog] - New field `SystemData` in struct `ResourceAutoGenerated2` info [Changelog] - New field `Location`, `Tags` in struct `ResourceAutoGenerated3` info [Changelog] - New field `SystemData` in struct `TrackedResource` info [Changelog] info [Changelog] Total 38 breaking change(s), 51 additive change(s).
Present SDK breaking changes suppressions No suppression file added.
Absent SDK breaking changes suppressions - Enum `Unit` has been removed - Field `ActionType`, `IsDataAction`, `Origin` of struct `OperationAutoGenerated` has been removed - Field `Description` of struct `OperationDisplayAutoGenerated` has been removed - Field `Location`, `Tags` of struct `ResourceAutoGenerated` has been removed - Field `Location`, `Tags` of struct `Resource` has been removed - Field `OperationListResultAutoGenerated` of struct `OperationsForMonitorClientListResponse` has been removed - Field `OperationListResult` of struct `OperationsClientListResponse` has been removed - Field `PrivateEndpointConnection` of struct `PrivateEndpointConnectionsClientCreateOrUpdateResponse` has been removed - Field `PrivateEndpointConnection` of struct `PrivateEndpointConnectionsClientGetResponse` has been removed - Field `PublicNetworkAccess` of struct `ScheduledQueryRuleProperties` has been removed - Field `SubscriptionScopeMetricResponse` of struct `MetricsClientListAtSubscriptionScopePostResponse` has been removed - Field `SubscriptionScopeMetricResponse` of struct `MetricsClientListAtSubscriptionScopeResponse` has been removed - Field `SystemData` of struct `ResourceAutoGenerated5` has been removed - Field `SystemData` of struct `TrackedResourceAutoGenerated` has been removed - Function `*PrivateEndpointConnectionsClient.BeginCreateOrUpdate` parameter(s) have been changed from `(context.Context, string, string, string, PrivateEndpointConnection, *PrivateEndpointConnectionsClientBeginCreateOrUpdateOptions)` to `(context.Context, string, string, string, PrivateEndpointConnectionAutoGenerated, *PrivateEndpointConnectionsClientBeginCreateOrUpdateOptions)` - Operation `*AzureMonitorWorkspacesClient.Delete` has been changed to LRO, use `*AzureMonitorWorkspacesClient.BeginDelete` instead. - Struct `ErrorContractAutoGenerated` has been removed - Struct `ErrorResponseAdditionalInfo` has been removed - Struct `ErrorResponseDetails` has been removed - Struct `SubscriptionScopeMetricResponse` has been removed - Struct `SubscriptionScopeMetric` has been removed - Type of `AzureMonitorPrivateLinkScopeProperties.PrivateEndpointConnections` has been changed from `[]*PrivateEndpointConnection` to `[]*PrivateEndpointConnectionAutoGenerated` - Type of `DefaultErrorResponse.Error` has been changed from `*ErrorDetail` to `*ErrorDetailAutoGenerated` - Type of `ErrorContract.Error` has been changed from `*ErrorResponse` to `*ErrorResponseAutoGenerated` - Type of `ErrorResponseAutoGenerated2.Error` has been changed from `*ErrorDetailAutoGenerated` to `*ErrorDetail` - Type of `ErrorResponseCommonV2.Error` has been changed from `*ErrorDetail` to `*ErrorDetailAutoGenerated` - Type of `EventCategoryCollection.Value` has been changed from `[]*LocalizableString` to `[]*LocalizableStringAutoGenerated` - Type of `EventData.Category` has been changed from `*LocalizableString` to `*LocalizableStringAutoGenerated` - Type of `EventData.EventName` has been changed from `*LocalizableString` to `*LocalizableStringAutoGenerated` - Type of `EventData.OperationName` has been changed from `*LocalizableString` to `*LocalizableStringAutoGenerated` - Type of `EventData.ResourceProviderName` has been changed from `*LocalizableString` to `*LocalizableStringAutoGenerated` - Type of `EventData.ResourceType` has been changed from `*LocalizableString` to `*LocalizableStringAutoGenerated` - Type of `EventData.Status` has been changed from `*LocalizableString` to `*LocalizableStringAutoGenerated` - Type of `EventData.SubStatus` has been changed from `*LocalizableString` to `*LocalizableStringAutoGenerated` - Type of `Metric.Unit` has been changed from `*Unit` to `*MetricUnit` - Type of `OperationStatus.Error` has been changed from `*ErrorDetail` to `*ErrorDetailAutoGenerated` - Type of `PrivateEndpointConnectionListResult.Value` has been changed from `[]*PrivateEndpointConnection` to `[]*PrivateEndpointConnectionAutoGenerated` - Type of `SubscriptionScopeMetricsRequestBodyParameters.Timespan` has been changed from `*time.Time` to `*string` - `PublicNetworkAccessSecuredByPerimeter` from enum `PublicNetworkAccess` has been removed
Parse Suppression File Errors No suppression file added.
Please refer to https://aka.ms/azsdk/sdk-suppression for more information.
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
️✔️Succeeded [Logs] Generate from 49dc94fe35067b1192cfef725129688d3ba057e3. 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-monitor [View full logs] [Preview SDK Changes]
️❌ azure-resource-manager-schemas failed [Detail]
❌Pipeline Framework Failed [Logs] Generate from 49dc94fe35067b1192cfef725129688d3ba057e3. Schema Automation 14.0.0command .sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json cmderr [initScript.sh] notice cmderr [initScript.sh] npm notice New minor version of npm available! 10.2.4 -> 10.5.0 cmderr [initScript.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.5.0> cmderr [initScript.sh] npm notice Run `npm install -g [email protected]` to update! cmderr [initScript.sh] npm notice 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 fatal: cannot force update the branch 'sdkAuto/27354/monitor' used by worktree at '/mnt/vss/_work/1/s/azure-resource-manager-schemas'
️✔️monitor [View full logs] [Preview Schema Changes]️✔️monitor [View full logs]error Fatal error: fatal: cannot force update the branch 'sdkAuto/27354/monitor' used by worktree at '/mnt/vss/_work/1/s/azure-resource-manager-schemas' error Fatal error: Error: fatal: cannot force update the branch 'sdkAuto/27354/monitor' used by worktree at '/mnt/vss/_work/1/s/azure-resource-manager-schemas' at Object.action (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected]/node_modules/simple-git/dist/cjs/index.js:1332:25) at PluginStore.exec (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected]/node_modules/simple-git/dist/cjs/index.js:1367:29) at /mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected]/node_modules/simple-git/dist/cjs/index.js:1766:43 at new Promise (<anonymous>) at GitExecutorChain.handleTaskData (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected]/node_modules/simple-git/dist/cjs/index.js:1764:16) at GitExecutorChain.<anonymous> (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected]/node_modules/simple-git/dist/cjs/index.js:1748:44) at Generator.next (<anonymous>) at fulfilled (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected]/node_modules/simple-git/dist/cjs/index.js:55:24) at process.processTicksAndRejections (node:internal/process/task_queues:95:5) error The following packages are still pending: error monitor error monitor error ERROR: The 'breakingChangesLabel' configuration is missing or incorrect from the 'swagger_to_sdk_config.json file.
️⚠️ azure-powershell warning [Detail]
⚠️Warning [Logs] Generate from 49dc94fe35067b1192cfef725129688d3ba057e3. SDK Automation 14.0.0command 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
⚠️Az.monitor.DefaultTag [View full logs] [Preview SDK Changes]
Generated ApiView
| Language | Package Name | ApiView Link |
|---|---|---|
| Go | sdk/resourcemanager/monitor/armmonitor | https://apiview.dev/Assemblies/Review/8854c2866c9c4e26a8a596fc1a823177?revisionId=366b984e8bd54cc697a01b06d4675045 |
| Java | azure-resourcemanager-monitor-generated | https://apiview.dev/Assemblies/Review/c5eba455f3ab4ce4bf0c0a2da8091fce?revisionId=9f465a6c82924e6d903ac2a6bc42df3a |
| .Net | Azure.ResourceManager.Monitor | There is no API change compared with the previous version |
| JavaScript | @azure/arm-monitor | https://apiview.dev/Assemblies/Review/6bb257ec6c7a48e3812505db443df4ae?revisionId=509a9174d2604cef8bb3dc5079e890e7 |
| Swagger | Microsoft.Insights | https://apiview.dev/Assemblies/Review/b1062e1dbaa34b189b1d407e01e2e372?revisionId=f5e8b41da8a84d08937d5f09a2c57ae3 |
Hi @avjerafi! 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}
![azure-pipelines[bot] avatar](https://avatars.githubusercontent.com/in/9426?v=4 "Published by a pub.dev verified publisher"){kind=small}
@rkmanda Regarding the LintDiff check: This api version introduces no schema changes. The "additionalProperties" is already in use in earlier api versions. I cannot stop using the "additionalProperties" now without introducing a major breaking change. What do I need to do in order to resolve this case?
@avjerafi ,could you fix the duplicate schema ErrorContract, in your resource type , it's a manually definition, but in
It references from
common-types/v2/commonMonitoringTypes.json#/definitions/ErrorContract
Please address or respond to feedback from the ARM API reviewer.
When you are ready to continue the ARM API review, please remove the ARMChangesRequested label.
This will notify the reviewer to have another look.
If the feedback provided needs further discussion, please use this Teams channel to post your questions - aka.ms/azsdk/support/specreview-channel.
Please include [ARM Query] in the title of your question to indicate that it is ARM-related.
@kazrael2119 I moved to use the ErrorContract from common-types as you requested. Even though I made sure the schema for both types is completely identical, it resulted in an unjustified flagging as breaking change: https://github.com/Azure/azure-rest-api-specs/pull/27354/checks?check_run_id=20715295975
How can this be suppressed?
@kazrael2119 I moved to use the ErrorContract from common-types as you requested. Even though I made sure the schema for both types is completely identical, it resulted in an unjustified flagging as breaking change: https://github.com/Azure/azure-rest-api-specs/pull/27354/checks?check_run_id=20715295975
How can this be suppressed?
I think you should ask BreaingChangeReviewBoard to get approval
@rkmanda Regarding the LintDiff check: This api version introduces no schema changes. The "additionalProperties" is already in use in earlier api versions. I cannot stop using the "additionalProperties" now without introducing a major breaking change. What do I need to do in order to resolve this case?
@rkmanda Gentle ping on this
@rkmanda I've pushed a suppression for the path of the actionProperties field, but saw that the flagging of the fields which refer to it did not go away, even after I pushed an additional commit to add their paths to the suppression - which I did not think made much sense. Are these just false positives by LintDiff?
When I saw that it did not help I reverted that last commit. The only current suppression is for the actionProperties field itself.
add @JeffreyRichter as a reviewer because the default tag has multi api versions
Azure's policy requires that all the api-versions match uniformly. So, you can't have some swaggers from one version and some from another. You also cannot have some be release and some be preview. There is no way a customer can rationalize how to use the service in this case. We are working on adding tooling to the repo to automatically catch these violations but we have to do it manually for now.
@kazrael2119 Can you please clarify the current status? How do we resolve the issue of multiple api versions in the default tag? What actions must I take?
@rkmanda The PR is still flagged by Go and JS breaking change tags for weeks after ARM signed off. IIUC, the workflow diagram basically says "wait", but I don't see any reviewer addressing these. Can you please let me know what I must do to expedite the resolution?
@lirenhe @Alancere can somebody please review the Go breaking changes?
