Skip to content

Conversation

salambashir
Copy link
Member

@salambashir salambashir commented Aug 24, 2023

ARM (Control Plane) API Specification Update Pull Request

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

diagram

[1] ARM review queue (for merge queues, see [4])
The PRs are processed by time opened, ascending. Your PR may show up on 2nd or later page.
If you addressed Step 1 from the diagram and your PR is not showing up in the queue, ensure the label ARMChangesRequested
is removed from your PR. This should cause the label WaitForARMFeedback to be added.
[2] https://aka.ms/azsdk/support/specreview-channel
[3] List of SDK breaking changes approvers in pinned Teams announcement
[4] public repo merge queue, private repo merge queue (for ARM review queue, [1])

If you need further help with anything, see Getting help section below.

Purpose of this PR

What's the purpose of this PR? Check all that apply. This is mandatory!

  • New API version. (Such PR should have been generated with OpenAPI Hub, per this wiki doc.)
  • 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:
    • We created this Swagger after we published our API in preview. When we created the swagger we forgot to include an optional field in it. The API worked with this field (scanResultsEventGridTopicResourceId) all the time. We just noticed that it's missing from the swagger.

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:

Breaking changes review (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.

ARM API changes review (Step 2)

  • If this PR is in purview of ARM review then automation will add the ARMReview label.
  • If you want to force ARM review, add the label yourself.
  • Proceed according to the diagram at the top of this comment.

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

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Aug 24, 2023

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
Copy link

openapi-pipeline-app bot commented Aug 24, 2023

Swagger Validation Report

️❌BreakingChange: 2 Errors, 0 Warnings failed [Detail]
compared swaggers (via Oad v0.10.4)] new version base version
defenderForStorageSettings.json 2022-12-01-preview(80a8cfe) 2022-12-01-preview(main)
Rule Message
1041 - AddedPropertyInResponse The new version has a new property 'scanResultsEventGridTopicResourceId' in response that was not found in the old version.
New: Microsoft.Security/preview/2022-12-01-preview/defenderForStorageSettings.json#L163:7
Old: Microsoft.Security/preview/2022-12-01-preview/defenderForStorageSettings.json#L163:7
1045 - AddedOptionalProperty The new version has a new optional property 'scanResultsEventGridTopicResourceId' that was not found in the old version.
New: Microsoft.Security/preview/2022-12-01-preview/defenderForStorageSettings.json#L163:7
Old: Microsoft.Security/preview/2022-12-01-preview/defenderForStorageSettings.json#L163:7
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 0 Warnings warning [Detail]
compared tags (via openapi-validator v2.1.4) new version base version
package-composite-v3 package-composite-v3(80a8cfe) package-composite-v3(main)

The following errors/warnings exist before current PR submission:

