Policy Fragment - Create Or Update

Servicio:: API Management

Versión de la API:: 2024-05-01

Crea o actualiza un fragmento de directiva.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policyFragments/{id}?api-version=2024-05-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
id	path	True	string minLength: 1 maxLength: 80 pattern: (^[\w]+$)\|(^[\w][\w\-]+[\w]$)	Identificador de recursos.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Nombre del servicio API Management.
subscriptionId	path	True	string (uuid)	Identificador de la suscripción de destino. El valor debe ser un UUID.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
If-Match		string	ETag de la entidad. No es necesario al crear una entidad, pero es necesaria al actualizar una entidad.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
properties.value	True	string	Contenido del fragmento de directiva.
properties.description		string minLength: 0 maxLength: 1000	Descripción del fragmento de directiva.
properties.format		PolicyFragmentContentFormat	Formato del contenido del fragmento de directiva.

Respuestas

Nombre	Tipo	Description
200 OK	PolicyFragmentContract	El fragmento de directiva se actualizó correctamente. Encabezados ETag: string location: string Azure-AsyncOperation: string
201 Created	PolicyFragmentContract	El fragmento de directiva se creó correctamente. Encabezados ETag: string location: string Azure-AsyncOperation: string
Other Status Codes	ErrorResponse	Respuesta de error que describe por qué se produjo un error en la operación.

Nombre

Tipo

Description

200 OK

PolicyFragmentContract

El fragmento de directiva se actualizó correctamente.

Encabezados

ETag: string
location: string
Azure-AsyncOperation: string

201 Created

PolicyFragmentContract

El fragmento de directiva se creó correctamente.

Encabezados

ETag: string
location: string
Azure-AsyncOperation: string

Other Status Codes

ErrorResponse

Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

ApiManagementCreatePolicy

Solicitud de ejemplo

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyFragments/policyFragment1?api-version=2024-05-01

{
  "properties": {
    "format": "xml",
    "description": "A policy fragment example",
    "value": "<fragment><json-to-xml apply=\"always\" consider-accept-header=\"false\" /></fragment>"
  }
}

Respuesta de muestra

status code:: 200

location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyFragments/policyFragment1?api-version=2024-05-01&asyncId=5c730e343244df1b9cb56e85&asyncCode=200
Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-05-01

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyFragments/policyFragment1",
  "type": "Microsoft.ApiManagement/service/policyFragments",
  "name": "policyFragment1",
  "properties": {
    "format": "xml",
    "description": "A policy fragment example",
    "value": "<json-to-xml apply=\"always\" consider-accept-header=\"false\" />",
    "provisioningState": "InProgress"
  }
}

status code:: 201

location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyFragments/policyFragment1?api-version=2024-05-01&asyncId=5c730e343244df1b9cb56e85&asyncCode=201
Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-05-01

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyFragments/policyFragment1",
  "type": "Microsoft.ApiManagement/service/policyFragments",
  "name": "policyFragment1",
  "properties": {
    "format": "xml",
    "description": "A policy fragment example",
    "value": "<json-to-xml apply=\"always\" consider-accept-header=\"false\" />",
    "provisioningState": "InProgress"
  }
}

Definiciones

Nombre	Description
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
PolicyFragmentContentFormat	Formato del contenido del fragmento de directiva.
PolicyFragmentContract	Detalles del contrato de fragmento de directiva.

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

PolicyFragmentContentFormat

Enumeración

Formato del contenido del fragmento de directiva.

Valor	Description
xml	El contenido está insertado y el tipo de contenido es un documento XML.
rawxml	El contenido está insertado y el tipo de contenido es un documento de directiva no codificado xml.

PolicyFragmentContract

Object

Detalles del contrato de fragmento de directiva.

Nombre	Tipo	Valor predeterminado	Description
id	string		Identificador de recurso completo para el recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string		Nombre del recurso
properties.description	string minLength: 0 maxLength: 1000		Descripción del fragmento de directiva.
properties.format	PolicyFragmentContentFormat	xml	Formato del contenido del fragmento de directiva.
properties.provisioningState	string		Estado de aprovisionamiento
properties.value	string		Contenido del fragmento de directiva.
type	string		Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

Compartir a través de

Policy Fragment - Create Or Update

Parámetros de identificador URI

Encabezado de la solicitud

Cuerpo de la solicitud

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

ApiManagementCreatePolicy

Solicitud de ejemplo

Respuesta de muestra

Definiciones

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

PolicyFragmentContentFormat

PolicyFragmentContract