azure-rest-api-specs icon indicating copy to clipboard operation
azure-rest-api-specs copied to clipboard

Adding VirtualNetwork reference to support QuickConnect SKU for Bastion

Open anvrao1 opened this issue 3 years ago • 12 comments

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

anvrao1 avatar Oct 19 '22 21:10 anvrao1

Hi, @anvrao1 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]

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
    There are no breaking changes.
    compared swaggers (via Oad v0.10.1)] new version base version
    bastionHost.json 2022-07-01(c9bef1e) 2022-05-01(main)
    ️⚠️LintDiff: 0 Warnings warning [Detail]
    compared tags (via openapi-validator v1.13.0) new version base version
    package-2022-07 package-2022-07(c9bef1e) package-2022-07(release-network-Microsoft.Network-2022-07-01)

    The following errors/warnings exist before current PR submission:

    Rule Message
    R4037 - MissingTypeObject The schema 'BastionHostIPConfigurationPropertiesFormat' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Network/stable/2022-07-01/bastionHost.json#L604
    R4037 - MissingTypeObject The schema 'BastionHostIPConfiguration' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Network/stable/2022-07-01/bastionHost.json#L630
    R4037 - MissingTypeObject The schema 'BastionHostPropertiesFormat' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Network/stable/2022-07-01/bastionHost.json#L659
    R4037 - MissingTypeObject The schema 'BastionHost' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Network/stable/2022-07-01/bastionHost.json#L716
    R4037 - MissingTypeObject The schema 'BastionHostListResult' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Network/stable/2022-07-01/bastionHost.json#L740
    R4037 - MissingTypeObject The schema 'BastionShareableLink' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Network/stable/2022-07-01/bastionHost.json#L756
    R4037 - MissingTypeObject The schema 'BastionShareableLinkListRequest' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Network/stable/2022-07-01/bastionHost.json#L783
    R4037 - MissingTypeObject The schema 'BastionShareableLinkListResult' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Network/stable/2022-07-01/bastionHost.json#L795
    R4037 - MissingTypeObject The schema 'BastionActiveSession' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Network/stable/2022-07-01/bastionHost.json#L811
    R4037 - MissingTypeObject The schema 'BastionActiveSessionListResult' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Network/stable/2022-07-01/bastionHost.json#L879
    R4037 - MissingTypeObject The schema 'BastionSessionState' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Network/stable/2022-07-01/bastionHost.json#L895
    R4037 - MissingTypeObject The schema 'BastionSessionDeleteResult' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Network/stable/2022-07-01/bastionHost.json#L915
    R4037 - MissingTypeObject The schema 'SessionIds' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Network/stable/2022-07-01/bastionHost.json#L939
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.Network/stable/2022-07-01/bastionHost.json#L785
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.Network/stable/2022-07-01/bastionHost.json#L797
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.Network/stable/2022-07-01/bastionHost.json#L881
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.Network/stable/2022-07-01/bastionHost.json#L917
    :warning: R1003 - ListInOperationName Since operation 'PutBastionShareableLink' response has model definition 'x-ms-pageable', it should be of the form '_list'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.Network/stable/2022-07-01/bastionHost.json#L334
    :warning: R1003 - ListInOperationName Since operation 'GetBastionShareableLink' response has model definition 'x-ms-pageable', it should be of the form '_list'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.Network/stable/2022-07-01/bastionHost.json#L440
    :warning: R1003 - ListInOperationName Since operation 'GetActiveSessions' response has model definition 'x-ms-pageable', it should be of the form '_list'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.Network/stable/2022-07-01/bastionHost.json#L488
    :warning: R1003 - ListInOperationName Since operation 'DisconnectActiveSessions' response has model definition 'x-ms-pageable', it should be of the form '_list'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.Network/stable/2022-07-01/bastionHost.json#L540
    :warning: R2066 - PostOperationIdContainsUrlVerb OperationId should contain the verb: 'createshareablelinks' in:'PutBastionShareableLink'. Consider updating the operationId
    Location: Microsoft.Network/stable/2022-07-01/bastionHost.json#L334
    :warning: R2066 - PostOperationIdContainsUrlVerb OperationId should contain the verb: 'deleteshareablelinks' in:'DeleteBastionShareableLink'. Consider updating the operationId
    Location: Microsoft.Network/stable/2022-07-01/bastionHost.json#L390
    :warning: R2066 - PostOperationIdContainsUrlVerb OperationId should contain the verb: 'getshareablelinks' in:'GetBastionShareableLink'. Consider updating the operationId
    Location: Microsoft.Network/stable/2022-07-01/bastionHost.json#L440
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️️✔️PrettierCheck succeeded [Detail] [Expand]
    Validation passes for PrettierCheck.
    ️️✔️SpellCheck succeeded [Detail] [Expand]
    Validation passes for SpellCheck.
    ️️✔️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?

    Swagger Generation Artifacts

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

    Breaking Changes Tracking



    ️✔️azure-sdk-for-python-track2 - track2_azure-mgmt-network - 22.1.0
    +	Removed operation group NspLinkReconcileOperations
    +	Removed operation group NspLinkReferenceReconcileOperations
    +	Removed operation group NspLinkReferencesOperations
    +	Removed operation group NspLinksOperations
    ️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from 6d00cd85bf12795cde980513ee31e077ced33ff5. 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]  [Preview SDK Changes]
    ️❌ azure-sdk-for-net-track2 failed [Detail]
    • Failed [Logs] Generate from 6d00cd85bf12795cde980513ee31e077ced33ff5. SDK Automation 14.0.0
      command	pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json
      warn	File azure-sdk-for-net_tmp/initOutput.json not found to read
      command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
      cmderr	[Invoke-GenerateAndBuildV2.ps1] [91mGeneratePackage: [0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:517
      cmderr	[Invoke-GenerateAndBuildV2.ps1] [96mLine |
      cmderr	[Invoke-GenerateAndBuildV2.ps1] [96m 517 | [0m         [96mGeneratePackage -projectFolder $projectFolder -sdkRootPath $s[0m …
      cmderr	[Invoke-GenerateAndBuildV2.ps1] [96m     | [91m         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
      cmderr	[Invoke-GenerateAndBuildV2.ps1] [91m[96m     | [91mFailed to generate sdk. exit code: False
      cmderr	[Invoke-GenerateAndBuildV2.ps1] [0m
      cmderr	[Invoke-GenerateAndBuildV2.ps1] [91mGet-ChildItem: [0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:601
      cmderr	[Invoke-GenerateAndBuildV2.ps1] [96mLine |
      cmderr	[Invoke-GenerateAndBuildV2.ps1] [96m 601 | [0m … rtifacts += [96mGet-ChildItem $artifactsPath -Filter *.nupkg -exclude *.s[0m …
      cmderr	[Invoke-GenerateAndBuildV2.ps1] [96m     | [91m               ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
      cmderr	[Invoke-GenerateAndBuildV2.ps1] [91m[96m     | [91mCannot find path
      cmderr	[Invoke-GenerateAndBuildV2.ps1] [96m     | [91m'/mnt/vss/_work/1/s/azure-sdk-for-net/artifacts/packages/Debug/' because it does not exist.
      cmderr	[Invoke-GenerateAndBuildV2.ps1] [0m
      cmderr	[Invoke-GenerateAndBuildV2.ps1] [91mGeneratePackage: [0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:517
      cmderr	[Invoke-GenerateAndBuildV2.ps1] [96mLine |
      cmderr	[Invoke-GenerateAndBuildV2.ps1] [96m 517 | [0m         [96mGeneratePackage -projectFolder $projectFolder -sdkRootPath $s[0m …
      cmderr	[Invoke-GenerateAndBuildV2.ps1] [96m     | [91m         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
      cmderr	[Invoke-GenerateAndBuildV2.ps1] [91m[96m     | [91mFailed to generate sdk artifact
      cmderr	[Invoke-GenerateAndBuildV2.ps1] [0m
    • Azure.ResourceManager.Network [View full logs]  [Preview SDK Changes]
      info	[Changelog]
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs] Generate from 6d00cd85bf12795cde980513ee31e077ced33ff5. 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
    • ️✔️track2_azure-mgmt-network [View full logs]  [Preview SDK Changes] Breaking Change Detected
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog]   - Removed operation group NspLinkReconcileOperations
      info	[Changelog]   - Removed operation group NspLinkReferenceReconcileOperations
      info	[Changelog]   - Removed operation group NspLinkReferencesOperations
      info	[Changelog]   - Removed operation group NspLinksOperations
    ️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from 6d00cd85bf12795cde980513ee31e077ced33ff5. 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]  [Preview SDK Changes]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog] - New struct `DelegationProperties`
      info	[Changelog] - New struct `PartnerManagedResourceProperties`
      info	[Changelog] - New field `PartnerManagedResource` in struct `VirtualAppliancePropertiesFormat`
      info	[Changelog] - New field `DeploymentType` in struct `VirtualAppliancePropertiesFormat`
      info	[Changelog] - New field `Delegation` in struct `VirtualAppliancePropertiesFormat`
      info	[Changelog] - New field `VirtualNetwork` in struct `BastionHostPropertiesFormat`
      info	[Changelog] - New field `CustomBlockResponseBody` in struct `PolicySettings`
      info	[Changelog] - New field `CustomBlockResponseStatusCode` in struct `PolicySettings`
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 7 additive change(s).
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from 6d00cd85bf12795cde980513ee31e077ced33ff5. SDK Automation 14.0.0
      command	sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json
      warn	File azure-sdk-for-js_tmp/initOutput.json not found to read
      command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json
    • ️✔️@azure/arm-network [View full logs]  [Preview SDK Changes]
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Added Interface DelegationProperties
      info	[Changelog]   - Added Interface PartnerManagedResourceProperties
      info	[Changelog]   - Interface BastionHost has a new optional parameter virtualNetwork
      info	[Changelog]   - Interface NetworkVirtualAppliance has a new optional parameter delegation
      info	[Changelog]   - Interface NetworkVirtualAppliance has a new optional parameter deploymentType
      info	[Changelog]   - Interface NetworkVirtualAppliance has a new optional parameter partnerManagedResource
      info	[Changelog]   - Interface PolicySettings has a new optional parameter customBlockResponseBody
      info	[Changelog]   - Interface PolicySettings has a new optional parameter customBlockResponseStatusCode
    ️🔄 azure-resource-manager-schemas inProgress [Detail]
    ️❌ azure-powershell failed [Detail]
    • Failed [Logs] Generate from 6d00cd85bf12795cde980513ee31e077ced33ff5. 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]  [Preview SDK Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    Generated ApiView

    Language Package Name ApiView Link
    Go sdk/resourcemanager/network/armnetwork https://apiview.dev/Assemblies/Review/806daed55c3b430881779ebb60a690d4
    Java azure-resourcemanager-network-generated https://apiview.dev/Assemblies/Review/181370a0696144458a9d2a8ca8276053
    JavaScript @azure/arm-network https://apiview.dev/Assemblies/Review/993fc2cf0f124e99b1c1125f9d806f2d
    Python track2_azure-mgmt-network Create ApiView timeout. Package is too large and we cannot create ApiView for it.

    Thank you for your contribution anvrao1! We will review the pull request and get back to you soon.

    ghost avatar Oct 19 '22 21:10 ghost

    /azp run

    anvrao1 avatar Oct 24 '22 23:10 anvrao1

    Commenter does not have sufficient privileges for PR 21193 in repo Azure/azure-rest-api-specs

    azure-pipelines[bot] avatar Oct 24 '22 23:10 azure-pipelines[bot]

    /azp run

    anvrao1 avatar Oct 25 '22 21:10 anvrao1

    Commenter does not have sufficient privileges for PR 21193 in repo Azure/azure-rest-api-specs

    azure-pipelines[bot] avatar Oct 25 '22 21:10 azure-pipelines[bot]

    /azp run

    anvrao1 avatar Oct 25 '22 22:10 anvrao1

    Commenter does not have sufficient privileges for PR 21193 in repo Azure/azure-rest-api-specs

    azure-pipelines[bot] avatar Oct 25 '22 22:10 azure-pipelines[bot]

    Hi @anvrao1, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.

    TaskHow to fixPriority
    AvocadoFix-AvocadoHigh
    Semantic validationFix-SemanticValidation-ErrorHigh
    Model validationFix-ModelValidation-ErrorHigh
    LintDiffFix-LintDiffhigh
    If you need further help, please feedback via swagger feedback.

    Hi, @anvrao1. 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.

    ghost avatar Nov 27 '22 16:11 ghost

    @anvrao1 , let me know you want me to merge this PR. The title still includes DoNotMerge.

    raych1 avatar Jan 13 '23 04:01 raych1