Policy - Create Or Update

Referência

Serviço:: API Management

Versão da API:: 2022-08-01

Cria ou atualiza a configuração de política global do serviço de Gerenciamento de API.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policies/policy?api-version=2022-08-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
policyId	path	True	PolicyIdName	O identificador da Política.
resourceGroupName	path	True	string	O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
serviceName	path	True	string	O nome do serviço Gerenciamento de API. Padrão Regex: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
subscriptionId	path	True	string	A ID da assinatura de destino.
api-version	query	True	string	A versão da API a ser usada para esta operação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
If-Match		string	ETag da Entidade. Não é necessário ao criar uma entidade, mas necessário ao atualizar uma entidade.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
properties.value	True	string	Conteúdo da Política conforme definido pelo formato.
properties.format		PolicyContentFormat	Formato da policyContent.

Respostas

Nome

Tipo

Description

200 OK

A configuração de política global do serviço de Gerenciamento de API foi atualizada com êxito.

Cabeçalhos

ETag: string

201 Created

A configuração de política global foi criada com êxito.

Cabeçalhos

ETag: string

Other Status Codes

Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

ApiManagementCreatePolicy

Solicitação de exemplo

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policies/policy?api-version=2022-08-01

{
  "properties": {
    "format": "xml",
    "value": "<policies>\r\n  <inbound />\r\n  <backend>\r\n    <forward-request />\r\n  </backend>\r\n  <outbound />\r\n</policies>"
  }
}

import com.azure.resourcemanager.apimanagement.fluent.models.PolicyContractInner;
import com.azure.resourcemanager.apimanagement.models.PolicyContentFormat;
import com.azure.resourcemanager.apimanagement.models.PolicyIdName;

/** Samples for Policy CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementCreatePolicy.json
     */
    /**
     * Sample code: ApiManagementCreatePolicy.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementCreatePolicy(com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager
            .policies()
            .createOrUpdateWithResponse(
                "rg1",
                "apimService1",
                PolicyIdName.POLICY,
                new PolicyContractInner()
                    .withValue(
                        "<policies>\r\n"
                            + "  <inbound />\r\n"
                            + "  <backend>\r\n"
                            + "    <forward-request />\r\n"
                            + "  </backend>\r\n"
                            + "  <outbound />\r\n"
                            + "</policies>")
                    .withFormat(PolicyContentFormat.XML),
                null,
                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

from typing import Any, IO, TYPE_CHECKING, Union

from azure.identity import DefaultAzureCredential

from azure.mgmt.apimanagement import ApiManagementClient

if TYPE_CHECKING:
    # pylint: disable=unused-import,ungrouped-imports
    from .. import models as _models
"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-apimanagement
# USAGE
    python api_management_create_policy.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 = ApiManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.policy.create_or_update(
        resource_group_name="rg1",
        service_name="apimService1",
        policy_id="policy",
        parameters={
            "properties": {
                "format": "xml",
                "value": "<policies>\r\n  <inbound />\r\n  <backend>\r\n    <forward-request />\r\n  </backend>\r\n  <outbound />\r\n</policies>",
            }
        },
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementCreatePolicy.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

package armapimanagement_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/apimanagement/armapimanagement/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4cd95123fb961c68740565a1efcaa5e43bd35802/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementCreatePolicy.json
func ExamplePolicyClient_CreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armapimanagement.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewPolicyClient().CreateOrUpdate(ctx, "rg1", "apimService1", armapimanagement.PolicyIDNamePolicy, armapimanagement.PolicyContract{
		Properties: &armapimanagement.PolicyContractProperties{
			Format: to.Ptr(armapimanagement.PolicyContentFormatXML),
			Value:  to.Ptr("<policies>\r\n  <inbound />\r\n  <backend>\r\n    <forward-request />\r\n  </backend>\r\n  <outbound />\r\n</policies>"),
		},
	}, &armapimanagement.PolicyClientCreateOrUpdateOptions{IfMatch: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.PolicyContract = armapimanagement.PolicyContract{
	// 	Name: to.Ptr("policy"),
	// 	Type: to.Ptr("Microsoft.ApiManagement/service/policies"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policies/policy"),
	// 	Properties: &armapimanagement.PolicyContractProperties{
	// 		Value: to.Ptr("<policies>\r\n  <inbound />\r\n  <backend>\r\n    <forward-request />\r\n  </backend>\r\n  <outbound />\r\n</policies>"),
	// 	},
	// }
}

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

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

/**
 * This sample demonstrates how to Creates or updates the global policy configuration of the Api Management service.
 *
 * @summary Creates or updates the global policy configuration of the Api Management service.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementCreatePolicy.json
 */
