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.

Sign up for GitHub

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

Jump to bottom

[Hub Generated] Review request for Microsoft.KeyVault to add version stable/2018-02-14 #20455

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

[Hub Generated] Review request for Microsoft.KeyVault to add version stable/2018-02-14 #20455

wants to merge 1 commit into from

Conversation

brihicks-653
Copy link
Contributor

This is a PR generated at OpenAPI Hub. You can view your work branch via this link.

ARM API Information (Control Plane)

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:

  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
  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.

  • 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, @brihicks-653 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 Aug 29, 2022 •
    edited
    Loading

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand] 
    There are no breaking changes.
    compared swaggers (via Oad v0.9.7)] new version base version
    secrets.json 2018-02-14(eec1bba) 2018-02-14(main)
    ️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand] 
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand] 
    There is no credential detected.
    ️️✔️LintDiff succeeded [Detail] [Expand] 
    Validation passes for LintDiff.
    compared tags (via openapi-validator v1.13.0) new version base version
    default default(eec1bba) default(main)
    ️️✔️Avocado succeeded [Detail] [Expand] 
    Validation passes for Avocado.
    ️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
    ️️✔️~[Staging] ServiceAPIReadinessTest succeeded [Detail] [Expand] 
    Validation passes for ServiceAPIReadinessTest.
    ️️✔️ModelValidation succeeded [Detail] [Expand] 
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand] 
    Validation passes for SemanticValidation.
    ️️✔️PoliCheck succeeded [Detail] [Expand] 
    Validation passed for PoliCheck.
    ️️✔️SDK Track2 Validation succeeded [Detail] [Expand] 
    Validation passes for SDKTrack2Validation
    ️️✔️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.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Aug 29, 2022 •
    edited
    Loading

    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-keyvault - 3.0.0
    +	Interface MhsmPrivateEndpointConnectionsDeleteHeaders no longer has parameter retryAfter
    ️⚠️ azure-sdk-for-net-track2 warning [Detail]
    • ⚠️Warning [Logs] Generate from 44019c28bf81addd26abcf8251e73c95134a619a. 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
warn	File azure-sdk-for-net_tmp/initOutput.json not found to read
command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
warn	No file changes detected after generation
    • ️✔️Azure.ResourceManager.KeyVault [View full logs]  
      info	[Changelog]
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs] Generate from 44019c28bf81addd26abcf8251e73c95134a619a. 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] sudo: unable to resolve host 622158fdc00000J: Name or service not known
cmderr	[automation_init.sh] sudo: unable to resolve host 622158fdc00000J: Name or service not known
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] sudo: unable to resolve host 622158fdc00000J: Name or service not known
cmderr	[automation_generate.sh] sudo: unable to resolve host 622158fdc00000J: Name or service not known
    • ️✔️track2_azure-mgmt-keyvault [View full logs]  [Preview SDK Changes] 
      info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog]   - Added model Enum10
info	[Changelog]   - Added model Enum11
info	[Changelog]   - Added model Enum12
info	[Changelog]   - Added model Enum13
info	[Changelog]   - Added model Enum16
info	[Changelog]   - Added model Enum17
info	[Changelog]   - Added model Enum5
info	[Changelog]   - Added model Enum6
info	[Changelog]   - Added model Enum9
    ️⚠️ azure-sdk-for-java warning [Detail]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from 44019c28bf81addd26abcf8251e73c95134a619a. 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/keyvault/armkeyvault [View full logs]  [Preview SDK Changes] 
      info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog] - New const `ActivationStatusFailed`
info	[Changelog] - New const `ActivationStatusUnknown`
info	[Changelog] - New const `KeyPermissionsRelease`
info	[Changelog] - New const `ActivationStatusActive`
info	[Changelog] - New const `KeyRotationPolicyActionTypeNotify`
info	[Changelog] - New const `ActivationStatusNotActivated`
info	[Changelog] - New const `KeyPermissionsSetrotationpolicy`
info	[Changelog] - New const `KeyRotationPolicyActionTypeRotate`
info	[Changelog] - New const `JSONWebKeyOperationRelease`
info	[Changelog] - New const `KeyPermissionsGetrotationpolicy`
info	[Changelog] - New const `KeyPermissionsRotate`
info	[Changelog] - New type alias `KeyRotationPolicyActionType`
info	[Changelog] - New type alias `ActivationStatus`
info	[Changelog] - New function `PossibleActivationStatusValues() []ActivationStatus`
info	[Changelog] - New function `PossibleKeyRotationPolicyActionTypeValues() []KeyRotationPolicyActionType`
info	[Changelog] - New function `*ManagedHsmsClient.CheckMhsmNameAvailability(context.Context, CheckMhsmNameAvailabilityParameters, *ManagedHsmsClientCheckMhsmNameAvailabilityOptions) (ManagedHsmsClientCheckMhsmNameAvailabilityResponse, error)`
info	[Changelog] - New struct `Action`
info	[Changelog] - New struct `CheckMhsmNameAvailabilityParameters`
info	[Changelog] - New struct `CheckMhsmNameAvailabilityResult`
info	[Changelog] - New struct `KeyReleasePolicy`
info	[Changelog] - New struct `KeyRotationPolicyAttributes`
info	[Changelog] - New struct `LifetimeAction`
info	[Changelog] - New struct `ManagedHSMSecurityDomainProperties`
info	[Changelog] - New struct `ManagedHsmsClientCheckMhsmNameAvailabilityOptions`
info	[Changelog] - New struct `ManagedHsmsClientCheckMhsmNameAvailabilityResponse`
info	[Changelog] - New struct `RotationPolicy`
info	[Changelog] - New struct `Trigger`
info	[Changelog] - New field `ReleasePolicy` in struct `KeyProperties`
info	[Changelog] - New field `RotationPolicy` in struct `KeyProperties`
info	[Changelog] - New field `Etag` in struct `MHSMPrivateEndpointConnectionItem`
info	[Changelog] - New field `ID` in struct `MHSMPrivateEndpointConnectionItem`
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 40 additive change(s).
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from 44019c28bf81addd26abcf8251e73c95134a619a. 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-keyvault [View full logs]  [Preview SDK Changes] Breaking Change Detected
      info	[Changelog] **Features**