Rule Message
TopLevelResourcesListBySubscription The top-level resource 'DefenderForStorageSetting' does not have list by subscription operation, please add it.
Location: Microsoft.Security/preview/2022-12-01-preview/defenderForStorageSettings.json#L124
⚠️ RequiredReadOnlySystemData The response of operation:'DefenderForStorage_Get' is defined without 'systemData'. Consider adding the systemData to the response.
Location: Microsoft.Security/preview/2022-12-01-preview/defenderForStorageSettings.json#L38
⚠️ RequiredReadOnlySystemData The response of operation:'DefenderForStorage_Create' is defined without 'systemData'. Consider adding the systemData to the response.
Location: Microsoft.Security/preview/2022-12-01-preview/defenderForStorageSettings.json#L75
⚠️ AllProxyResourcesShouldHaveDelete The resource DefenderForStorageSetting does not have a corresponding delete operation.
Location: Microsoft.Security/preview/2022-12-01-preview/defenderForStorageSettings.json#L124
️⚠️Avocado: 1 Warnings warning [Detail]
Rule Message
⚠️ 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
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Aug 24, 2023

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-js - @azure/arm-security - Approved - 6.0.0-beta.5
+	Class SecurityCenter has a new signature
+	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 succeeded [Detail] [Expand]
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs]Release - Generate from b09b155. SDK Automation 14.0.0
    command	sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
    command	generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
  • ️✔️sdk/resourcemanager/security/armsecurity [View full logs]  [Release SDK Changes] Breaking Change Detected
    Only show 120 items here, please refer to log for details.
    info	[Changelog] - New enum type `ServerVulnerabilityAssessmentsAzureSettingSelectedProvider` with values `ServerVulnerabilityAssessmentsAzureSettingSelectedProviderMdeTvm`
    info	[Changelog] - New enum type `ServerVulnerabilityAssessmentsSettingKind` with values `ServerVulnerabilityAssessmentsSettingKindAzureServersSetting`
    info	[Changelog] - New enum type `ServerVulnerabilityAssessmentsSettingKindName` with values `ServerVulnerabilityAssessmentsSettingKindNameAzureServersSetting`
    info	[Changelog] - New enum type `SettingNameAutoGenerated` with values `SettingNameAutoGeneratedCurrent`
    info	[Changelog] - New function `NewAzureDevOpsOrgsClient(string, azcore.TokenCredential, *arm.ClientOptions) (*AzureDevOpsOrgsClient, error)`
    info	[Changelog] - New function `*AzureDevOpsOrgsClient.BeginCreateOrUpdate(context.Context, string, string, string, AzureDevOpsOrg, *AzureDevOpsOrgsClientBeginCreateOrUpdateOptions) (*runtime.Poller[AzureDevOpsOrgsClientCreateOrUpdateResponse], error)`
    info	[Changelog] - New function `*AzureDevOpsOrgsClient.Get(context.Context, string, string, string, *AzureDevOpsOrgsClientGetOptions) (AzureDevOpsOrgsClientGetResponse, error)`
    info	[Changelog] - New function `*AzureDevOpsOrgsClient.ListAvailable(context.Context, string, string, *AzureDevOpsOrgsClientListAvailableOptions) (AzureDevOpsOrgsClientListAvailableResponse, error)`
    info	[Changelog] - New function `*AzureDevOpsOrgsClient.NewListPager(string, string, *AzureDevOpsOrgsClientListOptions) *runtime.Pager[AzureDevOpsOrgsClientListResponse]`
    info	[Changelog] - New function `*AzureDevOpsOrgsClient.BeginUpdate(context.Context, string, string, string, AzureDevOpsOrg, *AzureDevOpsOrgsClientBeginUpdateOptions) (*runtime.Poller[AzureDevOpsOrgsClientUpdateResponse], error)`
    info	[Changelog] - New function `NewAzureDevOpsProjectsClient(string, azcore.TokenCredential, *arm.ClientOptions) (*AzureDevOpsProjectsClient, error)`
    info	[Changelog] - New function `*AzureDevOpsProjectsClient.BeginCreateOrUpdate(context.Context, string, string, string, string, AzureDevOpsProject, *AzureDevOpsProjectsClientBeginCreateOrUpdateOptions) (*runtime.Poller[AzureDevOpsProjectsClientCreateOrUpdateResponse], error)`
    info	[Changelog] - New function `*AzureDevOpsProjectsClient.Get(context.Context, string, string, string, string, *AzureDevOpsProjectsClientGetOptions) (AzureDevOpsProjectsClientGetResponse, error)`
    info	[Changelog] - New function `*AzureDevOpsProjectsClient.NewListPager(string, string, string, *AzureDevOpsProjectsClientListOptions) *runtime.Pager[AzureDevOpsProjectsClientListResponse]`
    info	[Changelog] - New function `*AzureDevOpsProjectsClient.BeginUpdate(context.Context, string, string, string, string, AzureDevOpsProject, *AzureDevOpsProjectsClientBeginUpdateOptions) (*runtime.Poller[AzureDevOpsProjectsClientUpdateResponse], error)`
    info	[Changelog] - New function `NewAzureDevOpsReposClient(string, azcore.TokenCredential, *arm.ClientOptions) (*AzureDevOpsReposClient, error)`
    info	[Changelog] - New function `*AzureDevOpsReposClient.BeginCreateOrUpdate(context.Context, string, string, string, string, string, AzureDevOpsRepository, *AzureDevOpsReposClientBeginCreateOrUpdateOptions) (*runtime.Poller[AzureDevOpsReposClientCreateOrUpdateResponse], error)`
    info	[Changelog] - New function `*AzureDevOpsReposClient.Get(context.Context, string, string, string, string, string, *AzureDevOpsReposClientGetOptions) (AzureDevOpsReposClientGetResponse, error)`
    info	[Changelog] - New function `*AzureDevOpsReposClient.NewListPager(string, string, string, string, *AzureDevOpsReposClientListOptions) *runtime.Pager[AzureDevOpsReposClientListResponse]`
    info	[Changelog] - New function `*AzureDevOpsReposClient.BeginUpdate(context.Context, string, string, string, string, string, AzureDevOpsRepository, *AzureDevOpsReposClientBeginUpdateOptions) (*runtime.Poller[AzureDevOpsReposClientUpdateResponse], error)`
    info	[Changelog] - New function `*AzureServersSetting.GetServerVulnerabilityAssessmentsSetting() *ServerVulnerabilityAssessmentsSetting`
    info	[Changelog] - New function `*ClientFactory.NewAzureDevOpsOrgsClient() *AzureDevOpsOrgsClient`
    info	[Changelog] - New function `*ClientFactory.NewAzureDevOpsProjectsClient() *AzureDevOpsProjectsClient`
    info	[Changelog] - New function `*ClientFactory.NewAzureDevOpsReposClient() *AzureDevOpsReposClient`
    info	[Changelog] - New function `*ClientFactory.NewDefenderForStorageClient() *DefenderForStorageClient`
    info	[Changelog] - New function `*ClientFactory.NewDevOpsConfigurationsClient() *DevOpsConfigurationsClient`
    info	[Changelog] - New function `*ClientFactory.NewDevOpsOperationResultsClient() *DevOpsOperationResultsClient`
    info	[Changelog] - New function `*ClientFactory.NewGitHubOwnersClient() *GitHubOwnersClient`
    info	[Changelog] - New function `*ClientFactory.NewGitHubReposClient() *GitHubReposClient`
    info	[Changelog] - New function `*ClientFactory.NewGitLabGroupsClient() *GitLabGroupsClient`
    info	[Changelog] - New function `*ClientFactory.NewGitLabProjectsClient() *GitLabProjectsClient`
    info	[Changelog] - New function `*ClientFactory.NewGitLabSubgroupsClient() *GitLabSubgroupsClient`
    info	[Changelog] - New function `*ClientFactory.NewServerVulnerabilityAssessmentsSettingsClient() *ServerVulnerabilityAssessmentsSettingsClient`
    info	[Changelog] - New function `NewDefenderForStorageClient(azcore.TokenCredential, *arm.ClientOptions) (*DefenderForStorageClient, error)`
    info	[Changelog] - New function `*DefenderForStorageClient.Create(context.Context, string, SettingNameAutoGenerated, DefenderForStorageSetting, *DefenderForStorageClientCreateOptions) (DefenderForStorageClientCreateResponse, error)`
    info	[Changelog] - New function `*DefenderForStorageClient.Get(context.Context, string, SettingNameAutoGenerated, *DefenderForStorageClientGetOptions) (DefenderForStorageClientGetResponse, error)`
    info	[Changelog] - New function `NewDevOpsConfigurationsClient(string, azcore.TokenCredential, *arm.ClientOptions) (*DevOpsConfigurationsClient, error)`
    info	[Changelog] - New function `*DevOpsConfigurationsClient.BeginCreateOrUpdate(context.Context, string, string, DevOpsConfiguration, *DevOpsConfigurationsClientBeginCreateOrUpdateOptions) (*runtime.Poller[DevOpsConfigurationsClientCreateOrUpdateResponse], error)`
    info	[Changelog] - New function `*DevOpsConfigurationsClient.BeginDelete(context.Context, string, string, *DevOpsConfigurationsClientBeginDeleteOptions) (*runtime.Poller[DevOpsConfigurationsClientDeleteResponse], error)`
    info	[Changelog] - New function `*DevOpsConfigurationsClient.Get(context.Context, string, string, *DevOpsConfigurationsClientGetOptions) (DevOpsConfigurationsClientGetResponse, error)`
    info	[Changelog] - New function `*DevOpsConfigurationsClient.NewListPager(string, string, *DevOpsConfigurationsClientListOptions) *runtime.Pager[DevOpsConfigurationsClientListResponse]`
    info	[Changelog] - New function `*DevOpsConfigurationsClient.BeginUpdate(context.Context, string, string, DevOpsConfiguration, *DevOpsConfigurationsClientBeginUpdateOptions) (*runtime.Poller[DevOpsConfigurationsClientUpdateResponse], error)`
    info	[Changelog] - New function `NewDevOpsOperationResultsClient(string, azcore.TokenCredential, *arm.ClientOptions) (*DevOpsOperationResultsClient, error)`
    info	[Changelog] - New function `*DevOpsOperationResultsClient.Get(context.Context, string, string, string, *DevOpsOperationResultsClientGetOptions) (DevOpsOperationResultsClientGetResponse, error)`
    info	[Changelog] - New function `NewGitHubOwnersClient(string, azcore.TokenCredential, *arm.ClientOptions) (*GitHubOwnersClient, error)`
    info	[Changelog] - New function `*GitHubOwnersClient.Get(context.Context, string, string, string, *GitHubOwnersClientGetOptions) (GitHubOwnersClientGetResponse, error)`
    info	[Changelog] - New function `*GitHubOwnersClient.ListAvailable(context.Context, string, string, *GitHubOwnersClientListAvailableOptions) (GitHubOwnersClientListAvailableResponse, error)`
    info	[Changelog] - New function `*GitHubOwnersClient.NewListPager(string, string, *GitHubOwnersClientListOptions) *runtime.Pager[GitHubOwnersClientListResponse]`
    info	[Changelog] - New function `NewGitHubReposClient(string, azcore.TokenCredential, *arm.ClientOptions) (*GitHubReposClient, error)`
    info	[Changelog] - New function `*GitHubReposClient.Get(context.Context, string, string, string, string, *GitHubReposClientGetOptions) (GitHubReposClientGetResponse, error)`
    info	[Changelog] - New function `*GitHubReposClient.NewListPager(string, string, string, *GitHubReposClientListOptions) *runtime.Pager[GitHubReposClientListResponse]`
    info	[Changelog] - New function `NewGitLabGroupsClient(string, azcore.TokenCredential, *arm.ClientOptions) (*GitLabGroupsClient, error)`
    info	[Changelog] - New function `*GitLabGroupsClient.Get(context.Context, string, string, string, *GitLabGroupsClientGetOptions) (GitLabGroupsClientGetResponse, error)`
    info	[Changelog] - New function `*GitLabGroupsClient.ListAvailable(context.Context, string, string, *GitLabGroupsClientListAvailableOptions) (GitLabGroupsClientListAvailableResponse, error)`
    info	[Changelog] - New function `*GitLabGroupsClient.NewListPager(string, string, *GitLabGroupsClientListOptions) *runtime.Pager[GitLabGroupsClientListResponse]`
    info	[Changelog] - New function `NewGitLabProjectsClient(string, azcore.TokenCredential, *arm.ClientOptions) (*GitLabProjectsClient, error)`
    info	[Changelog] - New function `*GitLabProjectsClient.Get(context.Context, string, string, string, string, *GitLabProjectsClientGetOptions) (GitLabProjectsClientGetResponse, error)`
    info	[Changelog] - New function `*GitLabProjectsClient.NewListPager(string, string, string, *GitLabProjectsClientListOptions) *runtime.Pager[GitLabProjectsClientListResponse]`
    info	[Changelog] - New function `NewGitLabSubgroupsClient(string, azcore.TokenCredential, *arm.ClientOptions) (*GitLabSubgroupsClient, error)`
    info	[Changelog] - New function `*GitLabSubgroupsClient.List(context.Context, string, string, string, *GitLabSubgroupsClientListOptions) (GitLabSubgroupsClientListResponse, error)`
    info	[Changelog] - New function `*HealthReportsClient.Get(context.Context, string, string, *HealthReportsClientGetOptions) (HealthReportsClientGetResponse, error)`
    info	[Changelog] - New function `PossibleServerVulnerabilityAssessmentsSettingKindValues() []ServerVulnerabilityAssessmentsSettingKind`
    info	[Changelog] - New function `*ServerVulnerabilityAssessmentsSetting.GetServerVulnerabilityAssessmentsSetting() *ServerVulnerabilityAssessmentsSetting`
    info	[Changelog] - New function `NewServerVulnerabilityAssessmentsSettingsClient(string, azcore.TokenCredential, *arm.ClientOptions) (*ServerVulnerabilityAssessmentsSettingsClient, error)`
    info	[Changelog] - New function `*ServerVulnerabilityAssessmentsSettingsClient.CreateOrUpdate(context.Context, ServerVulnerabilityAssessmentsSettingKindName, ServerVulnerabilityAssessmentsSettingClassification, *ServerVulnerabilityAssessmentsSettingsClientCreateOrUpdateOptions) (ServerVulnerabilityAssessmentsSettingsClientCreateOrUpdateResponse, error)`
    info	[Changelog] - New function `*ServerVulnerabilityAssessmentsSettingsClient.Delete(context.Context, ServerVulnerabilityAssessmentsSettingKindName, *ServerVulnerabilityAssessmentsSettingsClientDeleteOptions) (ServerVulnerabilityAssessmentsSettingsClientDeleteResponse, error)`
    info	[Changelog] - New function `*ServerVulnerabilityAssessmentsSettingsClient.Get(context.Context, ServerVulnerabilityAssessmentsSettingKindName, *ServerVulnerabilityAssessmentsSettingsClientGetOptions) (ServerVulnerabilityAssessmentsSettingsClientGetResponse, error)`
    info	[Changelog] - New function `*ServerVulnerabilityAssessmentsSettingsClient.NewListBySubscriptionPager(*ServerVulnerabilityAssessmentsSettingsClientListBySubscriptionOptions) *runtime.Pager[ServerVulnerabilityAssessmentsSettingsClientListBySubscriptionResponse]`
    info	[Changelog] - New struct `ActionableRemediation`
    info	[Changelog] - New struct `Authorization`
    info	[Changelog] - New struct `AzureDevOpsOrg`
    info	[Changelog] - New struct `AzureDevOpsOrgListResponse`
    info	[Changelog] - New struct `AzureDevOpsOrgProperties`
    info	[Changelog] - New struct `AzureDevOpsOrganizationConfiguration`
    info	[Changelog] - New struct `AzureDevOpsProject`
    info	[Changelog] - New struct `AzureDevOpsProjectConfiguration`
    info	[Changelog] - New struct `AzureDevOpsProjectListResponse`
    info	[Changelog] - New struct `AzureDevOpsProjectProperties`
    info	[Changelog] - New struct `AzureDevOpsRepository`
    info	[Changelog] - New struct `AzureDevOpsRepositoryListResponse`
    info	[Changelog] - New struct `AzureDevOpsRepositoryProperties`
    info	[Changelog] - New struct `AzureServersSetting`
    info	[Changelog] - New struct `BaseResourceConfiguration`
    info	[Changelog] - New struct `CategoryConfiguration`
    info	[Changelog] - New struct `DefenderForStorageSetting`
    info	[Changelog] - New struct `DefenderForStorageSettingProperties`
    info	[Changelog] - New struct `DevOpsConfiguration`
    info	[Changelog] - New struct `DevOpsConfigurationListResponse`
    info	[Changelog] - New struct `DevOpsConfigurationProperties`
    info	[Changelog] - New struct `ErrorDetailAutoGenerated2`
    info	[Changelog] - New struct `ErrorResponseAutoGenerated2`
    info	[Changelog] - New struct `GitHubOwner`
    info	[Changelog] - New struct `GitHubOwnerConfiguration`
    info	[Changelog] - New struct `GitHubOwnerListResponse`
    info	[Changelog] - New struct `GitHubOwnerProperties`
    info	[Changelog] - New struct `GitHubRepository`
    info	[Changelog] - New struct `GitHubRepositoryListResponse`
    info	[Changelog] - New struct `GitHubRepositoryProperties`
    info	[Changelog] - New struct `GitLabGroup`
    info	[Changelog] - New struct `GitLabGroupConfiguration`
    info	[Changelog] - New struct `GitLabGroupListResponse`
    info	[Changelog] - New struct `GitLabGroupProperties`
    info	[Changelog] - New struct `GitLabProject`
    info	[Changelog] - New struct `GitLabProjectListResponse`
    info	[Changelog] - New struct `GitLabProjectProperties`
    info	[Changelog] - New struct `MalwareScanningProperties`
    info	[Changelog] - New struct `OnUploadProperties`
    info	[Changelog] - New struct `OperationStatusAutoGenerated`
    info	[Changelog] - New struct `OperationStatusResult`
    info	[Changelog] - New struct `ProxyResource`
    info	[Changelog] - New struct `ResourceAutoGenerated`
    info	[Changelog] - New struct `ResourceAutoGenerated2`
    info	[Changelog] - New struct `SensitiveDataDiscoveryProperties`
    info	[Changelog] - New struct `ServerVulnerabilityAssessmentsAzureSettingProperties`
    info	[Changelog] - New struct `ServerVulnerabilityAssessmentsSettingsList`
    info	[Changelog] - New struct `TargetBranchConfiguration`
    info	[Changelog] - New field `AffectedDefendersSubPlans`, `ReportAdditionalData` in struct `HealthReportProperties`
    info	[Changelog] - New field `LastScannedDate`, `Reason` in struct `StatusAutoGenerated`
    info	[Changelog]
    info	[Changelog] Total 5 breaking change(s), 208 additive change(s).