async function apiManagementCreatePolicy() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const policyId = "policy";
  const parameters = {
    format: "xml",
    value:
      "<policies>\r\n  <inbound />\r\n  <backend>\r\n    <forward-request />\r\n  </backend>\r\n  <outbound />\r\n</policies>",
  };
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.policy.createOrUpdate(
    resourceGroupName,
    serviceName,
    policyId,
    parameters
  );
  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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.ApiManagement.Models;
using Azure.ResourceManager.ApiManagement;

// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementCreatePolicy.json
// this example is just showing the usage of "Policy_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ApiManagementPolicyResource created on azure
// for more information of creating ApiManagementPolicyResource, please refer to the document of ApiManagementPolicyResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
PolicyName policyId = PolicyName.Policy;
ResourceIdentifier apiManagementPolicyResourceId = ApiManagementPolicyResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName, policyId);
ApiManagementPolicyResource apiManagementPolicy = client.GetApiManagementPolicyResource(apiManagementPolicyResourceId);

// invoke the operation
PolicyContractData data = new PolicyContractData()
{
    Value = "<policies>\r\n  <inbound />\r\n  <backend>\r\n    <forward-request />\r\n  </backend>\r\n  <outbound />\r\n</policies>",
    Format = PolicyContentFormat.Xml,
};
ArmOperation<ApiManagementPolicyResource> lro = await apiManagementPolicy.UpdateAsync(WaitUntil.Completed, data);
ApiManagementPolicyResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
PolicyContractData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

Resposta de exemplo

Código de status:: 201

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policies/policy",
  "type": "Microsoft.ApiManagement/service/policies",
  "name": "policy",
  "properties": {
    "value": "<policies>\r\n  <inbound />\r\n  <backend>\r\n    <forward-request />\r\n  </backend>\r\n  <outbound />\r\n</policies>"
  }
}

Código de status:: 200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policies/policy",
  "type": "Microsoft.ApiManagement/service/policies",
  "name": "policy",
  "properties": {
    "value": "<policies>\r\n  <inbound />\r\n  <backend>\r\n    <forward-request />\r\n  </backend>\r\n  <outbound />\r\n</policies>"
  }
}

Definições

Nome	Description
ErrorFieldContract	Contrato de Campo de Erro.
ErrorResponse	Resposta de erro.
PolicyContentFormat	Formato da policyContent.
PolicyContract	Detalhes do contrato de política.
PolicyIdName	O identificador da Política.

ErrorFieldContract

Contrato de Campo de Erro.

Nome	Tipo	Description
code	string	Código de erro no nível da propriedade.
message	string	Representação legível por humanos do erro no nível da propriedade.
target	string	Nome da propriedade.

ErrorResponse

Resposta de erro.

Nome	Tipo	Description
error.code	string	Código de erro definido pelo serviço. Esse código atua como um substatus do código de erro HTTP especificado na resposta.
error.details	ErrorFieldContract[]	A lista de campos inválidos enviados na solicitação, em caso de erro de validação.
error.message	string	Representação legível ao olho humano do erro.

PolicyContentFormat

Formato da policyContent.

Nome	Tipo	Description
rawxml	string	O conteúdo está embutido e o Tipo de conteúdo é um documento de política não codificado em XML.
rawxml-link	string	O documento de política não é codificado em XML e está hospedado em um ponto de extremidade HTTP acessível pelo serviço Gerenciamento de API.
xml	string	O conteúdo está embutido e o Tipo de conteúdo é um documento XML.
xml-link	string	O documento XML de política é hospedado em um ponto de extremidade HTTP acessível do serviço Gerenciamento de API.

PolicyContract

Detalhes do contrato de política.

Nome	Tipo	Valor padrão	Description
id	string		ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string		O nome do recurso
properties.format	PolicyContentFormat	xml	Formato da policyContent.
properties.value	string		Conteúdo da Política conforme definido pelo formato.
type	string		Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

PolicyIdName

O identificador da Política.

Nome	Tipo	Description
policy	string