azure-rest-api-specs
azure-rest-api-specs copied to clipboard
Azure
[service connector ]add default value for enums
ARM API Information (Control Plane)
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow. 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:
- 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
- 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.
- When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
- 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):
- [ ] I commit to follow the Breaking Change Policy of "no breaking changes"
- [ ] I have reviewed the documentation for the workflow.
- [ ] Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Applicability: :warning:
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.
Hi @qianwens, this service has enabled Service API Toolset. All spec updates MUST be initiated from service ADO project repo, so that to guarantee it to be the source of truth. @ChenTanyi , please review this pull request if it's intentional or reject it if it's not expected. Normally, all the specification or example changes should start with PR created in ADO.
![openapi-workflow-bot[bot] avatar](https://avatars.githubusercontent.com/in/81125?v=4 "Published by a pub.dev verified publisher"){kind=small}
Swagger Validation Report
️❌BreakingChange: 15 Errors, 0 Warnings failed [Detail]
| compared swaggers (via Oad v0.10.2)] | new version | base version |
|---|---|---|
| servicelinker.json | 2022-11-01-preview(1f09b0d) | 2022-11-01-preview(main) |
️️✔️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.0.0) | new version | base version |
|---|---|---|
| package-2022-11-01-preview | package-2022-11-01-preview(1f09b0d) | package-2022-11-01-preview(main) |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
| :warning: OperationIdNounConflictingModelNames | OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ConfigurationNamesModel'. Consider using the plural form of 'ConfigurationNames' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.ServiceLinker/preview/2022-11-01-preview/servicelinker.json#L1317 |
| :warning: EnumInsteadOfBoolean | Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.ServiceLinker/preview/2022-11-01-preview/servicelinker.json#L1448 |
| :warning: SchemaDescriptionOrTitle | Schema should have a description or title. Location: Microsoft.ServiceLinker/preview/2022-11-01-preview/servicelinker.json#L2007 |
| :warning: EnumInsteadOfBoolean | Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.ServiceLinker/preview/2022-11-01-preview/servicelinker.json#L2122 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️️✔️~[Staging] SwaggerAPIView 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).
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
![openapi-pipeline-app[bot] avatar](https://avatars.githubusercontent.com/in/65541?v=4 "Published by a pub.dev verified publisher"){kind=small}
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 - sdk/resourcemanager/servicelinker/armservicelinker - 2.0.0-beta.1+ Field `LinkerList` of struct `LinkerClientListResponse` has been removed + Field `SourceConfigurationResult` of struct `LinkerClientListConfigurationsResponse` has been removed + Struct `LinkerList` has been removed + Struct `SourceConfigurationResult` has been removed
❌azure-sdk-for-js - @azure/arm-servicelinker - 3.0.0-beta.1+ Interface LinkerResource no longer has parameter systemData + Type of parameter authType of interface AuthInfoBase is changed from "secret" | "userAssignedIdentity" | "systemAssignedIdentity" | "servicePrincipalSecret" | "servicePrincipalCertificate" to "accessKey" | "secret" | "userAssignedIdentity" | "systemAssignedIdentity" | "servicePrincipalSecret" | "servicePrincipalCertificate" | "userAccount" + Type of parameter type of interface TargetServiceBase is changed from "AzureResource" | "ConfluentBootstrapServer" | "ConfluentSchemaRegistry" to "AzureResource" | "ConfluentBootstrapServer" | "SelfHostedServer" | "ConfluentSchemaRegistry"
️❌ azure-sdk-for-net-track2 failed [Detail]
❌Failed [Logs] Generate from 52f1095cb7e657c97ff2f3c8e4c7fdd3ed755a49. SDK Automation 14.0.0command 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 cmderr [Invoke-GenerateAndBuildV2.ps1] [91mGeneratePackage: [0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:666 cmderr [Invoke-GenerateAndBuildV2.ps1] [96mLine | cmderr [Invoke-GenerateAndBuildV2.ps1] [96m 666 | [0m [96mGeneratePackage -projectFolder $projectFolder -sdkRootPath $s[0m … cmderr [Invoke-GenerateAndBuildV2.ps1] [96m | [91m ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ cmderr [Invoke-GenerateAndBuildV2.ps1] [91m[96m | [91mFailed to build sdk. exit code: False cmderr [Invoke-GenerateAndBuildV2.ps1] [0m
❌Azure.ResourceManager.ServiceLinker [View full logs] [Preview SDK Changes] Breaking Change Detectedinfo [Changelog] Breaking Changes: /home/cloudtest/.nuget/packages/microsoft.dotnet.apicompat/5.0.0-beta.20467.1/build/Microsoft.DotNet.ApiCompat.targets(82,5): error : MembersMustExist : Member 'public Azure.ResourceManager.ArmOperation<Azure.ResourceManager.ServiceLinker.LinkerResource> Azure.ResourceManager.ServiceLinker.LinkerResource.Update(Azure.WaitUntil, Azure.ResourceManager.ServiceLinker.Models.LinkerResourcePatch, System.Threading.CancellationToken)' does not exist in the implementation but it does exist in the contract. [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/servicelinker/Azure.ResourceManager.ServiceLinker/src/Azure.ResourceManager.ServiceLinker.csproj], info [Changelog] /home/cloudtest/.nuget/packages/microsoft.dotnet.apicompat/5.0.0-beta.20467.1/build/Microsoft.DotNet.ApiCompat.targets(82,5): error : MembersMustExist : Member 'public System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.ServiceLinker.LinkerResource>> Azure.ResourceManager.ServiceLinker.LinkerResource.UpdateAsync(Azure.WaitUntil, Azure.ResourceManager.ServiceLinker.Models.LinkerResourcePatch, System.Threading.CancellationToken)' does not exist in the implementation but it does exist in the contract. [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/servicelinker/Azure.ResourceManager.ServiceLinker/src/Azure.ResourceManager.ServiceLinker.csproj], info [Changelog] /home/cloudtest/.nuget/packages/microsoft.dotnet.apicompat/5.0.0-beta.20467.1/build/Microsoft.DotNet.ApiCompat.targets(82,5): error : TypesMustExist : Type 'Azure.ResourceManager.ServiceLinker.LinkerResourceCollection' does not exist in the implementation but it does exist in the contract. [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/servicelinker/Azure.ResourceManager.ServiceLinker/src/Azure.ResourceManager.ServiceLinker.csproj], info [Changelog] /home/cloudtest/.nuget/packages/microsoft.dotnet.apicompat/5.0.0-beta.20467.1/build/Microsoft.DotNet.ApiCompat.targets(82,5): error : MembersMustExist : Member 'public Azure.Core.ResourceIdentifier Azure.ResourceManager.ServiceLinker.LinkerResourceData.SecretStoreKeyVaultId.get()' does not exist in the implementation but it does exist in the contract. [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/servicelinker/Azure.ResourceManager.ServiceLinker/src/Azure.ResourceManager.ServiceLinker.csproj], info [Changelog] /home/cloudtest/.nuget/packages/microsoft.dotnet.apicompat/5.0.0-beta.20467.1/build/Microsoft.DotNet.ApiCompat.targets(82,5): error : MembersMustExist : Member 'public void Azure.ResourceManager.ServiceLinker.LinkerResourceData.SecretStoreKeyVaultId.set(Azure.Core.ResourceIdentifier)' does not exist in the implementation but it does exist in the contract. [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/servicelinker/Azure.ResourceManager.ServiceLinker/src/Azure.ResourceManager.ServiceLinker.csproj], info [Changelog] /home/cloudtest/.nuget/packages/microsoft.dotnet.apicompat/5.0.0-beta.20467.1/build/Microsoft.DotNet.ApiCompat.targets(82,5): error : MembersMustExist : Member 'public System.Nullable<Azure.ResourceManager.ServiceLinker.Models.VnetSolutionType> Azure.ResourceManager.ServiceLinker.LinkerResourceData.SolutionType.get()' does not exist in the implementation but it does exist in the contract. [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/servicelinker/Azure.ResourceManager.ServiceLinker/src/Azure.ResourceManager.ServiceLinker.csproj], info [Changelog] /home/cloudtest/.nuget/packages/microsoft.dotnet.apicompat/5.0.0-beta.20467.1/build/Microsoft.DotNet.ApiCompat.targets(82,5): error : MembersMustExist : Member 'public void Azure.ResourceManager.ServiceLinker.LinkerResourceData.SolutionType.set(System.Nullable<Azure.ResourceManager.ServiceLinker.Models.VnetSolutionType>)' does not exist in the implementation but it does exist in the contract. [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/servicelinker/Azure.ResourceManager.ServiceLinker/src/Azure.ResourceManager.ServiceLinker.csproj], info [Changelog] /home/cloudtest/.nuget/packages/microsoft.dotnet.apicompat/5.0.0-beta.20467.1/build/Microsoft.DotNet.ApiCompat.targets(82,5): error : MembersMustExist : Member 'public Azure.Response<Azure.ResourceManager.ServiceLinker.LinkerResource> Azure.ResourceManager.ServiceLinker.ServiceLinkerExtensions.GetLinkerResource(Azure.ResourceManager.ArmClient, Azure.Core.ResourceIdentifier, System.String, System.Threading.CancellationToken)' does not exist in the implementation but it does exist in the contract. [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/servicelinker/Azure.ResourceManager.ServiceLinker/src/Azure.ResourceManager.ServiceLinker.csproj], info [Changelog] /home/cloudtest/.nuget/packages/microsoft.dotnet.apicompat/5.0.0-beta.20467.1/build/Microsoft.DotNet.ApiCompat.targets(82,5): error : MembersMustExist : Member 'public Azure.Response<Azure.ResourceManager.ServiceLinker.LinkerResource> Azure.ResourceManager.ServiceLinker.ServiceLinkerExtensions.GetLinkerResource(Azure.ResourceManager.ArmResource, System.String, System.Threading.CancellationToken)' does not exist in the implementation but it does exist in the contract. [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/servicelinker/Azure.ResourceManager.ServiceLinker/src/Azure.ResourceManager.ServiceLinker.csproj], info [Changelog] /home/cloudtest/.nuget/packages/microsoft.dotnet.apicompat/5.0.0-beta.20467.1/build/Microsoft.DotNet.ApiCompat.targets(82,5): error : MembersMustExist : Member 'public System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.ServiceLinker.LinkerResource>> Azure.ResourceManager.ServiceLinker.ServiceLinkerExtensions.GetLinkerResourceAsync(Azure.ResourceManager.ArmClient, Azure.Core.ResourceIdentifier, System.String, System.Threading.CancellationToken)' does not exist in the implementation but it does exist in the contract. [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/servicelinker/Azure.ResourceManager.ServiceLinker/src/Azure.ResourceManager.ServiceLinker.csproj], info [Changelog] /home/cloudtest/.nuget/packages/microsoft.dotnet.apicompat/5.0.0-beta.20467.1/build/Microsoft.DotNet.ApiCompat.targets(82,5): error : MembersMustExist : Member 'public System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.ServiceLinker.LinkerResource>> Azure.ResourceManager.ServiceLinker.ServiceLinkerExtensions.GetLinkerResourceAsync(Azure.ResourceManager.ArmResource, System.String, System.Threading.CancellationToken)' does not exist in the implementation but it does exist in the contract. [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/servicelinker/Azure.ResourceManager.ServiceLinker/src/Azure.ResourceManager.ServiceLinker.csproj], info [Changelog] /home/cloudtest/.nuget/packages/microsoft.dotnet.apicompat/5.0.0-beta.20467.1/build/Microsoft.DotNet.ApiCompat.targets(82,5): error : MembersMustExist : Member 'public Azure.ResourceManager.ServiceLinker.LinkerResourceCollection Azure.ResourceManager.ServiceLinker.ServiceLinkerExtensions.GetLinkerResources(Azure.ResourceManager.ArmClient, Azure.Core.ResourceIdentifier)' does not exist in the implementation but it does exist in the contract. [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/servicelinker/Azure.ResourceManager.ServiceLinker/src/Azure.ResourceManager.ServiceLinker.csproj], info [Changelog] /home/cloudtest/.nuget/packages/microsoft.dotnet.apicompat/5.0.0-beta.20467.1/build/Microsoft.DotNet.ApiCompat.targets(82,5): error : MembersMustExist : Member 'public Azure.ResourceManager.ServiceLinker.LinkerResourceCollection Azure.ResourceManager.ServiceLinker.ServiceLinkerExtensions.GetLinkerResources(Azure.ResourceManager.ArmResource)' does not exist in the implementation but it does exist in the contract. [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/servicelinker/Azure.ResourceManager.ServiceLinker/src/Azure.ResourceManager.ServiceLinker.csproj], info [Changelog] /home/cloudtest/.nuget/packages/microsoft.dotnet.apicompat/5.0.0-beta.20467.1/build/Microsoft.DotNet.ApiCompat.targets(82,5): error : TypesMustExist : Type 'Azure.ResourceManager.ServiceLinker.Models.LinkerResourcePatch' does not exist in the implementation but it does exist in the contract. [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/servicelinker/Azure.ResourceManager.ServiceLinker/src/Azure.ResourceManager.ServiceLinker.csproj], info [Changelog] /home/cloudtest/.nuget/packages/microsoft.dotnet.apicompat/5.0.0-beta.20467.1/build/Microsoft.DotNet.ApiCompat.targets(82,5): error : TypesMustExist : Type 'Azure.ResourceManager.ServiceLinker.Models.SourceConfigurationResult' does not exist in the implementation but it does exist in the contract. [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/servicelinker/Azure.ResourceManager.ServiceLinker/src/Azure.ResourceManager.ServiceLinker.csproj], info [Changelog] /home/cloudtest/.nuget/packages/microsoft.dotnet.apicompat/5.0.0-beta.20467.1/build/Microsoft.DotNet.ApiCompat.targets(96,5): error : ApiCompat failed for '/mnt/vss/_work/1/s/azure-sdk-for-net/artifacts/bin/Azure.ResourceManager.ServiceLinker/Debug/netstandard2.0/Azure.ResourceManager.ServiceLinker.dll' [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/servicelinker/Azure.ResourceManager.ServiceLinker/src/Azure.ResourceManager.ServiceLinker.csproj]
️⚠️ azure-sdk-for-python-track2 warning [Detail]
⚠️Warning [Logs] Generate from 52f1095cb7e657c97ff2f3c8e4c7fdd3ed755a49. SDK Automation 14.0.0command 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 major version of npm available! 8.19.2 -> 9.2.0 cmderr [automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.2.0> cmderr [automation_generate.sh] npm notice Run `npm install -g [email protected]` to update! cmderr [automation_generate.sh] npm notice
️✔️track2_azure-mgmt-servicelinker [View full logs] [Preview SDK Changes]info [Changelog]
️⚠️ azure-sdk-for-java warning [Detail]
⚠️Warning [Logs] Generate from 52f1095cb7e657c97ff2f3c8e4c7fdd3ed755a49. SDK Automation 14.0.0command ./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 available: 22.3 -> 22.3.1 cmderr [init.sh] [notice] To update, run: pip install --upgrade pip cmderr [init.sh] [notice] A new release of pip available: 22.3 -> 22.3.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-servicelinker [View full logs] [Preview SDK Changes]
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
️✔️Succeeded [Logs] Generate from 52f1095cb7e657c97ff2f3c8e4c7fdd3ed755a49. SDK Automation 14.0.0command 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/servicelinker/armservicelinker [View full logs] [Preview SDK Changes] Breaking Change Detectedinfo [Changelog] ### Breaking Changes info [Changelog] info [Changelog] - Struct `LinkerList` has been removed info [Changelog] - Struct `SourceConfigurationResult` has been removed info [Changelog] - Field `SourceConfigurationResult` of struct `LinkerClientListConfigurationsResponse` has been removed info [Changelog] - Field `LinkerList` of struct `LinkerClientListResponse` has been removed info [Changelog] info [Changelog] ### Features Added info [Changelog] info [Changelog] - New value `ActionTypeEnable`, `ActionTypeOptOut` added to type alias `ActionType` info [Changelog] - New value `AuthTypeAccessKey`, `AuthTypeUserAccount` added to type alias `AuthType` info [Changelog] - New value `ClientTypeKafkaSpringBoot` added to type alias `ClientType` info [Changelog] - New value `TargetServiceTypeSelfHostedServer` added to type alias `TargetServiceType` info [Changelog] - New type alias `AccessKeyPermissions` with values `AccessKeyPermissionsListen`, `AccessKeyPermissionsManage`, `AccessKeyPermissionsRead`, `AccessKeyPermissionsSend`, `AccessKeyPermissionsWrite` info [Changelog] - New type alias `AllowType` with values `AllowTypeFalse`, `AllowTypeTrue` info [Changelog] - New type alias `DeleteOrUpdateBehavior` with values `DeleteOrUpdateBehaviorDefault`, `DeleteOrUpdateBehaviorForcedCleanup` info [Changelog] - New type alias `DryrunActionName` with values `DryrunActionNameCreateOrUpdate` info [Changelog] - New type alias `DryrunPrerequisiteResultType` with values `DryrunPrerequisiteResultTypeBasicError`, `DryrunPrerequisiteResultTypePermissionsMissing` info [Changelog] - New type alias `DryrunPreviewOperationType` with values `DryrunPreviewOperationTypeConfigAuth`, `DryrunPreviewOperationTypeConfigConnection`, `DryrunPreviewOperationTypeConfigNetwork` info [Changelog] - New function `*AccessKeyInfoBase.GetAuthInfoBase() *AuthInfoBase` info [Changelog] - New function `*BasicErrorDryrunPrerequisiteResult.GetDryrunPrerequisiteResult() *DryrunPrerequisiteResult` info [Changelog] - New function `NewConfigurationNamesClient(azcore.TokenCredential, *arm.ClientOptions) (*ConfigurationNamesClient, error)` info [Changelog] - New function `*ConfigurationNamesClient.NewListPager(*ConfigurationNamesClientListOptions) *runtime.Pager[ConfigurationNamesClientListResponse]` info [Changelog] - New function `NewConnectorClient(azcore.TokenCredential, *arm.ClientOptions) (*ConnectorClient, error)` info [Changelog] - New function `*ConnectorClient.BeginCreateDryrun(context.Context, string, string, string, string, DryrunResource, *ConnectorClientBeginCreateDryrunOptions) (*runtime.Poller[ConnectorClientCreateDryrunResponse], error)` info [Changelog] - New function `*ConnectorClient.BeginCreateOrUpdate(context.Context, string, string, string, string, LinkerResource, *ConnectorClientBeginCreateOrUpdateOptions) (*runtime.Poller[ConnectorClientCreateOrUpdateResponse], error)` info [Changelog] - New function `*ConnectorClient.BeginDelete(context.Context, string, string, string, string, *ConnectorClientBeginDeleteOptions) (*runtime.Poller[ConnectorClientDeleteResponse], error)` info [Changelog] - New function `*ConnectorClient.DeleteDryrun(context.Context, string, string, string, string, *ConnectorClientDeleteDryrunOptions) (ConnectorClientDeleteDryrunResponse, error)` info [Changelog] - New function `*ConnectorClient.GenerateConfigurations(context.Context, string, string, string, string, *ConnectorClientGenerateConfigurationsOptions) (ConnectorClientGenerateConfigurationsResponse, error)` info [Changelog] - New function `*ConnectorClient.Get(context.Context, string, string, string, string, *ConnectorClientGetOptions) (ConnectorClientGetResponse, error)` info [Changelog] - New function `*ConnectorClient.GetDryrun(context.Context, string, string, string, string, *ConnectorClientGetDryrunOptions) (ConnectorClientGetDryrunResponse, error)` info [Changelog] - New function `*ConnectorClient.NewListDryrunPager(string, string, string, *ConnectorClientListDryrunOptions) *runtime.Pager[ConnectorClientListDryrunResponse]` info [Changelog] - New function `*ConnectorClient.NewListPager(string, string, string, *ConnectorClientListOptions) *runtime.Pager[ConnectorClientListResponse]` info [Changelog] - New function `*ConnectorClient.BeginUpdate(context.Context, string, string, string, string, LinkerPatch, *ConnectorClientBeginUpdateOptions) (*runtime.Poller[ConnectorClientUpdateResponse], error)` info [Changelog] - New function `*ConnectorClient.BeginUpdateDryrun(context.Context, string, string, string, string, DryrunPatch, *ConnectorClientBeginUpdateDryrunOptions) (*runtime.Poller[ConnectorClientUpdateDryrunResponse], error)` info [Changelog] - New function `*ConnectorClient.BeginValidate(context.Context, string, string, string, string, *ConnectorClientBeginValidateOptions) (*runtime.Poller[ConnectorClientValidateResponse], error)` info [Changelog] - New function `*CreateOrUpdateDryrunParameters.GetDryrunParameters() *DryrunParameters` info [Changelog] - New function `*DryrunParameters.GetDryrunParameters() *DryrunParameters` info [Changelog] - New function `*DryrunPrerequisiteResult.GetDryrunPrerequisiteResult() *DryrunPrerequisiteResult` info [Changelog] - New function `NewLinkersClient(azcore.TokenCredential, *arm.ClientOptions) (*LinkersClient, error)` info [Changelog] - New function `*LinkersClient.BeginCreateDryrun(context.Context, string, string, DryrunResource, *LinkersClientBeginCreateDryrunOptions) (*runtime.Poller[LinkersClientCreateDryrunResponse], error)` info [Changelog] - New function `*LinkersClient.DeleteDryrun(context.Context, string, string, *LinkersClientDeleteDryrunOptions) (LinkersClientDeleteDryrunResponse, error)` info [Changelog] - New function `*LinkersClient.GenerateConfigurations(context.Context, string, string, *LinkersClientGenerateConfigurationsOptions) (LinkersClientGenerateConfigurationsResponse, error)` info [Changelog] - New function `*LinkersClient.GetDryrun(context.Context, string, string, *LinkersClientGetDryrunOptions) (LinkersClientGetDryrunResponse, error)` info [Changelog] - New function `*LinkersClient.NewListDryrunPager(string, *LinkersClientListDryrunOptions) *runtime.Pager[LinkersClientListDryrunResponse]` info [Changelog] - New function `*LinkersClient.BeginUpdateDryrun(context.Context, string, string, DryrunPatch, *LinkersClientBeginUpdateDryrunOptions) (*runtime.Poller[LinkersClientUpdateDryrunResponse], error)` info [Changelog] - New function `*PermissionsMissingDryrunPrerequisiteResult.GetDryrunPrerequisiteResult() *DryrunPrerequisiteResult` info [Changelog] - New function `*SelfHostedServer.GetTargetServiceBase() *TargetServiceBase` info [Changelog] - New function `*UserAccountAuthInfo.GetAuthInfoBase() *AuthInfoBase` info [Changelog] - New struct `AccessKeyInfoBase` info [Changelog] - New struct `BasicErrorDryrunPrerequisiteResult` info [Changelog] - New struct `ConfigurationInfo` info [Changelog] - New struct `ConfigurationName` info [Changelog] - New struct `ConfigurationNameItem` info [Changelog] - New struct `ConfigurationNameResult` info [Changelog] - New struct `ConfigurationNames` info [Changelog] - New struct `ConfigurationNamesClient` info [Changelog] - New struct `ConfigurationNamesClientListResponse` info [Changelog] - New struct `ConfigurationResult` info [Changelog] - New struct `ConnectorClient` info [Changelog] - New struct `ConnectorClientCreateDryrunResponse` info [Changelog] - New struct `ConnectorClientCreateOrUpdateResponse` info [Changelog] - New struct `ConnectorClientDeleteResponse` info [Changelog] - New struct `ConnectorClientListDryrunResponse` info [Changelog] - New struct `ConnectorClientListResponse` info [Changelog] - New struct `ConnectorClientUpdateDryrunResponse` info [Changelog] - New struct `ConnectorClientUpdateResponse` info [Changelog] - New struct `ConnectorClientValidateResponse` info [Changelog] - New struct `CreateOrUpdateDryrunParameters` info [Changelog] - New struct `DatabaseAADAuthInfo` info [Changelog] - New struct `DryrunList` info [Changelog] - New struct `DryrunOperationPreview` info [Changelog] - New struct `DryrunPatch` info [Changelog] - New struct `DryrunProperties` info [Changelog] - New struct `DryrunResource` info [Changelog] - New struct `FirewallRules` info [Changelog] - New struct `LinkersClient` info [Changelog] - New struct `LinkersClientCreateDryrunResponse` info [Changelog] - New struct `LinkersClientListDryrunResponse` info [Changelog] - New struct `LinkersClientUpdateDryrunResponse` info [Changelog] - New struct `PermissionsMissingDryrunPrerequisiteResult` info [Changelog] - New struct `PublicNetworkSolution` info [Changelog] - New struct `ResourceList` info [Changelog] - New struct `SelfHostedServer` info [Changelog] - New struct `UserAccountAuthInfo` info [Changelog] - New anonymous field `ConfigurationResult` in struct `LinkerClientListConfigurationsResponse` info [Changelog] - New anonymous field `ResourceList` in struct `LinkerClientListResponse` info [Changelog] - New field `ConfigurationInfo` in struct `LinkerProperties` info [Changelog] - New field `PublicNetworkSolution` in struct `LinkerProperties` info [Changelog] - New field `SystemData` in struct `ProxyResource` info [Changelog] - New field `SystemData` in struct `Resource` info [Changelog] - New field `KeyVaultSecretName` in struct `SecretStore` info [Changelog] - New field `DeleteOrUpdateBehavior` in struct `ServicePrincipalCertificateAuthInfo` info [Changelog] - New field `Roles` in struct `ServicePrincipalCertificateAuthInfo` info [Changelog] - New field `DeleteOrUpdateBehavior` in struct `ServicePrincipalSecretAuthInfo` info [Changelog] - New field `Roles` in struct `ServicePrincipalSecretAuthInfo` info [Changelog] - New field `UserName` in struct `ServicePrincipalSecretAuthInfo` info [Changelog] - New field `DeleteOrUpdateBehavior` in struct `SystemAssignedIdentityAuthInfo` info [Changelog] - New field `Roles` in struct `SystemAssignedIdentityAuthInfo` info [Changelog] - New field `UserName` in struct `SystemAssignedIdentityAuthInfo` info [Changelog] - New field `DeleteOrUpdateBehavior` in struct `UserAssignedIdentityAuthInfo` info [Changelog] - New field `Roles` in struct `UserAssignedIdentityAuthInfo` info [Changelog] - New field `UserName` in struct `UserAssignedIdentityAuthInfo` info [Changelog] - New field `DeleteOrUpdateBehavior` in struct `VNetSolution` info [Changelog] info [Changelog] Total 6 breaking change(s), 142 additive change(s).
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
️✔️Succeeded [Logs] Generate from 52f1095cb7e657c97ff2f3c8e4c7fdd3ed755a49. SDK Automation 14.0.0command 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-servicelinker [View full logs] [Preview SDK Changes] Breaking Change Detectedinfo [Changelog] **Features** info [Changelog] info [Changelog] - Added operation group ConfigurationNames info [Changelog] - Added operation group Connector info [Changelog] - Added operation group Linkers info [Changelog] - Added Interface AccessKeyInfoBase info [Changelog] - Added Interface BasicErrorDryrunPrerequisiteResult info [Changelog] - Added Interface ConfigurationInfo info [Changelog] - Added Interface ConfigurationName info [Changelog] - Added Interface ConfigurationNameItem info [Changelog] - Added Interface ConfigurationNameResult info [Changelog] - Added Interface ConfigurationNamesListNextOptionalParams info [Changelog] - Added Interface ConfigurationNamesListOptionalParams info [Changelog] - Added Interface ConfigurationResult info [Changelog] - Added Interface ConnectorCreateDryrunOptionalParams info [Changelog] - Added Interface ConnectorCreateOrUpdateOptionalParams info [Changelog] - Added Interface ConnectorDeleteDryrunOptionalParams info [Changelog] - Added Interface ConnectorDeleteOptionalParams info [Changelog] - Added Interface ConnectorGenerateConfigurationsOptionalParams info [Changelog] - Added Interface ConnectorGetDryrunOptionalParams info [Changelog] - Added Interface ConnectorGetOptionalParams info [Changelog] - Added Interface ConnectorListDryrunNextOptionalParams info [Changelog] - Added Interface ConnectorListDryrunOptionalParams info [Changelog] - Added Interface ConnectorListNextOptionalParams info [Changelog] - Added Interface ConnectorListOptionalParams info [Changelog] - Added Interface ConnectorUpdateDryrunOptionalParams info [Changelog] - Added Interface ConnectorUpdateOptionalParams info [Changelog] - Added Interface ConnectorValidateOptionalParams info [Changelog] - Added Interface CreateOrUpdateDryrunParameters info [Changelog] - Added Interface DatabaseAadAuthInfo info [Changelog] - Added Interface DryrunList info [Changelog] - Added Interface DryrunOperationPreview info [Changelog] - Added Interface DryrunParameters info [Changelog] - Added Interface DryrunPatch info [Changelog] - Added Interface DryrunPrerequisiteResult info [Changelog] - Added Interface DryrunResource info [Changelog] - Added Interface FirewallRules info [Changelog] - Added Interface LinkerProperties info [Changelog] - Added Interface LinkersCreateDryrunOptionalParams info [Changelog] - Added Interface LinkersDeleteDryrunOptionalParams info [Changelog] - Added Interface LinkersGenerateConfigurationsOptionalParams info [Changelog] - Added Interface LinkersGetDryrunOptionalParams info [Changelog] - Added Interface LinkersListDryrunNextOptionalParams info [Changelog] - Added Interface LinkersListDryrunOptionalParams info [Changelog] - Added Interface LinkersUpdateDryrunOptionalParams info [Changelog] - Added Interface PermissionsMissingDryrunPrerequisiteResult info [Changelog] - Added Interface PublicNetworkSolution info [Changelog] - Added Interface ResourceList info [Changelog] - Added Interface SelfHostedServer info [Changelog] - Added Interface UserAccountAuthInfo info [Changelog] - Added Type Alias AccessKeyPermissions info [Changelog] - Added Type Alias AllowType info [Changelog] - Added Type Alias ConfigurationNamesListNextResponse info [Changelog] - Added Type Alias ConfigurationNamesListResponse info [Changelog] - Added Type Alias ConnectorCreateDryrunResponse info [Changelog] - Added Type Alias ConnectorCreateOrUpdateResponse info [Changelog] - Added Type Alias ConnectorGenerateConfigurationsResponse info [Changelog] - Added Type Alias ConnectorGetDryrunResponse info [Changelog] - Added Type Alias ConnectorGetResponse info [Changelog] - Added Type Alias ConnectorListDryrunNextResponse info [Changelog] - Added Type Alias ConnectorListDryrunResponse info [Changelog] - Added Type Alias ConnectorListNextResponse info [Changelog] - Added Type Alias ConnectorListResponse info [Changelog] - Added Type Alias ConnectorUpdateDryrunResponse info [Changelog] - Added Type Alias ConnectorUpdateResponse info [Changelog] - Added Type Alias ConnectorValidateResponse info [Changelog] - Added Type Alias DeleteOrUpdateBehavior info [Changelog] - Added Type Alias DryrunActionName info [Changelog] - Added Type Alias DryrunParametersUnion info [Changelog] - Added Type Alias DryrunPrerequisiteResultType info [Changelog] - Added Type Alias DryrunPrerequisiteResultUnion info [Changelog] - Added Type Alias DryrunPreviewOperationType info [Changelog] - Added Type Alias LinkersCreateDryrunResponse info [Changelog] - Added Type Alias LinkersGenerateConfigurationsResponse info [Changelog] - Added Type Alias LinkersGetDryrunResponse info [Changelog] - Added Type Alias LinkersListDryrunNextResponse info [Changelog] - Added Type Alias LinkersListDryrunResponse info [Changelog] - Added Type Alias LinkersUpdateDryrunResponse info [Changelog] - Interface LinkerPatch has a new optional parameter configurationInfo info [Changelog] - Interface LinkerPatch has a new optional parameter publicNetworkSolution info [Changelog] - Interface LinkerResource has a new optional parameter configurationInfo info [Changelog] - Interface LinkerResource has a new optional parameter publicNetworkSolution info [Changelog] - Interface Resource has a new optional parameter systemData info [Changelog] - Interface SecretStore has a new optional parameter keyVaultSecretName info [Changelog] - Interface ServicePrincipalCertificateAuthInfo has a new optional parameter deleteOrUpdateBehavior info [Changelog] - Interface ServicePrincipalCertificateAuthInfo has a new optional parameter roles info [Changelog] - Interface ServicePrincipalSecretAuthInfo has a new optional parameter deleteOrUpdateBehavior info [Changelog] - Interface ServicePrincipalSecretAuthInfo has a new optional parameter roles info [Changelog] - Interface SystemAssignedIdentityAuthInfo has a new optional parameter deleteOrUpdateBehavior info [Changelog] - Interface SystemAssignedIdentityAuthInfo has a new optional parameter roles info [Changelog] - Interface UserAssignedIdentityAuthInfo has a new optional parameter deleteOrUpdateBehavior info [Changelog] - Interface UserAssignedIdentityAuthInfo has a new optional parameter roles info [Changelog] - Interface VNetSolution has a new optional parameter deleteOrUpdateBehavior info [Changelog] - Added Enum KnownAccessKeyPermissions info [Changelog] - Added Enum KnownAllowType info [Changelog] - Added Enum KnownDeleteOrUpdateBehavior info [Changelog] - Added Enum KnownDryrunActionName info [Changelog] - Added Enum KnownDryrunPrerequisiteResultType info [Changelog] - Added Enum KnownDryrunPreviewOperationType info [Changelog] - Enum KnownActionType has a new value Enable info [Changelog] - Enum KnownActionType has a new value OptOut info [Changelog] - Enum KnownAuthType has a new value AccessKey info [Changelog] - Enum KnownAuthType has a new value UserAccount info [Changelog] - Enum KnownClientType has a new value KafkaSpringBoot info [Changelog] - Enum KnownTargetServiceType has a new value SelfHostedServer info [Changelog] info [Changelog] **Breaking Changes** info [Changelog] info [Changelog] - Interface LinkerResource no longer has parameter systemData info [Changelog] - Type of parameter authType of interface AuthInfoBase is changed from "secret" | "userAssignedIdentity" | "systemAssignedIdentity" | "servicePrincipalSecret" | "servicePrincipalCertificate" to "accessKey" | "secret" | "userAssignedIdentity" | "systemAssignedIdentity" | "servicePrincipalSecret" | "servicePrincipalCertificate" | "userAccount" info [Changelog] - Type of parameter type of interface TargetServiceBase is changed from "AzureResource" | "ConfluentBootstrapServer" | "ConfluentSchemaRegistry" to "AzureResource" | "ConfluentBootstrapServer" | "SelfHostedServer" | "ConfluentSchemaRegistry"
️⚠️ azure-resource-manager-schemas warning [Detail]
⚠️Warning [Logs] Generate from 52f1095cb7e657c97ff2f3c8e4c7fdd3ed755a49. Schema Automation 14.0.0command .sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json cmderr [initScript.sh] 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
️✔️servicelinker [View full logs]
️️✔️ azure-powershell succeeded [Detail] [Expand]
️✔️Succeeded [Logs]Release - Generate from e7bf3adfa2d5e5cdbb804eec35279501794f461c. SDK Automation 14.0.0command 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.ServiceLinker [View full logs] [Release SDK Changes]
Generated ApiView
| Language | Package Name | ApiView Link |
|---|---|---|
| Go | sdk/resourcemanager/servicelinker/armservicelinker | https://apiview.dev/Assemblies/Review/429b316307b641e6accd8dbde9fd32e3 |
| .Net | Azure.ResourceManager.ServiceLinker | https://apiview.dev/Assemblies/Review/cb48b8c9f4874236a73f40cd4243a5ed |
| JavaScript | @azure/arm-servicelinker | https://apiview.dev/Assemblies/Review/5d5c1f738c4943feb26190429eb432c7 |
Hi, @qianwens Thanks for your PR. I am workflow bot for review process. Here are some small tips.
Hi @qianwens, 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. Note: To avoid breaking change, you can refer to Shift Left Solution for detecting breaking change in early phase at your service code repository.
PR is reviewed in https://github.com/Azure/azure-rest-api-specs-pr/pull/10458. This API version is not published to customer now so that there is no customer impact for this breaking change.
@qianwens , in the future please use the publishing link in original PR targeting private spec repo to create this PR by tool rather than creating this PR manually.
Approved breaking change as it's approved by the original PR in private spec repo.