️⚠️ azure-sdk-for-python-track2 warning [Detail]
  • ⚠️Warning [Logs]Release - Generate from b09b155. SDK Automation 14.0.0
    command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
    cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
    command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
    cmderr	[automation_generate.sh] notice
    cmderr	[automation_generate.sh]  New major version of npm available! 9.6.7 -> 10.1.0
    cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.1.0>
    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]  [Release SDK Changes]
    info	[Changelog]
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs]Release - Generate from b09b155. SDK Automation 14.0.0
    command	sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json
    warn	File azure-sdk-for-js_tmp/initOutput.json not found to read
    command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json
  • ️✔️@azure/arm-security [View full logs]  [Release SDK Changes] Breaking Change Detected
    Only show 120 items here, please refer to log for details.
    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 HealthReportsGetResponse
    info	[Changelog]   - Added Type Alias HealthReportsListNextResponse
    info	[Changelog]   - Added Type Alias HealthReportsListResponse
    info	[Changelog]   - Added Type Alias InheritFromParentState
    info	[Changelog]   - Added Type Alias IsEnabled
    info	[Changelog]   - Added Type Alias MinimalSeverity
    info	[Changelog]   - Added Type Alias MipIntegrationStatus
    info	[Changelog]   - Added Type Alias OnboardingState
    info	[Changelog]   - Added Type Alias OperationResult
    info	[Changelog]   - Added Type Alias Roles
    info	[Changelog]   - Added Type Alias RuleCategory
    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 SecurityOperatorsCreateOrUpdateResponse
    info	[Changelog]   - Added Type Alias SecurityOperatorsGetResponse
    info	[Changelog]   - Added Type Alias SecurityOperatorsListResponse
    info	[Changelog]   - Added Type Alias SensitivitySettingsListResponse
    info	[Changelog]   - Added Type Alias ServerVulnerabilityAssessmentsAzureSettingSelectedProvider
    info	[Changelog]   - Added Type Alias ServerVulnerabilityAssessmentsSettingKind
    info	[Changelog]   - Added Type Alias ServerVulnerabilityAssessmentsSettingKindName
    info	[Changelog]   - Added Type Alias ServerVulnerabilityAssessmentsSettingsCreateOrUpdateResponse
    info	[Changelog]   - Added Type Alias ServerVulnerabilityAssessmentsSettingsGetResponse
    info	[Changelog]   - Added Type Alias ServerVulnerabilityAssessmentsSettingsListBySubscriptionNextResponse
    info	[Changelog]   - Added Type Alias ServerVulnerabilityAssessmentsSettingsListBySubscriptionResponse
    info	[Changelog]   - Added Type Alias ServerVulnerabilityAssessmentsSettingUnion
    info	[Changelog]   - Added Type Alias SettingNameAutoGenerated
    info	[Changelog]   - Added Type Alias StatusName
    info	[Changelog]   - Added Type Alias SubPlan
    info	[Changelog]   - Added Type Alias Type
    info	[Changelog]   - Added Type Alias UpdateSensitivitySettingsResponse
    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]   - Interface DefenderForServersAwsOfferingArcAutoProvisioning has a new optional parameter configuration
    info	[Changelog]   - Interface ScanProperties has a new optional parameter lastScanTime
    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" | "CspmMonitorGitLab" | "DefenderForDevOpsGitLab"
    info	[Changelog]   - Added Enum KnownActionableRemediationState
    info	[Changelog]   - Added Enum KnownAnnotateDefaultBranchState
    info	[Changelog]   - Added Enum KnownApplicationConditionOperator
    info	[Changelog]   - Added Enum KnownApplicationSourceResourceType
    info	[Changelog]   - Added Enum KnownAutoDiscovery
    info	[Changelog]   - Added Enum KnownCode
    info	[Changelog]   - Added Enum KnownDesiredOnboardingState
    info	[Changelog]   - Added Enum KnownDevOpsProvisioningState
    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 KnownInheritFromParentState
    info	[Changelog]   - Added Enum KnownIsEnabled
    info	[Changelog]   - Added Enum KnownMinimalSeverity
    info	[Changelog]   - Added Enum KnownMipIntegrationStatus
    info	[Changelog]   - Added Enum KnownOnboardingState
    info	[Changelog]   - Added Enum KnownOperationResult
    info	[Changelog]   - Added Enum KnownRoles
    info	[Changelog]   - Added Enum KnownRuleCategory
    info	[Changelog]   - Added Enum KnownScanningMode
    info	[Changelog]   - Added Enum KnownServerVulnerabilityAssessmentsAzureSettingSelectedProvider
    info	[Changelog]   - Added Enum KnownServerVulnerabilityAssessmentsSettingKind
    info	[Changelog]   - Added Enum KnownServerVulnerabilityAssessmentsSettingKindName
    info	[Changelog]   - Added Enum KnownSettingNameAutoGenerated
    info	[Changelog]   - Added Enum KnownStatusName
    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 KnownCloudName has a new value GitLab
    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 CspmMonitorGitLab
    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 DefenderForDevOpsGitLab
    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]   - Class SecurityCenter 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]Release - Generate from b09b155. SDK Automation 14.0.0
    command	./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.2.1
    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.2.1
    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]  [Release SDK Changes]
