azure-rest-api-specs
azure-rest-api-specs copied to clipboard
Published
20 hours ago •
Azure
Azure
Add health reports spec
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:
- What's the purpose of the update?
- [ ] new service onboarding
- [X] new API version
- [ ] update existing version for new feature
- [ ] update existing version to fix swagger quality issue in s360
- [ ] Other, please clarify
- 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. EOM (Feb)
- When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month. March
- 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):
- [x] I commit to follow the Breaking Change Policy of "no breaking changes"
- [x] I have reviewed the documentation for the workflow.
- [x] Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Applicability: :warning:
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 -[ ] 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.
Swagger Validation Report
️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| types.json | 1.0(94273cb) | 1.0(main) |
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 4 Warnings warning [Detail]
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-composite-v1 | package-composite-v1(94273cb) | package-composite-v1(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| :warning: ParameterNotDefinedInGlobalParameters | Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Security/preview/2023-02-01-preview/healthReports.json#L49 |
|
| :warning: RequiredReadOnlySystemData | The response of operation:'HealthReport_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Security/preview/2023-02-01-preview/healthReports.json#L83 |
|
| :warning: OperationIdNounConflictingModelNames | OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'HealthReportModel'. Consider using the plural form of 'HealthReport' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Security/preview/2023-02-01-preview/healthReports.json#L93 |
|
| :warning: ParameterNotDefinedInGlobalParameters | Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Security/preview/2023-02-01-preview/healthReports.json#L94 |
️❌Avocado: 2 Errors, 1 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Security/healthReports/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/security/resource-manager/readme.md json: Microsoft.Security/preview/2023-02-01-preview/healthReports.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Security/healthReports/{}/component/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/security/resource-manager/readme.md json: Microsoft.Security/preview/2023-02-01-preview/healthReports.json |
| :warning: MULTIPLE_API_VERSION | The default tag contains multiple API versions swaggers. readme: specification/security/resource-manager/readme.md tag: specification/security/resource-manager/readme.md#tag-package-composite-v3 |
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️CadlAPIView 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.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
![openapi-pipeline-app[bot] avatar](https://avatars.githubusercontent.com/in/65541?v=4 "Published by a pub.dev verified publisher"){kind=small}
Hi, @rzhelenchuk Thanks for your PR. I am workflow bot for review process. Here are some small tips.
![openapi-workflow-bot[bot] avatar](https://avatars.githubusercontent.com/in/81125?v=4 "Published by a pub.dev verified publisher"){kind=small}
Swagger Generation Artifacts
️️✔️ApiDocPreview succeeded [Detail] [Expand]
Please click here to preview with your @microsoft account.
️❌SDK Breaking Change Tracking failed [Detail]
Breaking Changes Tracking
❌azure-sdk-for-go - sdk/resourcemanager/security/armsecurity - 0.10.0+ Function `*ConnectorGovernanceRuleClient.NewListPager` has been removed + Function `*ConnectorGovernanceRulesClient.CreateOrUpdate` has been removed + Function `*ConnectorGovernanceRulesClient.Delete` has been removed + Function `*ConnectorGovernanceRulesClient.Get` has been removed + Function `*ConnectorGovernanceRulesExecuteStatusClient.BeginGet` has been removed + Function `*GovernanceRuleClient.NewListPager` has been removed + Function `*GovernanceRulesClient.BeginRuleIDExecuteSingleSecurityConnector` has been removed + Function `*GovernanceRulesClient.BeginRuleIDExecuteSingleSubscription` has been removed + Function `*GovernanceRulesClient.CreateOrUpdate` parameter(s) have been changed from `(context.Context, string, GovernanceRule, *GovernanceRulesClientCreateOrUpdateOptions)` to `(context.Context, string, string, GovernanceRule, *GovernanceRulesClientCreateOrUpdateOptions)` + Function `*GovernanceRulesClient.Get` parameter(s) have been changed from `(context.Context, string, *GovernanceRulesClientGetOptions)` to `(context.Context, string, string, *GovernanceRulesClientGetOptions)` + Function `*SubscriptionGovernanceRulesExecuteStatusClient.BeginGet` has been removed + Function `NewConnectorGovernanceRuleClient` has been removed + Function `NewConnectorGovernanceRulesClient` has been removed + Function `NewConnectorGovernanceRulesExecuteStatusClient` has been removed + Function `NewGovernanceRuleClient` has been removed + Function `NewGovernanceRulesClient` parameter(s) have been changed from `(string, azcore.TokenCredential, *arm.ClientOptions)` to `(azcore.TokenCredential, *arm.ClientOptions)` + Function `NewSubscriptionGovernanceRulesExecuteStatusClient` has been removed + Operation `*GovernanceRulesClient.Delete` has been changed to LRO, use `*GovernanceRulesClient.BeginDelete` instead. + Struct `ConnectorGovernanceRuleClientListResponse` has been removed + Struct `ConnectorGovernanceRuleClient` has been removed + Struct `ConnectorGovernanceRulesClient` has been removed + Struct `ConnectorGovernanceRulesExecuteStatusClientGetResponse` has been removed + Struct `ConnectorGovernanceRulesExecuteStatusClient` has been removed + Struct `ExecuteRuleStatus` has been removed + Struct `GovernanceRuleClientListResponse` has been removed + Struct `GovernanceRuleClient` has been removed + Struct `GovernanceRulesClientRuleIDExecuteSingleSecurityConnectorResponse` has been removed + Struct `GovernanceRulesClientRuleIDExecuteSingleSubscriptionResponse` has been removed + Struct `SubscriptionGovernanceRulesExecuteStatusClientGetResponse` has been removed + Struct `SubscriptionGovernanceRulesExecuteStatusClient` has been removed
❌azure-sdk-for-python-track2 - track2_azure-mgmt-security - 3.0.0+ Operation GovernanceRulesOperations.create_or_update has a new required parameter scope + Operation GovernanceRulesOperations.get has a new required parameter scope + Removed operation GovernanceRulesOperations.begin_rule_id_execute_single_security_connector + Removed operation GovernanceRulesOperations.begin_rule_id_execute_single_subscription + Removed operation group GovernanceRuleOperations + Removed operation group SecurityConnectorGovernanceRuleOperations + Removed operation group SecurityConnectorGovernanceRulesExecuteStatusOperations + Removed operation group SecurityConnectorGovernanceRulesOperations + Removed operation group SubscriptionGovernanceRulesExecuteStatusOperations + Renamed operation GovernanceRulesOperations.delete to GovernanceRulesOperations.begin_delete
❌azure-sdk-for-js - @azure/arm-security - 6.0.0-beta.3+ Interface AlertsSuppressionRulesListNextOptionalParams no longer has parameter alertType + Interface DefenderForServersAwsOfferingArcAutoProvisioning no longer has parameter servicePrincipalSecretMetadata + Interface IotSecuritySolutionListByResourceGroupNextOptionalParams no longer has parameter filter + Interface IotSecuritySolutionListBySubscriptionNextOptionalParams no longer has parameter filter + Interface IotSecuritySolutionsAnalyticsAggregatedAlertListNextOptionalParams no longer has parameter top + Interface IotSecuritySolutionsAnalyticsRecommendationListNextOptionalParams no longer has parameter top + Interface RegulatoryComplianceAssessmentsListNextOptionalParams no longer has parameter filter + Interface RegulatoryComplianceControlsListNextOptionalParams no longer has parameter filter + Interface RegulatoryComplianceStandardsListNextOptionalParams no longer has parameter filter + Interface SecureScoreControlsListBySecureScoreNextOptionalParams no longer has parameter expand + Interface SecureScoreControlsListNextOptionalParams no longer has parameter expand + Interface TasksListByHomeRegionNextOptionalParams no longer has parameter filter + Interface TasksListByResourceGroupNextOptionalParams no longer has parameter filter + Interface TasksListNextOptionalParams no longer has parameter filter + Operation AllowedConnections.get has a new signature + Removed Enum KnownAlertNotifications + Removed Enum KnownAlertsToAdmins + Removed operation Alerts.simulate + Removed operation SecurityContacts.update + Type of parameter value of interface ExternalSecuritySolutionList is changed from ExternalSecuritySolutionUnion[] to ExternalSecuritySolution[]
️❌ azure-sdk-for-net-track2 failed [Detail]
❌Failed [Logs] Generate from 21b78617ef65699bfee734fd39540a3c928d3a4b. 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 cmderr [Invoke-GenerateAndBuildV2.ps1] [31;1mGeneratePackage: [0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:672 cmderr [Invoke-GenerateAndBuildV2.ps1] [36;1mLine | cmderr [Invoke-GenerateAndBuildV2.ps1] [36;1m 672 | [0m [36;1mGeneratePackage -projectFolder $projectFolder -sdkRootPath $s[0m … cmderr [Invoke-GenerateAndBuildV2.ps1] [36;1m | [31;1m ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ cmderr [Invoke-GenerateAndBuildV2.ps1] [31;1m[36;1m | [31;1mFailed to generate sdk. exit code: False cmderr [Invoke-GenerateAndBuildV2.ps1] [0m cmderr [Invoke-GenerateAndBuildV2.ps1] [31;1mGet-ChildItem: [0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:760 cmderr [Invoke-GenerateAndBuildV2.ps1] [36;1mLine | cmderr [Invoke-GenerateAndBuildV2.ps1] [36;1m 760 | [0m … rtifacts += [36;1mGet-ChildItem $artifactsPath -Filter *.nupkg -exclude *.s[0m … cmderr [Invoke-GenerateAndBuildV2.ps1] [36;1m | [31;1m ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ cmderr [Invoke-GenerateAndBuildV2.ps1] [31;1m[36;1m | [31;1mCannot find path cmderr [Invoke-GenerateAndBuildV2.ps1] [36;1m | [31;1m'/mnt/vss/_work/1/s/azure-sdk-for-net/artifacts/packages/Debug/' because cmderr [Invoke-GenerateAndBuildV2.ps1] [36;1m | [31;1mit does not exist. cmderr [Invoke-GenerateAndBuildV2.ps1] [0m cmderr [Invoke-GenerateAndBuildV2.ps1] [31;1mGeneratePackage: [0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:672 cmderr [Invoke-GenerateAndBuildV2.ps1] [36;1mLine | cmderr [Invoke-GenerateAndBuildV2.ps1] [36;1m 672 | [0m [36;1mGeneratePackage -projectFolder $projectFolder -sdkRootPath $s[0m … cmderr [Invoke-GenerateAndBuildV2.ps1] [36;1m | [31;1m ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ cmderr [Invoke-GenerateAndBuildV2.ps1] [31;1m[36;1m | [31;1mFailed to generate sdk artifact cmderr [Invoke-GenerateAndBuildV2.ps1] [0m
❌Azure.ResourceManager.SecurityCenter [View full logs] [Preview SDK Changes]info [Changelog]
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
️✔️Succeeded [Logs] Generate from 21b78617ef65699bfee734fd39540a3c928d3a4b. 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/security/armsecurity [View full logs] [Preview SDK Changes] Breaking Change Detectedinfo [Changelog] ### Breaking Changes info [Changelog] info [Changelog] - Function `NewGovernanceRulesClient` parameter(s) have been changed from `(string, azcore.TokenCredential, *arm.ClientOptions)` to `(azcore.TokenCredential, *arm.ClientOptions)` info [Changelog] - Function `*GovernanceRulesClient.CreateOrUpdate` parameter(s) have been changed from `(context.Context, string, GovernanceRule, *GovernanceRulesClientCreateOrUpdateOptions)` to `(context.Context, string, string, GovernanceRule, *GovernanceRulesClientCreateOrUpdateOptions)` info [Changelog] - Function `*GovernanceRulesClient.Get` parameter(s) have been changed from `(context.Context, string, *GovernanceRulesClientGetOptions)` to `(context.Context, string, string, *GovernanceRulesClientGetOptions)` info [Changelog] - Function `NewConnectorGovernanceRuleClient` has been removed info [Changelog] - Function `*ConnectorGovernanceRuleClient.NewListPager` has been removed info [Changelog] - Function `NewConnectorGovernanceRulesClient` has been removed info [Changelog] - Function `*ConnectorGovernanceRulesClient.CreateOrUpdate` has been removed info [Changelog] - Function `*ConnectorGovernanceRulesClient.Delete` has been removed info [Changelog] - Function `*ConnectorGovernanceRulesClient.Get` has been removed info [Changelog] - Function `NewConnectorGovernanceRulesExecuteStatusClient` has been removed info [Changelog] - Function `*ConnectorGovernanceRulesExecuteStatusClient.BeginGet` has been removed info [Changelog] - Function `NewGovernanceRuleClient` has been removed info [Changelog] - Function `*GovernanceRuleClient.NewListPager` has been removed info [Changelog] - Function `*GovernanceRulesClient.BeginRuleIDExecuteSingleSecurityConnector` has been removed info [Changelog] - Function `*GovernanceRulesClient.BeginRuleIDExecuteSingleSubscription` has been removed info [Changelog] - Function `NewSubscriptionGovernanceRulesExecuteStatusClient` has been removed info [Changelog] - Function `*SubscriptionGovernanceRulesExecuteStatusClient.BeginGet` has been removed info [Changelog] - Operation `*GovernanceRulesClient.Delete` has been changed to LRO, use `*GovernanceRulesClient.BeginDelete` instead. info [Changelog] - Struct `ConnectorGovernanceRuleClient` has been removed info [Changelog] - Struct `ConnectorGovernanceRuleClientListResponse` has been removed info [Changelog] - Struct `ConnectorGovernanceRulesClient` has been removed info [Changelog] - Struct `ConnectorGovernanceRulesExecuteStatusClient` has been removed info [Changelog] - Struct `ConnectorGovernanceRulesExecuteStatusClientGetResponse` has been removed info [Changelog] - Struct `ExecuteRuleStatus` has been removed info [Changelog] - Struct `GovernanceRuleClient` has been removed info [Changelog] - Struct `GovernanceRuleClientListResponse` has been removed info [Changelog] - Struct `GovernanceRulesClientRuleIDExecuteSingleSecurityConnectorResponse` has been removed info [Changelog] - Struct `GovernanceRulesClientRuleIDExecuteSingleSubscriptionResponse` has been removed info [Changelog] - Struct `SubscriptionGovernanceRulesExecuteStatusClient` has been removed info [Changelog] - Struct `SubscriptionGovernanceRulesExecuteStatusClientGetResponse` has been removed info [Changelog] info [Changelog] ### Features Added info [Changelog] info [Changelog] - New type alias `OperationResult` with values `OperationResultCanceled`, `OperationResultFailed`, `OperationResultSucceeded` info [Changelog] - New function `NewAPICollectionClient(string, azcore.TokenCredential, *arm.ClientOptions) (*APICollectionClient, error)` info [Changelog] - New function `*APICollectionClient.Get(context.Context, string, string, string, *APICollectionClientGetOptions) (APICollectionClientGetResponse, error)` info [Changelog] - New function `*APICollectionClient.NewListPager(string, string, *APICollectionClientListOptions) *runtime.Pager[APICollectionClientListResponse]` info [Changelog] - New function `NewAPICollectionOffboardingClient(string, azcore.TokenCredential, *arm.ClientOptions) (*APICollectionOffboardingClient, error)` info [Changelog] - New function `*APICollectionOffboardingClient.Delete(context.Context, string, string, string, *APICollectionOffboardingClientDeleteOptions) (APICollectionOffboardingClientDeleteResponse, error)` info [Changelog] - New function `NewAPICollectionOnboardingClient(string, azcore.TokenCredential, *arm.ClientOptions) (*APICollectionOnboardingClient, error)` info [Changelog] - New function `*APICollectionOnboardingClient.Create(context.Context, string, string, string, *APICollectionOnboardingClientCreateOptions) (APICollectionOnboardingClientCreateResponse, error)` info [Changelog] - New function `*GovernanceRulesClient.BeginExecute(context.Context, string, string, *GovernanceRulesClientBeginExecuteOptions) (*runtime.Poller[GovernanceRulesClientExecuteResponse], error)` info [Changelog] - New function `*GovernanceRulesClient.NewListPager(string, *GovernanceRulesClientListOptions) *runtime.Pager[GovernanceRulesClientListResponse]` info [Changelog] - New function `*GovernanceRulesClient.OperationResults(context.Context, string, string, string, *GovernanceRulesClientOperationResultsOptions) (GovernanceRulesClientOperationResultsResponse, error)` info [Changelog] - New struct `APICollectionClient` info [Changelog] - New struct `APICollectionClientListResponse` info [Changelog] - New struct `APICollectionOffboardingClient` info [Changelog] - New struct `APICollectionOnboardingClient` info [Changelog] - New struct `APICollectionProperties` info [Changelog] - New struct `APICollectionResponse` info [Changelog] - New struct `APICollectionResponseList` info [Changelog] - New struct `ErrorDetail` info [Changelog] - New struct `ErrorResponse` info [Changelog] - New struct `GovernanceRuleMetadata` info [Changelog] - New struct `GovernanceRulesClientExecuteResponse` info [Changelog] - New struct `GovernanceRulesClientListResponse` info [Changelog] - New struct `OperationResultAutoGenerated` info [Changelog] - New field `ExcludedScopes` in struct `GovernanceRuleProperties` info [Changelog] - New field `IncludeMemberScopes` in struct `GovernanceRuleProperties` info [Changelog] - New field `Metadata` in struct `GovernanceRuleProperties` info [Changelog] - New field `TenantID` in struct `GovernanceRuleProperties` info [Changelog] info [Changelog] Total 42 breaking change(s), 41 additive change(s).
️⚠️ azure-sdk-for-python-track2 warning [Detail]
⚠️Warning [Logs] Generate from 21b78617ef65699bfee734fd39540a3c928d3a4b. 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 major version of npm available! 8.19.3 -> 9.4.2 cmderr [automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.4.2> cmderr [automation_generate.sh] npm notice Run `npm install -g [email protected]` to update! cmderr [automation_generate.sh] npm notice
️✔️track2_azure-mgmt-security [View full logs] [Preview SDK Changes] Breaking Change Detectedinfo [Changelog] ### Features Added info [Changelog] info [Changelog] - Added operation GovernanceRulesOperations.begin_execute info [Changelog] - Added operation GovernanceRulesOperations.list info [Changelog] - Added operation GovernanceRulesOperations.operation_results info [Changelog] - Model GovernanceRule has a new parameter excluded_scopes info [Changelog] - Model GovernanceRule has a new parameter include_member_scopes info [Changelog] - Model GovernanceRule has a new parameter metadata info [Changelog] - Model GovernanceRule has a new parameter tenant_id info [Changelog] info [Changelog] ### Breaking Changes info [Changelog] info [Changelog] - Operation GovernanceRulesOperations.create_or_update has a new required parameter scope info [Changelog] - Operation GovernanceRulesOperations.get has a new required parameter scope info [Changelog] - Removed operation GovernanceRulesOperations.begin_rule_id_execute_single_security_connector info [Changelog] - Removed operation GovernanceRulesOperations.begin_rule_id_execute_single_subscription info [Changelog] - Removed operation group GovernanceRuleOperations info [Changelog] - Removed operation group SecurityConnectorGovernanceRuleOperations info [Changelog] - Removed operation group SecurityConnectorGovernanceRulesExecuteStatusOperations info [Changelog] - Removed operation group SecurityConnectorGovernanceRulesOperations info [Changelog] - Removed operation group SubscriptionGovernanceRulesExecuteStatusOperations info [Changelog] - Renamed operation GovernanceRulesOperations.delete to GovernanceRulesOperations.begin_delete
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
️✔️Succeeded [Logs] Generate from 21b78617ef65699bfee734fd39540a3c928d3a4b. 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
- Only show 120 items here, please refer to log for details.
️✔️@azure/arm-security [View full logs] [Preview SDK Changes] Breaking Change Detectedinfo [Changelog] - Added Interface SecurityConnectorApplicationDeleteOptionalParams info [Changelog] - Added Interface SecurityConnectorApplicationGetOptionalParams info [Changelog] - Added Interface SecurityConnectorApplicationsListNextOptionalParams info [Changelog] - Added Interface SecurityConnectorApplicationsListOptionalParams info [Changelog] - Added Interface SecurityContact info [Changelog] - Added Interface SecurityContactPropertiesAlertNotifications info [Changelog] - Added Interface SecurityContactPropertiesNotificationsByRole info [Changelog] - Added Interface SecuritySolution info [Changelog] - Added Interface SecuritySolutionsReferenceData info [Changelog] - Added Interface SecuritySubAssessment info [Changelog] - Added Interface SecurityTask info [Changelog] - Added Interface ServerVulnerabilityAssessment info [Changelog] - Added Interface ServerVulnerabilityProperties info [Changelog] - Added Interface Setting info [Changelog] - Added Interface Software info [Changelog] - Added Interface SqlServerVulnerabilityProperties info [Changelog] - Added Interface ThresholdCustomAlertRule info [Changelog] - Added Interface TimeWindowCustomAlertRule info [Changelog] - Added Interface TopologyResource info [Changelog] - Added Interface TrackedResource info [Changelog] - Added Interface TwinUpdatesNotInAllowedRange info [Changelog] - Added Interface UnauthorizedOperationsNotInAllowedRange info [Changelog] - Added Interface UpdateIotSecuritySolutionData info [Changelog] - Added Interface WorkspaceSetting info [Changelog] - Added Type Alias APICollectionGetResponse info [Changelog] - Added Type Alias APICollectionListNextResponse info [Changelog] - Added Type Alias APICollectionListResponse info [Changelog] - Added Type Alias APICollectionOnboardingCreateResponse info [Changelog] - Added Type Alias ApplicationConditionOperator info [Changelog] - Added Type Alias ApplicationCreateOrUpdateResponse info [Changelog] - Added Type Alias ApplicationGetResponse info [Changelog] - Added Type Alias ApplicationsListNextResponse info [Changelog] - Added Type Alias ApplicationsListResponse info [Changelog] - Added Type Alias ApplicationSourceResourceType info [Changelog] - Added Type Alias AwsOrganizationalDataUnion info [Changelog] - Added Type Alias ConnectionType info [Changelog] - Added Type Alias EnvironmentDataUnion info [Changelog] - Added Type Alias EnvironmentType info [Changelog] - Added Type Alias GcpOrganizationalDataUnion info [Changelog] - Added Type Alias GovernanceAssignmentsCreateOrUpdateResponse info [Changelog] - Added Type Alias GovernanceAssignmentsGetResponse info [Changelog] - Added Type Alias GovernanceAssignmentsListNextResponse info [Changelog] - Added Type Alias GovernanceAssignmentsListResponse info [Changelog] - Added Type Alias GovernanceRuleConditionOperator info [Changelog] - Added Type Alias GovernanceRuleOwnerSourceType info [Changelog] - Added Type Alias GovernanceRulesCreateOrUpdateResponse info [Changelog] - Added Type Alias GovernanceRulesExecuteResponse info [Changelog] - Added Type Alias GovernanceRulesGetResponse info [Changelog] - Added Type Alias GovernanceRulesListNextResponse info [Changelog] - Added Type Alias GovernanceRulesListResponse info [Changelog] - Added Type Alias GovernanceRulesOperationResultsResponse info [Changelog] - Added Type Alias GovernanceRuleSourceResourceType info [Changelog] - Added Type Alias GovernanceRuleType info [Changelog] - Added Type Alias MinimalSeverity info [Changelog] - Added Type Alias OperationResult info [Changelog] - Added Type Alias Roles info [Changelog] - Added Type Alias ScanningMode info [Changelog] - Added Type Alias SecurityConnectorApplicationCreateOrUpdateResponse info [Changelog] - Added Type Alias SecurityConnectorApplicationGetResponse info [Changelog] - Added Type Alias SecurityConnectorApplicationsListNextResponse info [Changelog] - Added Type Alias SecurityConnectorApplicationsListResponse info [Changelog] - Added Type Alias SubPlan info [Changelog] - Added Type Alias Type info [Changelog] - Interface AlertsSimulateOptionalParams has a new optional parameter resumeFrom info [Changelog] - Interface AlertsSimulateOptionalParams has a new optional parameter updateIntervalInMs info [Changelog] - Interface DefenderForServersAwsOfferingArcAutoProvisioning has a new optional parameter cloudRoleArn info [Changelog] - Type of parameter offeringType of interface CloudOffering is changed from "CspmMonitorAws" | "DefenderForContainersAws" | "DefenderForServersAws" | "InformationProtectionAws" to "CspmMonitorAws" | "DefenderForContainersAws" | "DefenderForServersAws" | "DefenderForDatabasesAws" | "InformationProtectionAws" | "CspmMonitorGcp" | "DefenderForServersGcp" | "DefenderForDatabasesGcp" | "DefenderForContainersGcp" | "CspmMonitorGithub" | "CspmMonitorAzureDevOps" | "DefenderCspmAws" | "DefenderCspmGcp" | "DefenderForDevOpsGithub" | "DefenderForDevOpsAzureDevOps" info [Changelog] - Added Enum KnownApplicationConditionOperator info [Changelog] - Added Enum KnownApplicationSourceResourceType info [Changelog] - Added Enum KnownEnvironmentType info [Changelog] - Added Enum KnownGovernanceRuleConditionOperator info [Changelog] - Added Enum KnownGovernanceRuleOwnerSourceType info [Changelog] - Added Enum KnownGovernanceRuleSourceResourceType info [Changelog] - Added Enum KnownGovernanceRuleType info [Changelog] - Added Enum KnownMinimalSeverity info [Changelog] - Added Enum KnownOperationResult info [Changelog] - Added Enum KnownRoles info [Changelog] - Added Enum KnownScanningMode info [Changelog] - Added Enum KnownSubPlan info [Changelog] - Added Enum KnownType info [Changelog] - Enum KnownAlertStatus has a new value InProgress info [Changelog] - Enum KnownBundleType has a new value CosmosDbs info [Changelog] - Enum KnownCloudName has a new value AzureDevOps info [Changelog] - Enum KnownCloudName has a new value Github info [Changelog] - Enum KnownOfferingType has a new value CspmMonitorAzureDevOps info [Changelog] - Enum KnownOfferingType has a new value CspmMonitorGcp info [Changelog] - Enum KnownOfferingType has a new value CspmMonitorGithub info [Changelog] - Enum KnownOfferingType has a new value DefenderCspmAws info [Changelog] - Enum KnownOfferingType has a new value DefenderCspmGcp info [Changelog] - Enum KnownOfferingType has a new value DefenderForContainersGcp info [Changelog] - Enum KnownOfferingType has a new value DefenderForDatabasesAws info [Changelog] - Enum KnownOfferingType has a new value DefenderForDatabasesGcp info [Changelog] - Enum KnownOfferingType has a new value DefenderForDevOpsAzureDevOps info [Changelog] - Enum KnownOfferingType has a new value DefenderForDevOpsGithub info [Changelog] - Enum KnownOfferingType has a new value DefenderForServersGcp info [Changelog] - Enum KnownSettingName has a new value WdatpUnifiedSolution info [Changelog] - Added function getContinuationToken info [Changelog] info [Changelog] **Breaking Changes** info [Changelog] info [Changelog] - Removed operation Alerts.simulate info [Changelog] - Removed operation SecurityContacts.update info [Changelog] - Operation AllowedConnections.get has a new signature info [Changelog] - Interface AlertsSuppressionRulesListNextOptionalParams no longer has parameter alertType info [Changelog] - Interface DefenderForServersAwsOfferingArcAutoProvisioning no longer has parameter servicePrincipalSecretMetadata info [Changelog] - Interface IotSecuritySolutionListByResourceGroupNextOptionalParams no longer has parameter filter info [Changelog] - Interface IotSecuritySolutionListBySubscriptionNextOptionalParams no longer has parameter filter info [Changelog] - Interface IotSecuritySolutionsAnalyticsAggregatedAlertListNextOptionalParams no longer has parameter top info [Changelog] - Interface IotSecuritySolutionsAnalyticsRecommendationListNextOptionalParams no longer has parameter top info [Changelog] - Interface RegulatoryComplianceAssessmentsListNextOptionalParams no longer has parameter filter info [Changelog] - Interface RegulatoryComplianceControlsListNextOptionalParams no longer has parameter filter info [Changelog] - Interface RegulatoryComplianceStandardsListNextOptionalParams no longer has parameter filter info [Changelog] - Interface SecureScoreControlsListBySecureScoreNextOptionalParams no longer has parameter expand info [Changelog] - Interface SecureScoreControlsListNextOptionalParams no longer has parameter expand info [Changelog] - Interface TasksListByHomeRegionNextOptionalParams no longer has parameter filter info [Changelog] - Interface TasksListByResourceGroupNextOptionalParams no longer has parameter filter info [Changelog] - Interface TasksListNextOptionalParams no longer has parameter filter info [Changelog] - Type of parameter value of interface ExternalSecuritySolutionList is changed from ExternalSecuritySolutionUnion[] to ExternalSecuritySolution[] info [Changelog] - Removed Enum KnownAlertNotifications info [Changelog] - Removed Enum KnownAlertsToAdmins
️⚠️ azure-sdk-for-java warning [Detail]
⚠️Warning [Logs] Generate from 21b78617ef65699bfee734fd39540a3c928d3a4b. 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 available: 22.3.1 -> 23.0 cmderr [init.sh] [notice] To update, run: pip install --upgrade pip cmderr [init.sh] [notice] A new release of pip available: 22.3.1 -> 23.0 cmderr [init.sh] [notice] To update, run: pip install --upgrade pip command ./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
️✔️azure-resourcemanager-security [View full logs] [Preview SDK Changes]
️❌ azure-resource-manager-schemas failed [Detail]
❌Failed [Logs] Generate from 21b78617ef65699bfee734fd39540a3c928d3a4b. 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] 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 warn No file changes detected after generation
❌security/resource-manager [View full logs]
️❌ azure-powershell failed [Detail]
❌Failed [Logs] Generate from 21b78617ef65699bfee734fd39540a3c928d3a4b. 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.security [View full logs] [Preview SDK Changes]
Generated ApiView
| Language | Package Name | ApiView Link |
|---|---|---|
| swagger | Microsoft.Security | Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI. |
| Go | sdk/resourcemanager/security/armsecurity | Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI. |
| Java | azure-resourcemanager-security | Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI. |
| JavaScript | @azure/arm-security | Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI. |
Thank you for your contribution rzhelenchuk! We will review the pull request and get back to you soon.
Hi, @rzhelenchuk, 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
Hi @rzhelenchuk, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.
| Task | How to fix | Priority |
|---|---|---|
| Avocado | Fix-Avocado | High |
| Semantic validation | Fix-SemanticValidation-Error | High |
| Model validation | Fix-ModelValidation-Error | High |
| LintDiff | Fix-LintDiff | high |
Hi @rzhelenchuk, one or multiple validation error/warning suppression(s) is detected in your PR. Please follow the Swagger-Suppression-Process to get approval.
Hi, @rzhelenchuk, 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
Please follow this guidance to continue the review. Thanks.
Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove ARMChangesRequested
Next Steps to Merge
Next steps that must be taken to merge this PR:- ❌ Your PR is in purview of ARM review (label:
ARMReview). Please ensure your PR is on the ARM PR review queue - see instructions in steps 1 and 2 in the PR description diagram.