Subnets - Prepare Network Policies
Prepares a subnet by applying network intent policies.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}/PrepareNetworkPolicies?api-version=2024-03-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
resource
|
path | True |
string |
The name of the resource group. |
subnet
|
path | True |
string |
The name of the subnet. |
subscription
|
path | True |
string |
The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
virtual
|
path | True |
string |
The name of the virtual network. |
api-version
|
query | True |
string |
Client API version. |
Request Body
Name | Type | Description |
---|---|---|
networkIntentPolicyConfigurations |
A list of NetworkIntentPolicyConfiguration. |
|
serviceName |
string |
The name of the service for which subnet is being prepared for. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
Preparing subnet by applying network intent policies is successful. |
|
202 Accepted |
Accepted and the operation will complete asynchronously. |
|
Other Status Codes |
Error response describing why the operation failed. |
Security
azure_auth
Azure Active Directory OAuth2 Flow.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | impersonate your user account |
Examples
Prepare Network Policies
Sample request
Sample response
Location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1/PrepareNetworkPolicies?api-version=2024-03-01
Definitions
Name | Description |
---|---|
Cloud |
An error response from the service. |
Cloud |
An error response from the service. |
Network |
Network Intent Policy resource. |
Network |
Details of NetworkIntentPolicyConfiguration for PrepareNetworkPoliciesRequest. |
Prepare |
Details of PrepareNetworkPolicies for Subnet. |
CloudError
An error response from the service.
Name | Type | Description |
---|---|---|
error |
Cloud error body. |
CloudErrorBody
An error response from the service.
Name | Type | Description |
---|---|---|
code |
string |
An identifier for the error. Codes are invariant and are intended to be consumed programmatically. |
details |
A list of additional details about the error. |
|
message |
string |
A message describing the error, intended to be suitable for display in a user interface. |
target |
string |
The target of the particular error. For example, the name of the property in error. |
NetworkIntentPolicy
Network Intent Policy resource.
Name | Type | Description |
---|---|---|
etag |
string |
A unique read-only string that changes whenever the resource is updated. |
id |
string |
Resource ID. |
location |
string |
Resource location. |
name |
string |
Resource name. |
tags |
object |
Resource tags. |
type |
string |
Resource type. |
NetworkIntentPolicyConfiguration
Details of NetworkIntentPolicyConfiguration for PrepareNetworkPoliciesRequest.
Name | Type | Description |
---|---|---|
networkIntentPolicyName |
string |
The name of the Network Intent Policy for storing in target subscription. |
sourceNetworkIntentPolicy |
Source network intent policy. |
PrepareNetworkPoliciesRequest
Details of PrepareNetworkPolicies for Subnet.
Name | Type | Description |
---|---|---|
networkIntentPolicyConfigurations |
A list of NetworkIntentPolicyConfiguration. |
|
serviceName |
string |
The name of the service for which subnet is being prepared for. |