Azure
Updated the new endpoint type AzureArcNetwork and some additional properties
…uired properties
ARM (Control Plane) API Specification Update Pull Request
Tip: overwhelmed by all this guidance? See the
Getting helpsection at the bottom of this PR description.
PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
Click here to see the details of Step 1
Breaking changes review (Diagram Step 1)
If the automation determines you have breaking changes, i.e. Step 1 from the diagram applies to you,
you must follow the breaking changes process.
IMPORTANT This applies even if:
- The tool fails while it shouldn't, e.g. due to runtime exception, or incorrect detection of breaking changes.
- You believe there is no need for you to request breaking change approval, for any reason. Such claims must be reviewed, and the process is the same.
Click here to see the details of Step 2
ARM API changes review (Diagram Step 2)
- If this PR is in purview of ARM review then automation will add the
ARMReviewlabel. - If you want to force ARM review, add the label yourself.
- Proceed according to the diagram at the top of this comment.
Click here to see the diagram footnotes
Diagram footnotes
[1] ARM review queue (for merge queues, see [2])
The PRs are processed by time opened, ascending. Your PR may show up on 2nd or later page.
If you addressed Step 1 from the diagram and your PR is not showing up in the queue, ensure the label ARMChangesRequested
is removed from your PR. This should cause the label WaitForARMFeedback to be added.
[2] public repo merge queue, private repo merge queue (for ARM review queue, [1])
If you need further help with anything, see Getting help section below.
Purpose of this PR
What's the purpose of this PR? Check all that apply. This is mandatory!
- [ ] New API version. (If API spec is not defined in TypeSpec, the PR should have been generated using OpenAPI Hub).
- [x] Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
- [ ] Update existing version to fix swagger quality issues in S360.
- [ ] Other, please clarify:
- edit this with your clarification
Due diligence checklist
To merge this PR, you must go through the following checklist and confirm you understood and followed the instructions by checking all the boxes:
- [x] I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
- [x] I have reviewed following Resource Provider guidelines, including
ARM resource provider contract and
REST guidelines (estimated time: 4 hours).
I understand this is required before I can proceed to the Diagram Step 2, "ARM API changes Review", for this PR.
Additional information
Viewing API changes
For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.
Suppressing failures
If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the Swagger-Suppression-Process to get approval.
Getting help
- First, please carefully read through this PR description, from top to bottom. Please fill out the
Purpose of this PRandDue diligence checklist. - To understand what you must do next to merge this PR, see the
Next Steps to Mergecomment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state. - For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure and https://aka.ms/ci-fix.
- If the PR CI checks appear to be stuck in
queuedstate, please add a comment with contents/azp run. This should result in a new comment denoting aPR validation pipelinehas started and the checks should be updated after few minutes. - If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.
Next Steps to Merge
✅ All automated merging requirements have been met! Refer to step 4 in the PR workflow diagram (even if your PR is for data plane, not ARM).![openapi-pipeline-app[bot] avatar](https://avatars.githubusercontent.com/in/65541?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.
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| networkWatcher.json | 2023-11-01(8bac23e) | 2023-09-01(main) |
️️✔️LintDiff succeeded [Detail] [Expand]
Validation passes for LintDiff.
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
️️✔️ApiDocPreview succeeded [Detail] [Expand]
Please click here to preview with your @microsoft account.
️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
️✔️Succeeded [Logs] Generate from 1699bba0b14aaa2fdabe01caca6e5e9170cb1884. 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 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
️✔️Microsoft.Azure.Management.Network [View full logs] [Preview SDK Changes]
️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]
️✔️Succeeded [Logs] Generate from 1699bba0b14aaa2fdabe01caca6e5e9170cb1884. 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
️✔️Azure.ResourceManager.Network [View full logs] [Preview SDK Changes]info [Changelog]
️⚠️ azure-sdk-for-python-track2 warning [Detail]
⚠️Warning [Logs] Generate from 1699bba0b14aaa2fdabe01caca6e5e9170cb1884. 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: azure-devtools 1.2.1 does not provide the extra 'ci-tools' cmderr [automation_init.sh] WARNING: azure-devtools 1.2.1 does not provide the extra 'ci-tools' 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] New minor version of npm available! 10.2.3 -> 10.4.0 cmderr [automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.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] [Preview SDK Changes]info [Changelog] ### Features Added info [Changelog] info [Changelog] - Added operation group FirewallPolicyDeploymentsOperations info [Changelog] - Added operation group FirewallPolicyDraftsOperations info [Changelog] - Added operation group FirewallPolicyRuleCollectionGroupDraftsOperations info [Changelog] - Model BastionHost has a new parameter zones info [Changelog] - Model ConnectionMonitorEndpoint has a new parameter location_details info [Changelog] - Model ConnectionMonitorEndpoint has a new parameter subscription_id
️⚠️ azure-sdk-for-java warning [Detail]
⚠️Warning [Logs] Generate from 1699bba0b14aaa2fdabe01caca6e5e9170cb1884. 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 is available: 23.0.1 -> 23.3.2 cmderr [init.sh] [notice] To update, run: pip install --upgrade pip cmderr [init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.3.2 cmderr [init.sh] [notice] To update, run: pip install --upgrade pip cmderr [init.sh] Current cmderr [init.sh] Dload Upload Total Spent Left Speed cmderr [init.sh] 0 0 0 0 0 0 0 0 --:--:-- --:--:-- --:--:-- 0 cmderr [init.sh] Downloading https://nodejs.org/dist/v18.15.0/node-v18.15.0-linux-x64.tar.xz... cmderr [init.sh] #################################### 100.0% cmderr [init.sh] Computing checksum with sha256sum cmderr [init.sh] Checksums matched! 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 1699bba0b14aaa2fdabe01caca6e5e9170cb1884. 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/network/armnetwork [View full logs] [Preview SDK Changes]info [Changelog] ### Features Added info [Changelog] info [Changelog] - New value `EndpointTypeAzureArcNetwork` added to enum type `EndpointType` info [Changelog] - New value `VirtualNetworkPrivateEndpointNetworkPoliciesNetworkSecurityGroupEnabled`, `VirtualNetworkPrivateEndpointNetworkPoliciesRouteTableEnabled` added to enum type `VirtualNetworkPrivateEndpointNetworkPolicies` info [Changelog] - New function `*ClientFactory.NewFirewallPolicyDeploymentsClient() *FirewallPolicyDeploymentsClient` info [Changelog] - New function `*ClientFactory.NewFirewallPolicyDraftsClient() *FirewallPolicyDraftsClient` info [Changelog] - New function `*ClientFactory.NewFirewallPolicyRuleCollectionGroupDraftsClient() *FirewallPolicyRuleCollectionGroupDraftsClient` info [Changelog] - New function `NewFirewallPolicyDeploymentsClient(string, azcore.TokenCredential, *arm.ClientOptions) (*FirewallPolicyDeploymentsClient, error)` info [Changelog] - New function `*FirewallPolicyDeploymentsClient.BeginDeploy(context.Context, string, string, *FirewallPolicyDeploymentsClientBeginDeployOptions) (*runtime.Poller[FirewallPolicyDeploymentsClientDeployResponse], error)` info [Changelog] - New function `NewFirewallPolicyDraftsClient(string, azcore.TokenCredential, *arm.ClientOptions) (*FirewallPolicyDraftsClient, error)` info [Changelog] - New function `*FirewallPolicyDraftsClient.CreateOrUpdate(context.Context, string, string, FirewallPolicyDraft, *FirewallPolicyDraftsClientCreateOrUpdateOptions) (FirewallPolicyDraftsClientCreateOrUpdateResponse, error)` info [Changelog] - New function `*FirewallPolicyDraftsClient.Delete(context.Context, string, string, *FirewallPolicyDraftsClientDeleteOptions) (FirewallPolicyDraftsClientDeleteResponse, error)` info [Changelog] - New function `*FirewallPolicyDraftsClient.Get(context.Context, string, string, *FirewallPolicyDraftsClientGetOptions) (FirewallPolicyDraftsClientGetResponse, error)` info [Changelog] - New function `NewFirewallPolicyRuleCollectionGroupDraftsClient(string, azcore.TokenCredential, *arm.ClientOptions) (*FirewallPolicyRuleCollectionGroupDraftsClient, error)` info [Changelog] - New function `*FirewallPolicyRuleCollectionGroupDraftsClient.CreateOrUpdate(context.Context, string, string, string, FirewallPolicyRuleCollectionGroupDraft, *FirewallPolicyRuleCollectionGroupDraftsClientCreateOrUpdateOptions) (FirewallPolicyRuleCollectionGroupDraftsClientCreateOrUpdateResponse, error)` info [Changelog] - New function `*FirewallPolicyRuleCollectionGroupDraftsClient.Delete(context.Context, string, string, string, *FirewallPolicyRuleCollectionGroupDraftsClientDeleteOptions) (FirewallPolicyRuleCollectionGroupDraftsClientDeleteResponse, error)` info [Changelog] - New function `*FirewallPolicyRuleCollectionGroupDraftsClient.Get(context.Context, string, string, string, *FirewallPolicyRuleCollectionGroupDraftsClientGetOptions) (FirewallPolicyRuleCollectionGroupDraftsClientGetResponse, error)` info [Changelog] - New struct `ConnectionMonitorEndpointLocationDetails` info [Changelog] - New struct `FirewallPolicyDraft` info [Changelog] - New struct `FirewallPolicyDraftProperties` info [Changelog] - New struct `FirewallPolicyRuleCollectionGroupDraft` info [Changelog] - New struct `FirewallPolicyRuleCollectionGroupDraftProperties` info [Changelog] - New field `Zones` in struct `BastionHost` info [Changelog] - New field `LocationDetails`, `SubscriptionID` in struct `ConnectionMonitorEndpoint` info [Changelog] info [Changelog] Total 0 breaking change(s), 28 additive change(s).
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
️✔️Succeeded [Logs] Generate from 1699bba0b14aaa2fdabe01caca6e5e9170cb1884. 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 FirewallPolicyDeployments info [Changelog] - Added operation group FirewallPolicyDrafts info [Changelog] - Added operation group FirewallPolicyRuleCollectionGroupDrafts info [Changelog] - Added Interface ConnectionMonitorEndpointLocationDetails info [Changelog] - Added Interface FirewallPolicyDeploymentsDeployHeaders info [Changelog] - Added Interface FirewallPolicyDeploymentsDeployOptionalParams info [Changelog] - Added Interface FirewallPolicyDraft info [Changelog] - Added Interface FirewallPolicyDraftsCreateOrUpdateOptionalParams info [Changelog] - Added Interface FirewallPolicyDraftsDeleteOptionalParams info [Changelog] - Added Interface FirewallPolicyDraftsGetOptionalParams info [Changelog] - Added Interface FirewallPolicyRuleCollectionGroupDraft info [Changelog] - Added Interface FirewallPolicyRuleCollectionGroupDraftsCreateOrUpdateOptionalParams info [Changelog] - Added Interface FirewallPolicyRuleCollectionGroupDraftsDeleteOptionalParams info [Changelog] - Added Interface FirewallPolicyRuleCollectionGroupDraftsGetOptionalParams info [Changelog] - Added Type Alias FirewallPolicyDeploymentsDeployResponse info [Changelog] - Added Type Alias FirewallPolicyDraftsCreateOrUpdateResponse info [Changelog] - Added Type Alias FirewallPolicyDraftsGetResponse info [Changelog] - Added Type Alias FirewallPolicyRuleCollectionGroupDraftsCreateOrUpdateResponse info [Changelog] - Added Type Alias FirewallPolicyRuleCollectionGroupDraftsGetResponse info [Changelog] - Interface BastionHost has a new optional parameter zones info [Changelog] - Interface ConnectionMonitorEndpoint has a new optional parameter locationDetails info [Changelog] - Interface ConnectionMonitorEndpoint has a new optional parameter subscriptionId info [Changelog] - Enum KnownEndpointType has a new value AzureArcNetwork info [Changelog] - Enum KnownVirtualNetworkPrivateEndpointNetworkPolicies has a new value NetworkSecurityGroupEnabled info [Changelog] - Enum KnownVirtualNetworkPrivateEndpointNetworkPolicies has a new value RouteTableEnabled
️🔄 azure-resource-manager-schemas inProgress [Detail]
️❌ azure-powershell failed [Detail]
❌Code Generator Failed [Logs] Generate from 1699bba0b14aaa2fdabe01caca6e5e9170cb1884. SDK Automation 14.0.0command sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json error Script return with result [failed] code [2] signal [null] cwd [azure-powershell]: sh ./tools/SwaggerCI/init.sh warn File azure-powershell_tmp/initOutput.json not found to read error Fatal error: ENOENT: no such file or directory, open 'azure-powershell_tmp/generateInput.json' ENOENT: no such file or directory, open 'azure-powershell_tmp/generateInput.json' error Fatal error: Error: ENOENT: no such file or directory, open 'azure-powershell_tmp/generateInput.json' at Object.openSync (node:fs:596:3) at Object.writeFileSync (node:fs:2322:35) at exports.writeTmpJsonFile (/mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/utils/fsUtils.js:120:18) at workflowCallGenerateScript (/mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflow.js:487:15) at workflowHandleReadmeMdOrTypeSpecProject (/mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflow.js:209:46) at process.processTicksAndRejections (node:internal/process/task_queues:95:5) at async exports.workflowMain (/mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflow.js:99:9) at async exports.sdkAutoMain (/mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/entrypoint.js:210:13) at async /mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/cli/cli.js:20:18
Generated ApiView
| Language | Package Name | ApiView Link |
|---|---|---|
| Go | sdk/resourcemanager/network/armnetwork | https://apiview.dev/Assemblies/Review/08ab188fdab64564bc46944e13addcf9?revisionId=09e2af15976f4f2ea696633360ab41df |
| Java | azure-resourcemanager-network-generated | https://apiview.dev/Assemblies/Review/d496e631581f47bcab5c961219fc2258?revisionId=5d4e2e07351a4ea2b894d3457f7030bc |
| JavaScript | @azure/arm-network | https://apiview.dev/Assemblies/Review/c13fd66ecbcc4c2a9995c8a1f4187240?revisionId=c8958e8eea1f4eaf96b3bec2d60c054c |
| .Net | Azure.ResourceManager.Network | https://apiview.dev/Assemblies/Review/806ead8231374028b5c49cb90e200641?revisionId=b7e25b105c8648d2890ea9141cfb790b |
| Swagger | Microsoft.Network | https://apiview.dev/Assemblies/Review/9a91f46aa0a846acaae91aba821517fb?revisionId=66bc9a76921046a89127669edc361ff5 |
can you please reflect these changes in your examples? #Resolved
Refers to: specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/networkWatcher.json:4802 in 1f2768e. [](commit_id = 1f2768e3864c9dec5917626d3c8c78e58a2175a5, deletion_comment = False)
"description": "Resource ID of the connection monitor endpoint."
explain which types its needed for? If not all #Resolved
Refers to: specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/networkWatcher.json:4248 in 1f2768e. [](commit_id = 1f2768e3864c9dec5917626d3c8c78e58a2175a5, deletion_comment = False)
"address": {
explain which types its needed or valid for? If not all #Resolved
Refers to: specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/networkWatcher.json:4250 in 1f2768e. [](commit_id = 1f2768e3864c9dec5917626d3c8c78e58a2175a5, deletion_comment = False)
"description": "Filter for sub-items within the endpoint."
could reword this to mean something more like 'which endpoints within one target resource to monitor, when the target resource has multiple endpoints' #Resolved
Refers to: specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/networkWatcher.json:4256 in 1f2768e. [](commit_id = 1f2768e3864c9dec5917626d3c8c78e58a2175a5, deletion_comment = False)
can you please reflect these changes in your examples?
Refers to: specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/networkWatcher.json:4802 in 1f2768e. [](commit_id = 1f2768e, deletion_comment = False)
Added a example file for ArcNetwork endpoint, "specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/NetworkWatcherConnectionMonitorCreateWithArcNetwork.json"
Please address or respond to feedback from the ARM API reviewer.
When you are ready to continue the ARM API review, please remove the ARMChangesRequested label.
This will notify the reviewer to have another look.
If the feedback provided needs further discussion, please use this Teams channel to post your questions - aka.ms/azsdk/support/specreview-channel.
Please include [ARM Query] in the title of your question to indicate that it is ARM-related.
![openapi-workflow-bot[bot] avatar](https://avatars.githubusercontent.com/in/81125?v=4 "Published by a pub.dev verified publisher"){kind=small}
"description": "Filter for sub-items within the endpoint."could reword this to mean something more like 'which endpoints within one target resource to monitor, when the target resource has multiple endpoints'
Refers to: specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/networkWatcher.json:4256 in 1f2768e. [](commit_id = 1f2768e, deletion_comment = False)
Updated the description.
"description": "Resource ID of the connection monitor endpoint."explain which types its needed for? If not all
Refers to: specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/networkWatcher.json:4248 in 1f2768e. [](commit_id = 1f2768e, deletion_comment = False)
Updated the type details in description.