info	[Changelog]
info	[Changelog]   - Added operation ManagedHsms.checkMhsmNameAvailability
info	[Changelog]   - Added Interface Action
info	[Changelog]   - Added Interface CheckMhsmNameAvailabilityParameters
info	[Changelog]   - Added Interface CheckMhsmNameAvailabilityResult
info	[Changelog]   - Added Interface Key
info	[Changelog]   - Added Interface KeyReleasePolicy
info	[Changelog]   - Added Interface KeyRotationPolicyAttributes
info	[Changelog]   - Added Interface LifetimeAction
info	[Changelog]   - Added Interface ManagedHsm
info	[Changelog]   - Added Interface ManagedHsmsCheckMhsmNameAvailabilityOptionalParams
info	[Changelog]   - Added Interface ManagedHsmsCreateOrUpdateHeaders
info	[Changelog]   - Added Interface ManagedHsmsDeleteHeaders
info	[Changelog]   - Added Interface ManagedHSMSecurityDomainProperties
info	[Changelog]   - Added Interface ManagedHsmsPurgeDeletedHeaders
info	[Changelog]   - Added Interface ManagedHsmsUpdateHeaders
info	[Changelog]   - Added Interface MhsmPrivateEndpointConnection
info	[Changelog]   - Added Interface MhsmPrivateLinkResource
info	[Changelog]   - Added Interface PrivateEndpointConnection
info	[Changelog]   - Added Interface PrivateLinkResource
info	[Changelog]   - Added Interface RotationPolicy
info	[Changelog]   - Added Interface Secret
info	[Changelog]   - Added Interface SecretAttributes
info	[Changelog]   - Added Interface Trigger
info	[Changelog]   - Added Type Alias ActivationStatus
info	[Changelog]   - Added Type Alias KeyRotationPolicyActionType
info	[Changelog]   - Added Type Alias ManagedHsmsCheckMhsmNameAvailabilityResponse
info	[Changelog]   - Added Type Alias ManagedHsmsPurgeDeletedResponse
info	[Changelog]   - Interface KeyProperties has a new optional parameter releasePolicy
info	[Changelog]   - Interface KeyProperties has a new optional parameter rotationPolicy
info	[Changelog]   - Interface MhsmPrivateEndpointConnectionItem has a new optional parameter etag
info	[Changelog]   - Interface MhsmPrivateEndpointConnectionItem has a new optional parameter id
info	[Changelog]   - Added Enum KnownActivationStatus
info	[Changelog]   - Enum KnownJsonWebKeyOperation has a new value Release
info	[Changelog]   - Enum KnownKeyPermissions has a new value Getrotationpolicy
info	[Changelog]   - Enum KnownKeyPermissions has a new value Release
info	[Changelog]   - Enum KnownKeyPermissions has a new value Rotate
info	[Changelog]   - Enum KnownKeyPermissions has a new value Setrotationpolicy
info	[Changelog]
info	[Changelog] **Breaking Changes**
info	[Changelog]
info	[Changelog]   - Interface MhsmPrivateEndpointConnectionsDeleteHeaders no longer has parameter retryAfter
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs] Generate from 44019c28bf81addd26abcf8251e73c95134a619a. 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] 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
    • ️✔️keyvault [View full logs]  [Preview Schema Changes]
    ️❌ azure-powershell failed [Detail]
    • ❌Failed [Logs] Generate from 44019c28bf81addd26abcf8251e73c95134a619a. 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
    • ❌Az.keyvault [View full logs]  [Preview SDK Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Aug 29, 2022 •
    edited
    Loading

    Generated ApiView

    Language Package Name ApiView Link
    Go sdk/resourcemanager/keyvault/armkeyvault Create ApiView failed. Please ask PR assignee for help
    Python track2_azure-mgmt-keyvault Create ApiView failed. Please ask PR assignee for help
    Java azure-resourcemanager-keyvault-generated Create ApiView failed. Please ask PR assignee for help
    .Net Azure.ResourceManager.KeyVault Create ApiView failed. Please ask PR assignee for help
    JavaScript @azure/arm-keyvault Create ApiView failed. Please ask PR assignee for help

    @ghost ghost added the KeyVault label Aug 29, 2022
    This was referenced Aug 29, 2022
    Closed
    Draft
    Closed
    Closed
    Closed
    @azure-sdk azure-sdk mentioned this pull request Aug 29, 2022
    Closed
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Reviewers

    @heaths heaths Awaiting requested review from heaths heaths will be requested when the pull request is marked ready for review heaths is a code owner

    @jlichwa jlichwa Awaiting requested review from jlichwa jlichwa will be requested when the pull request is marked ready for review jlichwa is a code owner

    At least 1 approving review is required to merge this pull request.

    Assignees
    No one assigned
    Labels
    CI-BreakingChange-JavaScript KeyVault resource-manager
    Projects
    None yet
    Milestone
    No milestone
    Development

    Successfully merging this pull request may close these issues.
    1 participant
    @brihicks-653