azure-rest-api-specs
azure-rest-api-specs copied to clipboard
Published
20 hours ago •
Azure
Azure
Jiaczh network 2022 05 01
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
- [ ] 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.
- 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:
- [ ] 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 appy 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 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.
Hi, @jiaczh Thanks for your PR. I am workflow bot for review process. Here are some small tips.
![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 succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️LintDiff succeeded [Detail] [Expand]
Validation passes for LintDiff.
| compared tags (via openapi-validator v1.13.0) | new version | base version |
|---|---|---|
| default | default(2fef1e7) | default(network-2022-05-01) |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️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.
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
![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]
️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]
Breaking Changes Tracking
️✔️azure-sdk-for-go - armnetwork - 2.0.0️✔️azure-sdk-for-python-track2 - track2_azure-mgmt-network - 20.0.0️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]
️✔️Succeeded [Logs] Generate from 4d6fe0798a3801d66064d3bd9d4d79064ce7b8d4. 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 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
️✔️Azure.ResourceManager.Network [View full logs] [Preview SDK Changes]info [Changelog]
️❌ azure-sdk-for-net failed [Detail]
❌Failed [Logs] Generate from 4d6fe0798a3801d66064d3bd9d4d79064ce7b8d4. SDK Automation 14.0.0warn Skip initScript due to not configured command sudo apt-get install -y dotnet-sdk-6.0 command autorest --version=2.0.4421 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION [email protected]/[email protected] --csharp-sdks-folder=/mnt/vss/_work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/network/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 cmderr [Autorest] No usable version of the libssl was found cmderr [Autorest] FATAL: csharp/simplifier - FAILED cmderr [Autorest] FATAL: Error: [Exception] AutoRest extension '@microsoft.azure/autorest.csharp' terminated. cmderr [Autorest] Process() cancelled due to exception : [Exception] AutoRest extension '@microsoft.azure/autorest.csharp' terminated. error Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-net]: autorest warn Skip package processing as generation is failed
️⚠️ azure-sdk-for-python-track2 warning [Detail]
⚠️Warning [Logs] Generate from 4d6fe0798a3801d66064d3bd9d4d79064ce7b8d4. 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] config global `--global`, `--local` are deprecated. Use `--location=global` instead.
️✔️track2_azure-mgmt-network [View full logs] [Preview SDK Changes] Breaking Change Detectedinfo [Changelog] **Features** info [Changelog] info [Changelog] - Added operation NetworkSecurityPerimetersOperations.check_members info [Changelog] - Added operation NetworkSecurityPerimetersOperations.query info [Changelog] - Added operation group NspAccessRulesReconcileOperations info [Changelog] - Added operation group NspAssociationsProxyOperations info [Changelog] - Model ApplicationGatewayRoutingRule has a new parameter priority info [Changelog] - Model NetworkSecurityPerimeter has a new parameter perimeter_guid info [Changelog] info [Changelog] **Breaking changes** info [Changelog] info [Changelog] - Model NetworkSecurityPerimeter no longer has parameter description info [Changelog] - Model NetworkSecurityPerimeter no longer has parameter display_name info [Changelog] - Model NetworkSecurityPerimeter no longer has parameter etag info [Changelog] - Model NspProfile no longer has parameter enabled_log_categories
️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]
️✔️Succeeded [Logs] Generate from 4d6fe0798a3801d66064d3bd9d4d79064ce7b8d4. SDK Automation 14.0.0command ./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json command ./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
️✔️azure-resourcemanager-network-generated [View full logs] [Preview SDK Changes]
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
️✔️Succeeded [Logs] Generate from 4d6fe0798a3801d66064d3bd9d4d79064ce7b8d4. 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
️✔️armnetwork [View full logs] [Preview SDK Changes] Breaking Change Detectedinfo [Changelog] ### Breaking Changes info [Changelog] info [Changelog] - Struct `ExplicitProxySettings` has been removed info [Changelog] - Field `ExplicitProxySettings` of struct `FirewallPolicyPropertiesFormat` has been removed info [Changelog] info [Changelog] ### Features Added info [Changelog] info [Changelog] - New const `ActionTypeLog` info [Changelog] - New const `ExpressRoutePortsBillingTypeMeteredData` info [Changelog] - New const `ActionTypeAllow` info [Changelog] - New const `SlotTypeStaging` info [Changelog] - New const `SlotTypeProduction` info [Changelog] - New const `ActionTypeAnomalyScoring` info [Changelog] - New const `ManagedRuleEnabledStateEnabled` info [Changelog] - New const `ActionTypeBlock` info [Changelog] - New const `ExpressRoutePortsBillingTypeUnlimitedData` info [Changelog] - New function `PossibleSlotTypeValues() []SlotType` info [Changelog] - New function `NewVipSwapClient(string, azcore.TokenCredential, *arm.ClientOptions) (*VipSwapClient, error)` info [Changelog] - New function `*VipSwapClient.BeginCreate(context.Context, string, string, SwapResource, *VipSwapClientBeginCreateOptions) (*runtime.Poller[VipSwapClientCreateResponse], error)` info [Changelog] - New function `*VipSwapClient.Get(context.Context, string, string, *VipSwapClientGetOptions) (VipSwapClientGetResponse, error)` info [Changelog] - New function `PossibleExpressRoutePortsBillingTypeValues() []ExpressRoutePortsBillingType` info [Changelog] - New function `*VipSwapClient.List(context.Context, string, string, *VipSwapClientListOptions) (VipSwapClientListResponse, error)` info [Changelog] - New function `PossibleActionTypeValues() []ActionType` info [Changelog] - New struct `ExplicitProxy` info [Changelog] - New struct `SwapResource` info [Changelog] - New struct `SwapResourceListResult` info [Changelog] - New struct `SwapResourceProperties` info [Changelog] - New struct `VipSwapClient` info [Changelog] - New struct `VipSwapClientBeginCreateOptions` info [Changelog] - New struct `VipSwapClientCreateResponse` info [Changelog] - New struct `VipSwapClientGetOptions` info [Changelog] - New struct `VipSwapClientGetResponse` info [Changelog] - New struct `VipSwapClientListOptions` info [Changelog] - New struct `VipSwapClientListResponse` info [Changelog] - New struct `VirtualNetworkGatewayPolicyGroup` info [Changelog] - New struct `VirtualNetworkGatewayPolicyGroupMember` info [Changelog] - New struct `VirtualNetworkGatewayPolicyGroupProperties` info [Changelog] - New struct `VngClientConnectionConfiguration` info [Changelog] - New struct `VngClientConnectionConfigurationProperties` info [Changelog] - New field `EnablePrivateLinkFastPath` in struct `VirtualNetworkGatewayConnectionListEntityPropertiesFormat` info [Changelog] - New field `Action` in struct `ManagedRuleOverride` info [Changelog] - New field `EnablePrivateLinkFastPath` in struct `ExpressRouteConnectionProperties` info [Changelog] - New field `VirtualNetworkGatewayPolicyGroups` in struct `VirtualNetworkGatewayPropertiesFormat` info [Changelog] - New field `ExplicitProxy` in struct `FirewallPolicyPropertiesFormat` info [Changelog] - New field `EnablePrivateLinkFastPath` in struct `VirtualNetworkGatewayConnectionPropertiesFormat` info [Changelog] - New field `BillingType` in struct `ExpressRoutePortPropertiesFormat` info [Changelog] - New field `VngClientConnectionConfigurations` in struct `VPNClientConfiguration` info [Changelog] - New field `ColoLocation` in struct `ExpressRouteLinkPropertiesFormat` info [Changelog] - New field `DisableTCPStateTracking` in struct `InterfacePropertiesFormat` info [Changelog] info [Changelog] Total 3 breaking change(s), 58 additive change(s).
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
️✔️Succeeded [Logs] Generate from 4d6fe0798a3801d66064d3bd9d4d79064ce7b8d4. 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-network [View full logs] [Preview SDK Changes]info [Changelog] **Features** info [Changelog] info [Changelog] - Added operation group VipSwap info [Changelog] - Added Interface SwapResource info [Changelog] - Added Interface SwapResourceListResult info [Changelog] - Added Interface SwapResourceProperties info [Changelog] - Added Interface VipSwapCreateOptionalParams info [Changelog] - Added Interface VipSwapGetOptionalParams info [Changelog] - Added Interface VipSwapListOptionalParams info [Changelog] - Added Interface VirtualNetworkGatewayPolicyGroup info [Changelog] - Added Interface VirtualNetworkGatewayPolicyGroupMember info [Changelog] - Added Interface VngClientConnectionConfiguration info [Changelog] - Added Type Alias ActionType info [Changelog] - Added Type Alias ExpressRoutePortsBillingType info [Changelog] - Added Type Alias SlotType info [Changelog] - Added Type Alias VipSwapGetResponse info [Changelog] - Added Type Alias VipSwapListResponse info [Changelog] - Interface ExpressRouteConnection has a new optional parameter enablePrivateLinkFastPath info [Changelog] - Interface ExpressRouteLink has a new optional parameter coloLocation info [Changelog] - Interface ExpressRoutePort has a new optional parameter billingType info [Changelog] - Interface ManagedRuleOverride has a new optional parameter action info [Changelog] - Interface NetworkInterface has a new optional parameter disableTcpStateTracking info [Changelog] - Interface VirtualNetworkGateway has a new optional parameter virtualNetworkGatewayPolicyGroups info [Changelog] - Interface VirtualNetworkGatewayConnection has a new optional parameter enablePrivateLinkFastPath info [Changelog] - Interface VirtualNetworkGatewayConnectionListEntity has a new optional parameter enablePrivateLinkFastPath info [Changelog] - Interface VpnClientConfiguration has a new optional parameter vngClientConnectionConfigurations info [Changelog] - Class NetworkManagementClient has a new parameter vipSwap info [Changelog] - Added Enum KnownActionType info [Changelog] - Added Enum KnownExpressRoutePortsBillingType info [Changelog] - Enum KnownManagedRuleEnabledState has a new value Enabled error breakingChangeTracking is enabled, but version or changelogItem is not found in output.
️⚠️ azure-resource-manager-schemas warning [Detail]
⚠️Warning [Logs] Generate from 4d6fe0798a3801d66064d3bd9d4d79064ce7b8d4. 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] 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 warn Skip detect changed packages
️❌ azure-powershell failed [Detail]
❌Failed [Logs] Generate from 4d6fe0798a3801d66064d3bd9d4d79064ce7b8d4. 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.network [View full logs] [Preview SDK Changes]
Generated ApiView
| Language | Package Name | ApiView Link |
|---|---|---|
| Java | azure-resourcemanager-network-generated | https://apiview.dev/Assemblies/Review/2bcda8dafac04f9dbfafcabf52a3174e |
| .Net | Azure.ResourceManager.Network | There is no API change compared with the previous version |
| JavaScript | @azure/arm-network | https://apiview.dev/Assemblies/Review/75ee8c585c50492b8224f6ce083eb905 |
| Python | track2_azure-mgmt-network | Create ApiView timeout. Package is too large and we cannot create ApiView for it. |
How can Generate track 1 sdk locally? I try to run autorest but its returning with 0 file generated:
Hi, @jiaczh. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.
Hi, @jiaczh. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee.