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

Service connector keyvault secret #18258

Merged
merged 1 commit into from
Mar 15, 2022
Merged

Conversation

xfz11
Copy link
Member

@xfz11 xfz11 commented Mar 15, 2022

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

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. If updating an existing version, please select the specific language SDKs and CLIs that must be refreshed after the swagger is published.
    • SDK of .NET (need service team to ensure code readiness)
    • SDK of Python
    • SDK of Java
    • SDK of Js
    • SDK of Go
    • PowerShell
    • CLI
    • Terraform
    • No refresh required for updates in this PR

Contribution checklist:

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 label "WaitForARMFeedback" will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.

    • Adding a new service
    • Adding new API(s)
    • Adding a new API version
      -[ ] To review changes efficiently, ensure you are using OpenAPIHub to initialize the PR for adding a new version. 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 any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.

  • Removing API(s) in a stable version
  • Removing properties in a stable version
  • Removing API version(s) in a stable version
  • Updating API in a 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, @xfz11 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-workflow-bot
    Copy link

    [Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks.

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Mar 15, 2022

    Swagger Validation Report

    ️❌BreakingChange: 3 Errors, 1 Warnings failed [Detail]
    Rule Message
    1030 - DifferentDiscriminator The new version has a different discriminator than the previous one.
    New: Microsoft.ServiceLinker/preview/2022-01-01-preview/servicelinker.json#L635:9
    Old: Microsoft.ServiceLinker/preview/2022-01-01-preview/servicelinker.json#L552:9
    1034 - AddedRequiredProperty The new version has new required property 'secretType' that was not found in the old version.
    New: Microsoft.ServiceLinker/preview/2022-01-01-preview/servicelinker.json#L544:7
    1034 - AddedRequiredProperty The new version has new required property 'secretType' that was not found in the old version.
    New: Microsoft.ServiceLinker/preview/2022-01-01-preview/servicelinker.json#L635:9
    Old: Microsoft.ServiceLinker/preview/2022-01-01-preview/servicelinker.json#L552:9
    ⚠️ 1026 - TypeChanged The new version has a different type 'object' than the previous one 'string'.
    New: Microsoft.ServiceLinker/preview/2022-01-01-preview/servicelinker.json#L635:9
    Old: Microsoft.ServiceLinker/preview/2022-01-01-preview/servicelinker.json#L552:9
    ️⚠️LintDiff: 0 Warnings warning [Detail]
    The following errors/warnings exist before current PR submission:
    Rule Message
    ⚠️ R2066 - PostOperationIdContainsUrlVerb OperationId should contain the verb: 'validatelinker' in:'Linker_Validate'. Consider updating the operationId
    Location: Microsoft.ServiceLinker/preview/2022-01-01-preview/servicelinker.json#L274
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: connectAsKubernetesCsiDriver
    Location: Microsoft.ServiceLinker/preview/2022-01-01-preview/servicelinker.json#L474
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isConnectionAvailable
    Location: Microsoft.ServiceLinker/preview/2022-01-01-preview/servicelinker.json#L874
    ⚠️ R4030 - UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: GetConfiguration
    Location: Microsoft.ServiceLinker/preview/2022-01-01-preview/servicelinker.json#L361
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️~[Staging] ApiReadinessCheck succeeded [Detail] [Expand]
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️️✔️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).
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Mar 15, 2022

    Swagger Generation Artifacts

    ️️✔️ApiDocPreview succeeded [Detail] [Expand]
     Please click here to preview with your @microsoft account. 
    ️❌SDK Breaking Change Tracking failed [Detail]

    Breaking Changes Tracking

    azure-sdk-for-go-track2 - armservicelinker - 0.3.0
    +	Type of `SecretAuthInfo.Secret` has been changed from `*string` to `SecretInfoBaseClassification`
    ️✔️azure-sdk-for-go - preview/servicelinker/mgmt/2021-11-01-preview/servicelinker - v62.2.0
    azure-sdk-for-python-track2 - track2_azure-mgmt-servicelinker - 1.0.0b2
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 6ac3fab. 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] npm notice
      cmderr	[automation_generate.sh] npm notice New minor version of npm available! 8.3.1 -> 8.5.4
      cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v8.5.4>
      cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@8.5.4` to update!
      cmderr	[automation_generate.sh] npm notice
    • ️✔️track2_azure-mgmt-servicelinker [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Model LinkerPatch has a new parameter scope
      info	[Changelog]   - Model LinkerPatch has a new parameter target_service
      info	[Changelog]   - Model LinkerResource has a new parameter scope
      info	[Changelog]   - Model LinkerResource has a new parameter target_service
      info	[Changelog]   - Model ValidateResult has a new parameter is_connection_available
      info	[Changelog]   - Model ValidateResult has a new parameter linker_name
      info	[Changelog]   - Model ValidateResult has a new parameter source_id
      info	[Changelog]   - Model ValidateResult has a new parameter validation_detail
      info	[Changelog]
      info	[Changelog] **Breaking changes**
      info	[Changelog]
      info	[Changelog]   - Model LinkerPatch no longer has parameter target_id
      info	[Changelog]   - Model LinkerResource no longer has parameter target_id
      info	[Changelog]   - Model ValidateResult no longer has parameter linker_status
      info	[Changelog]   - Model ValidateResult no longer has parameter name
      info	[Changelog]   - Model ValidateResult no longer has parameter reason
    ️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 6ac3fab. SDK Automation 14.0.0
      command	sh ./eng/initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
      command	generator automation ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
    • ️✔️preview/servicelinker/mgmt/2021-11-01-preview/servicelinker [View full logs]  [Release SDK Changes]
      info	[Changelog] This is a new package
      info	[Changelog]
    ️️✔️ azure-sdk-for-go-track2 succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 6ac3fab. 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
    • ️✔️armservicelinker [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog] - Type of `SecretAuthInfo.Secret` has been changed from `*string` to `SecretInfoBaseClassification`
      info	[Changelog] - Const `LinkerStatusNotHealthy` has been removed
      info	[Changelog] - Const `LinkerStatusHealthy` has been removed
      info	[Changelog] - Function `LinkerStatus.ToPtr` has been removed
      info	[Changelog] - Function `ErrorDetail.MarshalJSON` has been removed
      info	[Changelog] - Function `PossibleLinkerStatusValues` has been removed
      info	[Changelog] - Struct `ErrorAdditionalInfo` has been removed
      info	[Changelog] - Struct `ErrorDetail` has been removed
      info	[Changelog] - Struct `ErrorResponse` has been removed
      info	[Changelog] - Field `TargetID` of struct `LinkerProperties` has been removed
      info	[Changelog] - Field `Reason` of struct `ValidateResult` has been removed
      info	[Changelog] - Field `LinkerStatus` of struct `ValidateResult` has been removed
      info	[Changelog] - Field `Name` of struct `ValidateResult` has been removed
      info	[Changelog]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog] - New const `SecretTypeKeyVaultSecretURI`
      info	[Changelog] - New const `VNetSolutionTypePrivateLink`
      info	[Changelog] - New const `SecretTypeKeyVaultSecretReference`
      info	[Changelog] - New const `TypeKeyVault`
      info	[Changelog] - New const `ValidationItemResultSuccess`
      info	[Changelog] - New const `VNetSolutionTypeServiceEndpoint`
      info	[Changelog] - New const `SecretTypeRawValue`
      info	[Changelog] - New const `ValidationItemResultWarning`
      info	[Changelog] - New const `TypeConfluentBootstrapServer`
      info	[Changelog] - New const `ValidationItemResultFailed`
      info	[Changelog] - New const `TypeAzureResource`
      info	[Changelog] - New const `TypeConfluentSchemaRegistry`
      info	[Changelog] - New function `*KeyVaultSecretURISecretInfo.GetSecretInfoBase() *SecretInfoBase`
      info	[Changelog] - New function `*KeyVaultSecretReferenceSecretInfo.GetSecretInfoBase() *SecretInfoBase`
      info	[Changelog] - New function `*ConfluentSchemaRegistry.UnmarshalJSON([]byte) error`
      info	[Changelog] - New function `*AzureResource.GetTargetServiceBase() *TargetServiceBase`
      info	[Changelog] - New function `AzureResource.MarshalJSON() ([]byte, error)`
      info	[Changelog] - New function `*AzureResourcePropertiesBase.GetAzureResourcePropertiesBase() *AzureResourcePropertiesBase`
      info	[Changelog] - New function `PossibleTypeValues() []Type`
      info	[Changelog] - New function `PossibleValidationItemResultValues() []ValidationItemResult`
      info	[Changelog] - New function `ValueSecretInfo.MarshalJSON() ([]byte, error)`
      info	[Changelog] - New function `KeyVaultSecretReferenceSecretInfo.MarshalJSON() ([]byte, error)`
      info	[Changelog] - New function `AzureKeyVaultProperties.MarshalJSON() ([]byte, error)`
      info	[Changelog] - New function `*KeyVaultSecretURISecretInfo.UnmarshalJSON([]byte) error`
      info	[Changelog] - New function `ConfluentSchemaRegistry.MarshalJSON() ([]byte, error)`
      info	[Changelog] - New function `VNetSolutionType.ToPtr() *VNetSolutionType`
      info	[Changelog] - New function `*ConfluentSchemaRegistry.GetTargetServiceBase() *TargetServiceBase`
      info	[Changelog] - New function `*ValueSecretInfo.GetSecretInfoBase() *SecretInfoBase`
      info	[Changelog] - New function `*ConfluentBootstrapServer.UnmarshalJSON([]byte) error`
      info	[Changelog] - New function `*AzureKeyVaultProperties.UnmarshalJSON([]byte) error`
      info	[Changelog] - New function `*TargetServiceBase.GetTargetServiceBase() *TargetServiceBase`
      info	[Changelog] - New function `PossibleSecretTypeValues() []SecretType`
      info	[Changelog] - New function `KeyVaultSecretURISecretInfo.MarshalJSON() ([]byte, error)`
      info	[Changelog] - New function `*SecretInfoBase.GetSecretInfoBase() *SecretInfoBase`
      info	[Changelog] - New function `*AzureKeyVaultProperties.GetAzureResourcePropertiesBase() *AzureResourcePropertiesBase`
      info	[Changelog] - New function `PossibleVNetSolutionTypeValues() []VNetSolutionType`
      info	[Changelog] - New function `SecretType.ToPtr() *SecretType`
      info	[Changelog] - New function `*ValueSecretInfo.UnmarshalJSON([]byte) error`
      info	[Changelog] - New function `*AzureResource.UnmarshalJSON([]byte) error`
      info	[Changelog] - New function `Type.ToPtr() *Type`
      info	[Changelog] - New function `ValidationItemResult.ToPtr() *ValidationItemResult`
      info	[Changelog] - New function `*KeyVaultSecretReferenceSecretInfo.UnmarshalJSON([]byte) error`
      info	[Changelog] - New function `*ConfluentBootstrapServer.GetTargetServiceBase() *TargetServiceBase`
      info	[Changelog] - New function `ConfluentBootstrapServer.MarshalJSON() ([]byte, error)`
      info	[Changelog] - New struct `AzureKeyVaultProperties`
      info	[Changelog] - New struct `AzureResource`
      info	[Changelog] - New struct `AzureResourcePropertiesBase`
      info	[Changelog] - New struct `ConfluentBootstrapServer`
      info	[Changelog] - New struct `ConfluentSchemaRegistry`
      info	[Changelog] - New struct `KeyVaultSecretReferenceSecretInfo`
      info	[Changelog] - New struct `KeyVaultSecretURISecretInfo`
      info	[Changelog] - New struct `SecretInfoBase`
      info	[Changelog] - New struct `SecretStore`
      info	[Changelog] - New struct `TargetServiceBase`
      info	[Changelog] - New struct `VNetSolution`
      info	[Changelog] - New struct `ValidationResultItem`
      info	[Changelog] - New struct `ValueSecretInfo`
      info	[Changelog] - New field `SourceID` in struct `ValidateResult`
      info	[Changelog] - New field `ValidationDetail` in struct `ValidateResult`
      info	[Changelog] - New field `IsConnectionAvailable` in struct `ValidateResult`
      info	[Changelog] - New field `LinkerName` in struct `ValidateResult`
      info	[Changelog] - New field `Scope` in struct `LinkerProperties`
      info	[Changelog] - New field `SecretStore` in struct `LinkerProperties`
      info	[Changelog] - New field `TargetService` in struct `LinkerProperties`
      info	[Changelog] - New field `VNetSolution` in struct `LinkerProperties`
      info	[Changelog]
      info	[Changelog] Total 14 breaking change(s), 75 additive change(s).
    ️⚠️ azure-sdk-for-js warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 6ac3fab. 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
      cmderr	[automation_init.sh]  read-package-tree@5.1.6: The functionality that this package provided is now in @npmcli/arborist
      cmderr	[automation_init.sh] npm WARN deprecated uuid@3.4.0: Please upgrade  to version 7 or higher.  Older versions may use Math.random() in certain circumstances, which is known to be problematic.  See https://v8.dev/blog/math-random for details.
      cmderr	[automation_init.sh] deprecated @opentelemetry/types@0.2.0: Package renamed to @opentelemetry/api, see https://github.com/open-telemetry/opentelemetry-js
      cmderr	[automation_init.sh] notice created a lockfile as package-lock.json. You should commit this file.
      cmderr	[automation_init.sh]  WARN @octokit/plugin-request-log@1.0.4 requires a peer of @octokit/core@>=3 but none is installed. You must install peer dependencies yourself.
      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-servicelinker [View full logs]  [Release SDK Changes]
      info	[Changelog]
      error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 6ac3fab. 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
    • ️✔️servicelinker [View full logs]  [Release Schema Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

    Hi @xfz11, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review.
    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.
    If you want to know the production traffic statistic, please see ARM Traffic statistic.
    If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback.

    @xfz11
    Copy link
    Member Author

    xfz11 commented Mar 15, 2022

    same as PR to rpaasmaster branch of private repo https://github.com/Azure/azure-rest-api-specs-pr/pull/6510

    @raych1
    Copy link
    Contributor

    raych1 commented Mar 15, 2022

    same as PR to rpaasmaster branch of private repo Azure/azure-rest-api-specs-pr#6510

    Approved this PR.

    @raych1 raych1 added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Mar 15, 2022
    @raych1 raych1 merged commit 6ac3fab into Azure:main Mar 15, 2022
    FredericHeem pushed a commit to grucloud/azure-rest-api-specs that referenced this pull request May 16, 2022
    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 CI-BreakingChange-Go-V2
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    2 participants