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

Fix networking property documentation #22308

Merged
merged 1 commit into from
Jan 28, 2023
Merged

Fix networking property documentation #22308

merged 1 commit into from
Jan 28, 2023

Conversation

matthchr
Copy link
Member

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:

  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: Fixing small documentation issue in current version
  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, @matthchr Thanks for your PR. I am workflow bot for review process. Here are some small tips.

  • Please ensure to do self-check against checklists in first PR comment.
  • PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.
  • For specs comparison cross API versions, Use API Specs Comparison Report Generator
  • If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

  • Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected]

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jan 25, 2023

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    compared swaggers (via Oad v0.10.4)] new version base version
    network.json 2022-07-01(250bc66) 2022-07-01(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-07 package-2022-07(250bc66) package-2022-07(main)

    The following errors/warnings exist before current PR submission:

    Only 30 items are listed, please refer to log for more details.

    Rule Message
    GetCollectionResponseSchema The response in the GET collection operation 'ApplicationGateways_List' does not match the response definition in the individual GET operation 'ApplicationGateways_Get' .
    Location: Microsoft.Network/stable/2022-07-01/network.json#L36
    GetCollectionResponseSchema The response in the GET collection operation 'ApplicationGatewayPrivateEndpointConnections_List' does not match the response definition in the individual GET operation 'ApplicationGatewayPrivateEndpointConnections_Get' .
    Location: Microsoft.Network/stable/2022-07-01/network.json#L36
    GetCollectionResponseSchema The response in the GET collection operation 'ApplicationGateways_ListAvailableSslPredefinedPolicies' does not match the response definition in the individual GET operation 'ApplicationGateways_GetSslPredefinedPolicy' .
    Location: Microsoft.Network/stable/2022-07-01/network.json#L36
    GetCollectionResponseSchema The response in the GET collection operation 'ApplicationSecurityGroups_ListAll' does not match the response definition in the individual GET operation 'ApplicationSecurityGroups_Get' .
    Location: Microsoft.Network/stable/2022-07-01/network.json#L36
    GetCollectionResponseSchema The response in the GET collection operation 'AzureFirewalls_List' does not match the response definition in the individual GET operation 'AzureFirewalls_Get' .
    Location: Microsoft.Network/stable/2022-07-01/network.json#L36
    GetCollectionResponseSchema The response in the GET collection operation 'WebCategories_ListBySubscription' does not match the response definition in the individual GET operation 'WebCategories_Get' .
    Location: Microsoft.Network/stable/2022-07-01/network.json#L36
    GetCollectionResponseSchema The response in the GET collection operation 'BastionHosts_List' does not match the response definition in the individual GET operation 'BastionHosts_Get' .
    Location: Microsoft.Network/stable/2022-07-01/network.json#L36
    GetCollectionResponseSchema The response in the GET collection operation 'NetworkInterfaces_ListCloudServiceRoleInstanceNetworkInterfaces' does not match the response definition in the individual GET operation 'NetworkInterfaces_GetCloudServiceNetworkInterface' .
    Location: Microsoft.Network/stable/2022-07-01/network.json#L36
    GetCollectionResponseSchema The response in the GET collection operation 'PublicIPAddresses_ListCloudServiceRoleInstancePublicIPAddresses' does not match the response definition in the individual GET operation 'PublicIPAddresses_GetCloudServicePublicIPAddress' .
    Location: Microsoft.Network/stable/2022-07-01/network.json#L36
    GetCollectionResponseSchema The response in the GET collection operation 'VipSwap_List' does not match the response definition in the individual GET operation 'VipSwap_Get' .
    Location: Microsoft.Network/stable/2022-07-01/network.json#L36
    GetCollectionResponseSchema The response in the GET collection operation 'CustomIPPrefixes_ListAll' does not match the response definition in the individual GET operation 'CustomIPPrefixes_Get' .
    Location: Microsoft.Network/stable/2022-07-01/network.json#L36
    GetCollectionResponseSchema The response in the GET collection operation 'DdosProtectionPlans_List' does not match the response definition in the individual GET operation 'DdosProtectionPlans_Get' .
    Location: Microsoft.Network/stable/2022-07-01/network.json#L36
    GetCollectionResponseSchema The response in the GET collection operation 'DscpConfiguration_List' does not match the response definition in the individual GET operation 'DscpConfiguration_Get' .
    Location: Microsoft.Network/stable/2022-07-01/network.json#L36
    GetCollectionResponseSchema The response in the GET collection operation 'ExpressRouteCircuitAuthorizations_List' does not match the response definition in the individual GET operation 'ExpressRouteCircuitAuthorizations_Get' .
    Location: Microsoft.Network/stable/2022-07-01/network.json#L36
    GetCollectionResponseSchema The response in the GET collection operation 'ExpressRouteCircuitPeerings_List' does not match the response definition in the individual GET operation 'ExpressRouteCircuitPeerings_Get' .
    Location: Microsoft.Network/stable/2022-07-01/network.json#L36
    GetCollectionResponseSchema The response in the GET collection operation 'ExpressRouteCircuitConnections_List' does not match the response definition in the individual GET operation 'ExpressRouteCircuitConnections_Get' .
    Location: Microsoft.Network/stable/2022-07-01/network.json#L36
    GetCollectionResponseSchema The response in the GET collection operation 'PeerExpressRouteCircuitConnections_List' does not match the response definition in the individual GET operation 'PeerExpressRouteCircuitConnections_Get' .
    Location: Microsoft.Network/stable/2022-07-01/network.json#L36
    GetCollectionResponseSchema The response in the GET collection operation 'ExpressRouteCircuits_List' does not match the response definition in the individual GET operation 'ExpressRouteCircuits_Get' .
    Location: Microsoft.Network/stable/2022-07-01/network.json#L36
    GetCollectionResponseSchema The response in the GET collection operation 'ExpressRouteCrossConnections_List' does not match the response definition in the individual GET operation 'ExpressRouteCrossConnections_Get' .
    Location: Microsoft.Network/stable/2022-07-01/network.json#L36
    GetCollectionResponseSchema The response in the GET collection operation 'ExpressRouteCrossConnectionPeerings_List' does not match the response definition in the individual GET operation 'ExpressRouteCrossConnectionPeerings_Get' .
    Location: Microsoft.Network/stable/2022-07-01/network.json#L36
    GetCollectionResponseSchema The response in the GET collection operation 'ExpressRoutePortsLocations_List' does not match the response definition in the individual GET operation 'ExpressRoutePortsLocations_Get' .
    Location: Microsoft.Network/stable/2022-07-01/network.json#L36
    GetCollectionResponseSchema The response in the GET collection operation 'ExpressRoutePorts_ListByResourceGroup' does not match the response definition in the individual GET operation 'ExpressRoutePorts_Get' .
    Location: Microsoft.Network/stable/2022-07-01/network.json#L36
    GetCollectionResponseSchema The response in the GET collection operation 'ExpressRouteLinks_List' does not match the response definition in the individual GET operation 'ExpressRouteLinks_Get' .
    Location: Microsoft.Network/stable/2022-07-01/network.json#L36
    GetCollectionResponseSchema The response in the GET collection operation 'ExpressRoutePortAuthorizations_List' does not match the response definition in the individual GET operation 'ExpressRoutePortAuthorizations_Get' .
    Location: Microsoft.Network/stable/2022-07-01/network.json#L36
    GetCollectionResponseSchema The response in the GET collection operation 'ExpressRouteProviderPortsLocation_List' does not match the response definition in the individual GET operation 'ExpressRouteProviderPort' .
    Location: Microsoft.Network/stable/2022-07-01/network.json#L36
    GetCollectionResponseSchema The response in the GET collection operation 'FirewallPolicies_List' does not match the response definition in the individual GET operation 'FirewallPolicies_Get' .
    Location: Microsoft.Network/stable/2022-07-01/network.json#L36
    GetCollectionResponseSchema The response in the GET collection operation 'FirewallPolicyRuleCollectionGroups_List' does not match the response definition in the individual GET operation 'FirewallPolicyRuleCollectionGroups_Get' .
    Location: Microsoft.Network/stable/2022-07-01/network.json#L36
    GetCollectionResponseSchema The response in the GET collection operation 'FirewallPolicyIdpsSignaturesOverrides_List' does not match the response definition in the individual GET operation 'FirewallPolicyIdpsSignaturesOverrides_Get' .
    Location: Microsoft.Network/stable/2022-07-01/network.json#L36
    GetCollectionResponseSchema The response in the GET collection operation 'IpAllocations_List' does not match the response definition in the individual GET operation 'IpAllocations_Get' .
    Location: Microsoft.Network/stable/2022-07-01/network.json#L36
    GetCollectionResponseSchema The response in the GET collection operation 'IpGroups_ListByResourceGroup' does not match the response definition in the individual GET operation 'IpGroups_Get' .
    Location: Microsoft.Network/stable/2022-07-01/network.json#L36
    ️️✔️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: 0 Errors, 0 Warnings failed [Detail]
    ️️✔️~[Staging] CadlAPIView 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.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jan 25, 2023

    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/network/armnetwork - 3.0.0
    +	Type of `BastionActiveSession.StartTime` has been changed from `interface{}` to `any`

    ️❌ azure-sdk-for-net failed [Detail]
    • Code Generator Failed [Logs]Release - Generate from 50f7448. SDK Automation 14.0.0
      warn	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
    • Microsoft.Azure.Management.Network [View full logs]  [Release SDK Changes]
      cmderr	[msbuild] The command could not be loaded, possibly because:
      cmderr	[msbuild]   * You intended to execute a .NET application:
      cmderr	[msbuild]       The application 'msbuild' does not exist.
      cmderr	[msbuild]   * You intended to execute a .NET SDK command:
      cmderr	[msbuild]       A compatible .NET SDK was not found.
      cmderr	[msbuild] Requested SDK version: 7.0.101
      cmderr	[msbuild] global.json file: /mnt/vss/_work/1/s/azure-sdk-for-net/global.json
      cmderr	[msbuild] Installed SDKs:
      cmderr	[msbuild] Install the [7.0.101] .NET SDK or update [/mnt/vss/_work/1/s/azure-sdk-for-net/global.json] to match an installed SDK.
      cmderr	[msbuild] Learn about SDK resolution:
      cmderr	[msbuild] https://aka.ms/dotnet/sdk-not-found
      error	Script return with result [failed] code [145] signal [null] cwd [azure-sdk-for-net]: dotnet
    ️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 50f7448. 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
      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]  [Release SDK Changes]
      info	[Changelog]
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 50f7448. 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]
      cmderr	[automation_generate.sh] npm notice New major version of npm available! 8.19.3 -> 9.4.0
      cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.4.0>
      cmderr	[automation_generate.sh] npm notice Run `npm install -g [email protected]` to update!
      cmderr	[automation_generate.sh] npm notice
    • ️✔️track2_azure-mgmt-network [View full logs]  [Release SDK Changes]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog]   - Model NspLink has a new parameter remote_perimeter_location
      info	[Changelog]   - Model NspLinkReference has a new parameter remote_perimeter_location
    ️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 50f7448. 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/network/armnetwork [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog] - Type of `BastionActiveSession.StartTime` has been changed from `interface{}` to `any`
      info	[Changelog]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog] - New value `ApplicationGatewaySKUNameStandardBasic` added to type alias `ApplicationGatewaySKUName`
      info	[Changelog] - New value `ApplicationGatewayTierStandardBasic` added to type alias `ApplicationGatewayTier`
      info	[Changelog]
      info	[Changelog] Total 1 breaking change(s), 2 additive change(s).
    ️❌ azure-sdk-for-js failed [Detail]
    • Failed [Logs]Release - Generate from 50f7448. 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
      cmderr	[automation_generate.sh] [ERROR] Error:
      cmderr	[automation_generate.sh] [ERROR] An error occurred while run build for readme file: "specification/network/resource-manager/readme.md":
      cmderr	[automation_generate.sh] [ERROR] Err: Error: Command failed: rush build -t @azure/arm-network
      cmderr	[automation_generate.sh] [ERROR] Stderr: "null"
      cmderr	[automation_generate.sh] [ERROR] Stdout: "null"
      cmderr	[automation_generate.sh] [ERROR] ErrorStack: "Error: Command failed: rush build -t @azure/arm-network
      cmderr	[automation_generate.sh] [ERROR]     at checkExecSyncError (node:child_process:861:11)
      cmderr	[automation_generate.sh] [ERROR]     at Object.execSync (node:child_process:932:15)
      cmderr	[automation_generate.sh] [ERROR]     at Object.<anonymous> (/opt/hostedtoolcache/node/16.19.0/x64/lib/node_modules/@azure-tools/js-sdk-release-tools/dist/hlc/generateMgmt.js:87:33)
      cmderr	[automation_generate.sh] [ERROR]     at Generator.next (<anonymous>)
      cmderr	[automation_generate.sh] [ERROR]     at fulfilled (/opt/hostedtoolcache/node/16.19.0/x64/lib/node_modules/@azure-tools/js-sdk-release-tools/node_modules/tslib/tslib.js:112:62)
      cmderr	[automation_generate.sh] [ERROR]     at processTicksAndRejections (node:internal/process/task_queues:96:5)"
    • @azure/arm-network [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 inProgress [Detail]
    ️❌ azure-powershell failed [Detail]
    • Failed [Logs]Release - Generate from 50f7448. 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.network [View full logs]  [Release SDK Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    @ghost ghost added the Network label Jan 25, 2023
    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jan 25, 2023

    Generated ApiView

    Language Package Name ApiView Link
    Go sdk/resourcemanager/network/armnetwork Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.
    Java azure-resourcemanager-network-generated Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.
    .Net Azure.ResourceManager.Network Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    3 participants