Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added a new resource type for RP - Microsoft.SecurityAndCompliance #13323

Merged
merged 11 commits into from
Mar 9, 2021

Conversation

fangsu-dccore
Copy link
Contributor

@fangsu-dccore fangsu-dccore commented Mar 8, 2021

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Changelog

Please ensure to add changelog with 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
    • update existing version to fix swagger quality issue in s360
    • Other, please clarify. - Added a new resource type.
  2. When you are targeting to deploy new service/feature to public regions? Please provide date, or month to public if date is not available yet.
  3. When you expect to publish swagger? Please provide date, or month to public if date is not available yet.

Contribution checklist:

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

ARM API Review Checklist

  • Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.

    • Adding new API(s)
    • [x]Adding a new API version
    • Adding a new service
  • Please 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 there are following updates in the PR, ensure to request an approval from Breaking Change Review Board as defined in the Breaking Change Policy.

  • Removing API(s) in stable version
  • Removing properties in stable version
  • Removing API version(s) in stable version
  • Updating API in stable or public preview version with Breaking Change Validation errors
  • Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.

Please follow the link to find more details on PR review process.

@openapi-workflow-bot
Copy link

Hi, @fangsu-dccore 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. [email protected]

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Mar 8, 2021

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️⚠️LintDiff: 26 Warnings warning [Detail] Only 10 items are listed, please refer to log for more details.

    Rule Message
    ⚠️ R2029 - PageableOperation Based on the response model schema, operation 'PrivateLinkResourcesForMIPPolicySync_ListByService' might be pageable. Consider adding the x-ms-pageable extension.
    Location: Microsoft.SecurityAndCompliance/stable/2021-03-08/privateLinkServicesForMIPPolicySync.json#L536
    ⚠️ R3010 - TrackedResourceListByImmediateParent The child tracked resource, 'privateEndpointConnections' with immediate parent 'PrivateLinkServicesForEDMUploadDescription', must have a list by immediate parent operation.
    Location: Microsoft.SecurityAndCompliance/stable/2021-03-08/privateLinkServicesForMIPPolicySync.json#L627
    ⚠️ R3010 - TrackedResourceListByImmediateParent The child tracked resource, 'privateLinkResources' with immediate parent 'PrivateLinkServicesForEDMUploadDescription', must have a list by immediate parent operation.
    Location: Microsoft.SecurityAndCompliance/stable/2021-03-08/privateLinkServicesForMIPPolicySync.json#L627
    ⚠️ R3010 - TrackedResourceListByImmediateParent The child tracked resource, 'privateEndpointConnections' with immediate parent 'PrivateLinkServicesForM365ComplianceCenterDescription', must have a list by immediate parent operation.
    Location: Microsoft.SecurityAndCompliance/stable/2021-03-08/privateLinkServicesForMIPPolicySync.json#L627
    ⚠️ R3010 - TrackedResourceListByImmediateParent The child tracked resource, 'privateLinkResources' with immediate parent 'PrivateLinkServicesForM365ComplianceCenterDescription', must have a list by immediate parent operation.
    Location: Microsoft.SecurityAndCompliance/stable/2021-03-08/privateLinkServicesForMIPPolicySync.json#L627
    ⚠️ R3010 - TrackedResourceListByImmediateParent The child tracked resource, 'privateEndpointConnections' with immediate parent 'PrivateLinkServicesForM365SecurityCenterDescription', must have a list by immediate parent operation.
    Location: Microsoft.SecurityAndCompliance/stable/2021-03-08/privateLinkServicesForMIPPolicySync.json#L627
    ⚠️ R3010 - TrackedResourceListByImmediateParent The child tracked resource, 'privateLinkResources' with immediate parent 'PrivateLinkServicesForM365SecurityCenterDescription', must have a list by immediate parent operation.
    Location: Microsoft.SecurityAndCompliance/stable/2021-03-08/privateLinkServicesForMIPPolicySync.json#L627
    ⚠️ R3010 - TrackedResourceListByImmediateParent The child tracked resource, 'privateEndpointConnections' with immediate parent 'PrivateLinkServicesForO365ManagementActivityAPIDescription', must have a list by immediate parent operation.
    Location: Microsoft.SecurityAndCompliance/stable/2021-03-08/privateLinkServicesForMIPPolicySync.json#L627
    ⚠️ R3010 - TrackedResourceListByImmediateParent The child tracked resource, 'privateLinkResources' with immediate parent 'PrivateLinkServicesForO365ManagementActivityAPIDescription', must have a list by immediate parent operation.
    Location: Microsoft.SecurityAndCompliance/stable/2021-03-08/privateLinkServicesForMIPPolicySync.json#L627
    ⚠️ R3010 - TrackedResourceListByImmediateParent The child tracked resource, 'privateEndpointConnections' with immediate parent 'PrivateLinkServicesForSCCPowershellDescription', must have a list by immediate parent operation.
    Location: Microsoft.SecurityAndCompliance/stable/2021-03-08/privateLinkServicesForMIPPolicySync.json#L627
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️️✔️[Staging] Cross Version BreakingChange (Base on preview version) succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️[Staging] Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand]
    There are no breaking changes.

    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️⚠️[Staging] SDK Track2 Validation: 26 Warnings warning [Detail] Only 10 items are listed, please refer to log for more details.

    Rule Message
    ⚠️ PreCheck/SchemaMissingType "readme":"securityandcompliance/resource-manager/readme.md",
    "tag":"package-2021-01-11",
    "details":"The schema 'ServiceAccessPolicyEntry' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"securityandcompliance/resource-manager/readme.md",
    "tag":"package-2021-01-11",
    "details":"The schema 'ServicesResource' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"securityandcompliance/resource-manager/readme.md",
    "tag":"package-2021-01-11",
    "details":"The schema 'PrivateEndpoint' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"securityandcompliance/resource-manager/readme.md",
    "tag":"package-2021-01-11",
    "details":"The schema 'PrivateEndpointConnection' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"securityandcompliance/resource-manager/readme.md",
    "tag":"package-2021-01-11",
    "details":"The schema 'PrivateEndpointConnectionProperties' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"securityandcompliance/resource-manager/readme.md",
    "tag":"package-2021-01-11",
    "details":"The schema 'PrivateLinkServiceConnectionState' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"securityandcompliance/resource-manager/readme.md",
    "tag":"package-2021-01-11",
    "details":"The schema 'PrivateLinkResource' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"securityandcompliance/resource-manager/readme.md",
    "tag":"package-2021-01-11",
    "details":"The schema 'PrivateLinkResourceProperties' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"securityandcompliance/resource-manager/readme.md",
    "tag":"package-2021-01-11",
    "details":"The schema 'PrivateEndpointConnectionListResult' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"securityandcompliance/resource-manager/readme.md",
    "tag":"package-2021-01-11",
    "details":"The schema 'PrivateLinkResourceListResult' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
    Validation passes for PrettierCheck.
    ️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
    Validation passes for SpellCheck.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Mar 8, 2021
    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Mar 8, 2021

    Swagger Generation Artifacts

    ️️✔️ azure-resource-manager-schemas succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from d26d0ae. Schema Automation 14.0.0
      warn	Skip initScript due to not configured
      command	npx n 12
      command	autorest --use=@autorest/[email protected] --version=3.0.6374 --azureresourceschema --multiapi --title=none --pass-thru:subset-reducer --azureresourceschema-folder=/home/vsts/work/1/s/azure-resource-manager-schemas/azure-resource-manager-schemas ../../azure-rest-api-specs/specification/securityandcompliance/resource-manager/readme.md
    • ️✔️securityandcompliance [View full logs]  [Release Schema Changes]
      cmderr	[resource-manager] node-pre-gyp
      cmderr	[resource-manager] WARN Using request for node-pre-gyp https download
      cmderr	[resource-manager] npm WARN [email protected] No repository field.
      cmderr	[resource-manager] npm WARN optional SKIPPING OPTIONAL DEPENDENCY: [email protected] (node_modules/fsevents):
      cmderr	[resource-manager] npm WARN notsup SKIPPING OPTIONAL DEPENDENCY: Unsupported platform for [email protected]: wanted {"os":"darwin","arch":"any"} (current: {"os":"linux","arch":"x64"})
    ️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from d26d0ae. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	sudo apt-get install -y dotnet-sdk-5.0
      command	autorest --version=V2 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION [email protected]/[email protected] --csharp-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/securityandcompliance/resource-manager/readme.md
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
    • ️✔️Microsoft.Azure.Management.SecurityAndCompliance [View full logs]  [Release SDK Changes]
      warn	Skip artifact folder because it doesn't exist: artifacts/packages
    ️⚠️ azure-sdk-for-python warning [Detail]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from d26d0ae. SDK Automation 14.0.0
      command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
      command	go run ./tools/generator/main.go ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
    • ️✔️securityandcompliance/mgmt/2021-03-08/securityandcompliance [View full logs]  [Release SDK Changes]
      info	[Changelog] This is a new package
    • ️✔️securityandcompliance/mgmt/2021-01-11/securityandcompliance [View full logs]  [Release SDK Changes]
      info	[Changelog] This is a new package
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from d26d0ae. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	autorest --version=V2 --typescript --license-header=MICROSOFT_MIT_NO_VERSION [email protected]/[email protected] --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js/azure-sdk-for-js ../../azure-rest-api-specs/specification/securityandcompliance/resource-manager/readme.md
    • ️✔️@azure/arm-securityandcompliance [View full logs]  [Release SDK Changes]
      cmderr	[npmPack] loaded rollup.config.js with warnings
      cmderr	[npmPack] (!) Unused external imports
      cmderr	[npmPack] default imported from external module 'rollup' but never used
      cmderr	[npmPack] ./esm/securityAndComplianceClient.js → ./dist/arm-securityandcompliance.js...
      cmderr	[npmPack] created ./dist/arm-securityandcompliance.js in 483ms
    ️🔄[Staging] ApiDocPreview inProgress [Detail]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

    Hi, @fangsu-dccore your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]). cc @

    @openapi-workflow-bot
    Copy link

    Hi @fangsu-dccore, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff.

    TaskHow to fixPrioritySupport (Microsoft alias)
    AvocadoFix-AvocadoHighruowan
    Semantic validationFix-SemanticValidation-ErrorHighraychen, jianyxi
    Model validationFix-ModelValidation-ErrorHighraychen,jianyxi
    LintDiffFix-LintDiffhighjianyxi, ruoxuan
    If you need further help, please feedback via swagger feedback."

    @openapi-workflow-bot
    Copy link

    Hi, @fangsu-dccore your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]). cc @chunyu3

    Comment on lines 28 to 31
    ``` yaml $(go) && $(multiapi)
    batch:
    - tag: package-2021-03-08
    ```
    Copy link
    Member

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    Could we remove this and add this entry to the batch section above on line 15?

    Copy link
    Contributor Author

    @fangsu-dccore fangsu-dccore Mar 9, 2021

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    Do you mean like this?:

    batch:
      - tag: package-2021-01-11
      - tag: package-2021-03-08

    Check(I think it is Fix-SemanticValidation-Error) failed after I change it to this.

    Copy link
    Member

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    That should be irrelevant. Let us try this first

    Copy link
    Contributor Author

    @fangsu-dccore fangsu-dccore Mar 9, 2021

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    I do not really understand it, can you be more specific? and give me an example?

    Copy link
    Contributor Author

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    but it will throw exceptions if I move this entry up, Updated readme.md file · 4da7043 (github.com)

    @chunyu3 chunyu3 self-requested a review March 9, 2021 05:15
    @chunyu3 chunyu3 merged commit d26d0ae into Azure:master Mar 9, 2021
    akning-ms added a commit that referenced this pull request Mar 9, 2021
    mkarmark pushed a commit to mkarmark/azure-rest-api-specs that referenced this pull request Jul 21, 2021
    …zure#13323)
    
    * Added a new api version on Mar 8th
    
    * Added apis for /MIPPolicySync
    
    * Updated readme.md file
    
    * Updated readme.md file
    
    * Fixed check failures
    
    * updated author's name
    
    * updated default tag
    
    * updated readme
    
    * add title and description in readme.md
    
    * fix readme.go.md
    
    * Fixed typo
    
    Co-authored-by: ArcturusZhang <[email protected]>
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    CI-BreakingChange-Python WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    3 participants