Skip to content

Fix creds scan error, remove real object id from sample file.#24410

Merged
chunyu3 merged 1 commit intoAzure:release-Sentinel-2023-06-01-previewfrom
nazang:release-Sentinel-2023-06-01-preview
Jun 14, 2023
Merged

Fix creds scan error, remove real object id from sample file.#24410
chunyu3 merged 1 commit intoAzure:release-Sentinel-2023-06-01-previewfrom
nazang:release-Sentinel-2023-06-01-preview

Conversation

@nazang
Copy link
Contributor

@nazang nazang commented Jun 13, 2023

ARM API Information (Control Plane)

Changelog

Add a changelog entry for this PR by answering the following questions:

  1. What's the purpose of the update?
    • new service onboarding
    • new API version
    • update existing version for new feature
    • [ X] update existing version to fix swagger quality issue in s360
    • Other, please clarify
  2. 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.
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
  4. 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):

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Applicability: ⚠️

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. Note that this doesn't apply if you are trying to merge a PR that was previously in the private repository.
  • 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.

@openapi-workflow-bot
Copy link

Hi, @nazang Thanks for your PR. I am workflow bot for review process. Here are some small tips.

  • Please ensure to do self-check against checklists in first PR comment.
  • PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.
  • For specs comparison cross API versions, Use API Specs Comparison Report Generator
  • If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

  • Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jun 13, 2023

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️LintDiff succeeded [Detail] [Expand]
    Validation passes for LintDiff.
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️SwaggerAPIView succeeded [Detail] [Expand]
    ️️✔️CadlAPIView succeeded [Detail] [Expand]
    ️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️️✔️PrettierCheck succeeded [Detail] [Expand]
    Validation passes for PrettierCheck.
    ️️✔️SpellCheck succeeded [Detail] [Expand]
    Validation passes for SpellCheck.
    ️️✔️CadlValidation succeeded [Detail] [Expand]
    Validation passes for CadlValidation.
    ️️✔️TypeSpec Validation succeeded [Detail] [Expand]
    Validation passes for TypeSpec Validation.
    ️️✔️PR Summary succeeded [Detail] [Expand]
    Validation passes for Summary.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jun 13, 2023

    Swagger Generation Artifacts

    ️️✔️ApiDocPreview succeeded [Detail] [Expand]
    ️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

    Breaking Changes Tracking

    ️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from 27053f2140455de0ef7c21ed749b07d383501b3e. SDK Automation 14.0.0
      command	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.SecurityInsights [View full logs]  [Preview SDK Changes]
      info	[Changelog]
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs] Generate from 27053f2140455de0ef7c21ed749b07d383501b3e. 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]
      cmderr	[automation_generate.sh] npm notice New minor version of npm available! 9.5.1 -> 9.7.1
      cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.7.1>
      cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@9.7.1` to update!
      cmderr	[automation_generate.sh] npm notice
    • ️✔️track2_azure-mgmt-securityinsight [View full logs]  [Preview SDK Changes] Breaking Change Detected
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog]   - Added operation EntitiesOperations.run_playbook
      info	[Changelog]   - Added operation group AlertRuleOperations
      info	[Changelog]   - Added operation group BillingStatisticsOperations
      info	[Changelog]   - Added operation group ContentPackageOperations
      info	[Changelog]   - Added operation group ContentPackagesOperations
      info	[Changelog]   - Added operation group ContentTemplateOperations
      info	[Changelog]   - Added operation group ContentTemplatesOperations
      info	[Changelog]   - Added operation group GetTriggeredAnalyticsRuleRunsOperations
      info	[Changelog]   - Added operation group HuntCommentsOperations
      info	[Changelog]   - Added operation group HuntRelationsOperations
      info	[Changelog]   - Added operation group HuntsOperations
      info	[Changelog]   - Added operation group ProductPackageOperations
      info	[Changelog]   - Added operation group ProductPackagesOperations
      info	[Changelog]   - Added operation group ProductTemplateOperations
      info	[Changelog]   - Added operation group ProductTemplatesOperations
      info	[Changelog]   - Added operation group TriggeredAnalyticsRuleRunOperations
      info	[Changelog]   - Added operation group WorkspaceManagerAssignmentJobsOperations
      info	[Changelog]   - Added operation group WorkspaceManagerAssignmentsOperations
      info	[Changelog]   - Added operation group WorkspaceManagerConfigurationsOperations
      info	[Changelog]   - Added operation group WorkspaceManagerGroupsOperations
      info	[Changelog]   - Added operation group WorkspaceManagerMembersOperations
      info	[Changelog]   - Model MTPDataConnector has a new parameter filtered_providers
      info	[Changelog]   - Model MTPDataConnectorDataTypes has a new parameter alerts
      info	[Changelog]   - Model MTPDataConnectorProperties has a new parameter filtered_providers
      info	[Changelog]   - Model SourceControl has a new parameter pull_request
      info	[Changelog]   - Model SourceControl has a new parameter repository_access
      info	[Changelog]   - Model SourceControl has a new parameter service_principal
      info	[Changelog]
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog]   - Model MSTIDataConnectorDataTypes no longer has parameter bing_safety_phishing_url
      info	[Changelog]   - Model Repository no longer has parameter path_mapping
      info	[Changelog]   - Operation SourceControlsOperations.delete has a new required parameter repository_access
      info	[Changelog]   - Parameter branch of model Repository is now required
      info	[Changelog]   - Parameter logic_app_resource_id of model PlaybookActionProperties is now required
      info	[Changelog]   - Parameter url of model Repository is now required
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from 27053f2140455de0ef7c21ed749b07d383501b3e. 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-securityinsight [View full logs]  [Preview SDK Changes] Breaking Change Detected
      Only show 120 items here, please refer to log for details.
      info	[Changelog]   - Type of parameter additionalData of interface EntityCommonProperties is changed from {
      info	[Changelog]         [propertyName: string]: Record<string, unknown>;
      info	[Changelog]     } to {
      info	[Changelog]         [propertyName: string]: any;
      info	[Changelog]     }
      info	[Changelog]   - Type of parameter additionalData of interface EntityEdges is changed from {
      info	[Changelog]         [propertyName: string]: Record<string, unknown>;
      info	[Changelog]     } to {
      info	[Changelog]         [propertyName: string]: any;
      info	[Changelog]     }
      info	[Changelog]   - Type of parameter kind of interface EntityQueriesListOptionalParams is changed from Enum13 to Enum20
      info	[Changelog]   - Type of parameter entityKind of interface ExpansionResultAggregation is changed from EntityKind to EntityKindEnum
      info	[Changelog]   - Type of parameter additionalData of interface FileEntity is changed from {
      info	[Changelog]         [propertyName: string]: Record<string, unknown>;
      info	[Changelog]     } to {
      info	[Changelog]         [propertyName: string]: any;
      info	[Changelog]     }
      info	[Changelog]   - Type of parameter additionalData of interface FileHashEntity is changed from {
      info	[Changelog]         [propertyName: string]: Record<string, unknown>;
      info	[Changelog]     } to {
      info	[Changelog]         [propertyName: string]: any;
      info	[Changelog]     }
      info	[Changelog]   - Type of parameter additionalData of interface HostEntity is changed from {
      info	[Changelog]         [propertyName: string]: Record<string, unknown>;
      info	[Changelog]     } to {
      info	[Changelog]         [propertyName: string]: any;
      info	[Changelog]     }
      info	[Changelog]   - Type of parameter additionalData of interface HuntingBookmark is changed from {
      info	[Changelog]         [propertyName: string]: Record<string, unknown>;
      info	[Changelog]     } to {
      info	[Changelog]         [propertyName: string]: any;
      info	[Changelog]     }
      info	[Changelog]   - Type of parameter entityKind of interface IncidentEntitiesResultsMetadata is changed from EntityKind to EntityKindEnum
      info	[Changelog]   - Type of parameter additionalData of interface IoTDeviceEntity is changed from {
      info	[Changelog]         [propertyName: string]: Record<string, unknown>;
      info	[Changelog]     } to {
      info	[Changelog]         [propertyName: string]: any;
      info	[Changelog]     }
      info	[Changelog]   - Type of parameter additionalData of interface IpEntity is changed from {
      info	[Changelog]         [propertyName: string]: Record<string, unknown>;
      info	[Changelog]     } to {
      info	[Changelog]         [propertyName: string]: any;
      info	[Changelog]     }
      info	[Changelog]   - Type of parameter additionalData of interface MailboxEntity is changed from {
      info	[Changelog]         [propertyName: string]: Record<string, unknown>;
      info	[Changelog]     } to {
      info	[Changelog]         [propertyName: string]: any;
      info	[Changelog]     }
      info	[Changelog]   - Type of parameter additionalData of interface MailClusterEntity is changed from {
      info	[Changelog]         [propertyName: string]: Record<string, unknown>;
      info	[Changelog]     } to {
      info	[Changelog]         [propertyName: string]: any;
      info	[Changelog]     }
      info	[Changelog]   - Type of parameter additionalData of interface MailMessageEntity is changed from {
      info	[Changelog]         [propertyName: string]: Record<string, unknown>;
      info	[Changelog]     } to {
      info	[Changelog]         [propertyName: string]: any;
      info	[Changelog]     }
      info	[Changelog]   - Type of parameter additionalData of interface MalwareEntity is changed from {
      info	[Changelog]         [propertyName: string]: Record<string, unknown>;
      info	[Changelog]     } to {
      info	[Changelog]         [propertyName: string]: any;
      info	[Changelog]     }
      info	[Changelog]   - Type of parameter dependencies of interface MetadataModel is changed from MetadataDependencies to MetadataDependenciesAutoGenerated
      info	[Changelog]   - Type of parameter kind of interface MetadataModel is changed from Kind to string
      info	[Changelog]   - Type of parameter dependencies of interface MetadataPatch is changed from MetadataDependencies to MetadataDependenciesAutoGenerated
      info	[Changelog]   - Type of parameter kind of interface MetadataPatch is changed from Kind to string
      info	[Changelog]   - Type of parameter additionalData of interface NicEntity is changed from {
      info	[Changelog]         [propertyName: string]: Record<string, unknown>;
      info	[Changelog]     } to {
      info	[Changelog]         [propertyName: string]: any;
      info	[Changelog]     }
      info	[Changelog]   - Type of parameter additionalData of interface ProcessEntity is changed from {
      info	[Changelog]         [propertyName: string]: Record<string, unknown>;
      info	[Changelog]     } to {
      info	[Changelog]         [propertyName: string]: any;
      info	[Changelog]     }
      info	[Changelog]   - Type of parameter additionalData of interface RegistryKeyEntity is changed from {
      info	[Changelog]         [propertyName: string]: Record<string, unknown>;
      info	[Changelog]     } to {
      info	[Changelog]         [propertyName: string]: any;
      info	[Changelog]     }
      info	[Changelog]   - Type of parameter additionalData of interface RegistryValueEntity is changed from {
      info	[Changelog]         [propertyName: string]: Record<string, unknown>;
      info	[Changelog]     } to {
      info	[Changelog]         [propertyName: string]: any;
      info	[Changelog]     }
      info	[Changelog]   - Type of parameter additionalData of interface SecurityAlert is changed from {
      info	[Changelog]         [propertyName: string]: Record<string, unknown>;
      info	[Changelog]     } to {
      info	[Changelog]         [propertyName: string]: any;
      info	[Changelog]     }
      info	[Changelog]   - Type of parameter additionalData of interface SecurityGroupEntity is changed from {
      info	[Changelog]         [propertyName: string]: Record<string, unknown>;
      info	[Changelog]     } to {
      info	[Changelog]         [propertyName: string]: any;
      info	[Changelog]     }
      info	[Changelog]   - Type of parameter additionalData of interface SubmissionMailEntity is changed from {
      info	[Changelog]         [propertyName: string]: Record<string, unknown>;
      info	[Changelog]     } to {
      info	[Changelog]         [propertyName: string]: any;
      info	[Changelog]     }
      info	[Changelog]   - Type of parameter additionalData of interface ThreatIntelligenceIndicatorModel is changed from {
      info	[Changelog]         [propertyName: string]: Record<string, unknown>;
      info	[Changelog]     } to {
      info	[Changelog]         [propertyName: string]: any;
      info	[Changelog]     }
      info	[Changelog]   - Type of parameter kind of interface ThreatIntelligenceInformation is changed from ThreatIntelligenceResourceKindEnum to ThreatIntelligenceResourceInnerKind
      info	[Changelog]   - Type of parameter sortOrder of interface ThreatIntelligenceSortingCriteria is changed from ThreatIntelligenceSortingCriteriaEnum to ThreatIntelligenceSortingOrder
      info	[Changelog]   - Type of parameter additionalData of interface UrlEntity is changed from {
      info	[Changelog]         [propertyName: string]: Record<string, unknown>;
      info	[Changelog]     } to {
      info	[Changelog]         [propertyName: string]: any;
      info	[Changelog]     }
      info	[Changelog]   - Type of parameter webhookSecretUpdateTime of interface Webhook is changed from string to Date
      info	[Changelog]   - Removed Enum KnownEntityKind
      info	[Changelog]   - Removed Enum KnownEnum13
      info	[Changelog]   - Removed Enum KnownThreatIntelligenceResourceKindEnum
      info	[Changelog]   - Removed Enum KnownThreatIntelligenceSortingCriteriaEnum
      info	[Changelog]   - Enum KnownRepoType no longer has value DevOps
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs] Generate from 27053f2140455de0ef7c21ed749b07d383501b3e. 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.1.2
      cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
      cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.1.2
      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-securityinsights [View full logs]  [Preview SDK Changes]
    ️❌ azure-resource-manager-schemas failed [Detail]
    • Failed [Logs] Generate from 27053f2140455de0ef7c21ed749b07d383501b3e. 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]  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
    • securityinsights/resource-manager [View full logs
    ️❌ azure-powershell failed [Detail]
    • Pipeline Framework Failed [Logs] Generate from 27053f2140455de0ef7c21ed749b07d383501b3e. 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.securityinsights.DefaultTag [View full logs
      error	Fatal error: SSL error: syscall failure: Broken pipe
      error	The following packages are still pending:
      error		Az.securityinsights.DefaultTag
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jun 13, 2023

    Generated ApiView

    Language Package Name ApiView Link
    Java azure-resourcemanager-securityinsights https://apiview.dev/Assemblies/Review/453c052f0bb34f51b54d2614f0056188
    .Net Azure.ResourceManager.SecurityInsights There is no API change compared with the previous version
    JavaScript @azure/arm-securityinsight https://apiview.dev/Assemblies/Review/e6acb1aa77b84afda93d848010f062fa

    @nazang
    Copy link
    Contributor Author

    nazang commented Jun 13, 2023

    @Wzb123456789, could you help review the PR, it is fix a creds scan error for our up-coming swagger release.

    @Wzb123456789 Wzb123456789 added the Approved-OkToMerge <valid label in PR review process>add this label when assignee approve to merge the updates label Jun 14, 2023
    @chunyu3 chunyu3 merged commit ecb6eb0 into Azure:release-Sentinel-2023-06-01-preview Jun 14, 2023
    raych1 pushed a commit that referenced this pull request Jun 19, 2023
    * Adds base for updating Microsoft.SecurityInsights from version preview/2023-05-01-preview to version 2023-06-01-preview
    
    * Updates readme
    
    * Updates API version in new specs and examples
    
    * Sentinel - SourceControls 2023-06-01-preview (#24151)
    
    Co-authored-by: Oleh Formaniuk <oformaniuk@microsoft.com>
    
    * Fix creds scan error, remove real object id from sample file. (#24410)
    
    ---------
    
    Co-authored-by: Oleh Formaniuk <zjklee@gmail.com>
    Co-authored-by: Oleh Formaniuk <oformaniuk@microsoft.com>
    harryli0108 pushed a commit to harryli0108/azure-rest-api-specs that referenced this pull request Jul 28, 2023
    * Adds base for updating Microsoft.SecurityInsights from version preview/2023-05-01-preview to version 2023-06-01-preview
    
    * Updates readme
    
    * Updates API version in new specs and examples
    
    * Sentinel - SourceControls 2023-06-01-preview (Azure#24151)
    
    Co-authored-by: Oleh Formaniuk <oformaniuk@microsoft.com>
    
    * Fix creds scan error, remove real object id from sample file. (Azure#24410)
    
    ---------
    
    Co-authored-by: Oleh Formaniuk <zjklee@gmail.com>
    Co-authored-by: Oleh Formaniuk <oformaniuk@microsoft.com>
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Labels

    Approved-OkToMerge <valid label in PR review process>add this label when assignee approve to merge the updates resource-manager

    Projects

    None yet

    Development

    Successfully merging this pull request may close these issues.

    4 participants