Subnets - Prepare Network Policies

Serviço:

Virtual Networks

Versão da API:

2024-05-01

Prepara uma sub-rede aplicando políticas de intenção de rede.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}/PrepareNetworkPolicies?api-version=2024-05-01

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos.
subnetName	path	True	string	O nome da sub-rede.
subscriptionId	path	True	string	As credenciais de assinatura que identificam exclusivamente a assinatura do Microsoft Azure. O ID da assinatura faz parte do URI de cada chamada de serviço.
virtualNetworkName	path	True	string	O nome da rede virtual.
api-version	query	True	string	Versão da API do cliente.

Corpo do Pedido

Name	Tipo	Description
networkIntentPolicyConfigurations	NetworkIntentPolicyConfiguration[]	Uma lista de NetworkIntentPolicyConfiguration.
serviceName	string	O nome do serviço para o qual a sub-rede está sendo preparada.

Respostas

Name	Tipo	Description
200 OK		A preparação da sub-rede aplicando políticas de intenção de rede é bem-sucedida.
202 Accepted		Aceito e a operação será concluída de forma assíncrona.
Other Status Codes	CloudError	Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Ative Directory.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

Prepare Network Policies

Pedido de amostra

HTTP

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1/PrepareNetworkPolicies?api-version=2024-05-01

{
  "serviceName": "Microsoft.Sql/managedInstances"
}

Java

import com.azure.resourcemanager.network.models.PrepareNetworkPoliciesRequest;

/**
 * Samples for Subnets PrepareNetworkPolicies.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/SubnetPrepareNetworkPolicies.
     * json
     */
    /**
     * Sample code: Prepare Network Policies.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void prepareNetworkPolicies(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getSubnets().prepareNetworkPolicies("rg1", "test-vnet", "subnet1",
            new PrepareNetworkPoliciesRequest().withServiceName("Microsoft.Sql/managedInstances"),
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.network import NetworkManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-network
# USAGE
    python subnet_prepare_network_policies.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = NetworkManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    client.subnets.begin_prepare_network_policies(
        resource_group_name="rg1",
        virtual_network_name="test-vnet",
        subnet_name="subnet1",
        prepare_network_policies_request_parameters={"serviceName": "Microsoft.Sql/managedInstances"},
    ).result()


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/SubnetPrepareNetworkPolicies.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armnetwork_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/network/armnetwork/v6"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/ab04533261eff228f28e08900445d0edef3eb70c/specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/SubnetPrepareNetworkPolicies.json
func ExampleSubnetsClient_BeginPrepareNetworkPolicies() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armnetwork.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewSubnetsClient().BeginPrepareNetworkPolicies(ctx, "rg1", "test-vnet", "subnet1", armnetwork.PrepareNetworkPoliciesRequest{
		ServiceName: to.Ptr("Microsoft.Sql/managedInstances"),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { NetworkManagementClient } = require("@azure/arm-network");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Prepares a subnet by applying network intent policies.
 *
 * @summary Prepares a subnet by applying network intent policies.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/SubnetPrepareNetworkPolicies.json
 */
async function prepareNetworkPolicies() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const virtualNetworkName = "test-vnet";
  const subnetName = "subnet1";
  const prepareNetworkPoliciesRequestParameters = { serviceName: "Microsoft.Sql/managedInstances" };
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.subnets.beginPrepareNetworkPoliciesAndWait(
    resourceGroupName,
    virtualNetworkName,
    subnetName,
    prepareNetworkPoliciesRequestParameters,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Resposta da amostra

Código de estado:

200

Código de estado:

202

Location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1/PrepareNetworkPolicies?api-version=2024-05-01

Definições

Name	Description
CloudError	Uma resposta de erro do serviço.
CloudErrorBody	Uma resposta de erro do serviço.
NetworkIntentPolicy	Recurso de política de intenção de rede.
NetworkIntentPolicyConfiguration	Detalhes de NetworkIntentPolicyConfiguration para PrepareNetworkPoliciesRequest.
PrepareNetworkPoliciesRequest	Detalhes de PrepareNetworkPolicies para sub-rede.

CloudError

Uma resposta de erro do serviço.

Name	Tipo	Description
error	CloudErrorBody	Corpo do erro na nuvem.

CloudErrorBody

Uma resposta de erro do serviço.

Name	Tipo	Description
code	string	Um identificador para o erro. Os códigos são invariantes e destinam-se a ser consumidos programaticamente.
details	CloudErrorBody[]	Uma lista de detalhes adicionais sobre o erro.
message	string	Uma mensagem descrevendo o erro, destinada a ser adequada para exibição em uma interface do usuário.
target	string	O alvo do erro específico. Por exemplo, o nome da propriedade em erro.

NetworkIntentPolicy

Recurso de política de intenção de rede.

Name	Tipo	Description
etag	string	Uma cadeia de caracteres somente leitura exclusiva que muda sempre que o recurso é atualizado.
id	string	ID do recurso.
location	string	Localização do recurso.
name	string	Nome do recurso.
tags	object	Tags de recursos.
type	string	Tipo de recurso.

NetworkIntentPolicyConfiguration

Detalhes de NetworkIntentPolicyConfiguration para PrepareNetworkPoliciesRequest.

Name	Tipo	Description
networkIntentPolicyName	string	O nome da Política de Intenção de Rede para armazenar na assinatura de destino.
sourceNetworkIntentPolicy	NetworkIntentPolicy	Política de intenção de rede de origem.

PrepareNetworkPoliciesRequest

Detalhes de PrepareNetworkPolicies para sub-rede.

Name	Tipo	Description
networkIntentPolicyConfigurations	NetworkIntentPolicyConfiguration[]	Uma lista de NetworkIntentPolicyConfiguration.
serviceName	string	O nome do serviço para o qual a sub-rede está sendo preparada.