️⚠️ azure-resource-manager-schemas warning [Detail]
  • ⚠️Warning [Logs]Release - Generate from b09b155. Schema Automation 14.0.0
    command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
    cmderr	[initScript.sh] npm notice
    cmderr	[initScript.sh] npm notice New major version of npm available! 8.19.4 -> 10.1.0
    cmderr	[initScript.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.1.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
  • ️✔️security [View full logs]  [Release Schema Changes]
️❌ azure-powershell failed [Detail]
  • Pipeline Framework Failed [Logs]Release - Generate from b09b155. SDK Automation 14.0.0
    command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
    command	pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json
    SSL error: syscall failure: Broken pipe
    Error: SSL error: syscall failure: Broken pipe
  • ⚠️Az.security.DefaultTag [View full logs
    error	Fatal error: SSL error: syscall failure: Broken pipe
    error	The following packages are still pending:
    error		Az.security.DefaultTag
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Aug 24, 2023

Generated ApiView

Language Package Name ApiView Link
Go sdk/resourcemanager/security/armsecurity https://apiview.dev/Assemblies/Review/e1c54337f34e45448e5ef3ef8da3c774
Java azure-resourcemanager-security https://apiview.dev/Assemblies/Review/e5951414097344a781ec8475db717511
JavaScript @azure/arm-security https://apiview.dev/Assemblies/Review/bca55a884e1c45eaa98e49d4a73f97aa
.Net Azure.ResourceManager.SecurityCenter https://apiview.dev/Assemblies/Review/b5b2d43b65634af39787de4335f0e2f5

@AzureRestAPISpecReview AzureRestAPISpecReview added ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review NewApiVersionRequired ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Aug 24, 2023
@openapi-workflow-bot
Copy link

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.

@salambashir
Copy link
Member Author

salambashir commented Aug 24, 2023

Hi @rkmanda ,
We created this Swagger after we published our API in preview. When we created the swagger we forgot to include an optional field in it. The API worked with this field (scanResultsEventGridTopicResourceId) all the time. We just noticed that it's missing from the swagger.
We still don't have any Clients built on this swagger since our service is still in preview.

@salambashir salambashir added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Aug 24, 2023
@openapi-workflow-bot openapi-workflow-bot bot removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Aug 24, 2023
@mikekistler mikekistler added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Aug 30, 2023
@mentat9 mentat9 added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Sep 7, 2023
@openapi-workflow-bot openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Sep 7, 2023
@msyyc
Copy link
Member

msyyc commented Sep 8, 2023

/azp run

@azure-pipelines
Copy link

Azure Pipelines successfully started running 2 pipeline(s).

@msyyc
Copy link
Member

msyyc commented Sep 11, 2023

/azp run

@azure-pipelines
Copy link

Azure Pipelines successfully started running 2 pipeline(s).

@salambashir
Copy link
Member Author

/pr RequestMerge

@rkmanda rkmanda merged commit b09b155 into Azure:main Sep 12, 2023
@openapi-pipeline-app
Copy link

Swagger pipeline restarted successfully, please wait for status update in this comment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go Approved-SdkBreakingChange-JavaScript ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review CI-BreakingChange-Go CI-BreakingChange-JavaScript NewApiVersionRequired ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants