Compartir a través de

Workspace Api Operation Policy - Get

  • Referencia
Servicio:
API Management
Versión de la API:
2024-05-01

Obtenga la configuración de directiva en el nivel de operación de API.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/operations/{operationId}/policies/policy?api-version=2024-05-01
Con parámetros opcionales: 
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/operations/{operationId}/policies/policy?format={format}&api-version=2024-05-01

Parámetros de identificador URI

Nombre En Requerido Tipo Description
apiId
 path True

string

minLength: 1
maxLength: 256
pattern: ^[^*#&+:<>?]+$

Identificador de revisión de API. Debe ser único en la instancia actual del servicio API Management. La revisión no actual tiene ; rev=n como sufijo donde n es el número de revisión.
operationId
 path True

string

minLength: 1
maxLength: 80

Identificador de operación dentro de una API. Debe ser único en la instancia actual del servicio API Management.
policyId
 path True

PolicyIdName

Identificador de la directiva.
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.
workspaceId
 path True

string

minLength: 1
maxLength: 80
pattern: ^[^*#&+:<>?]+$

Identificador del área de trabajo. Debe ser único en la instancia actual del servicio API Management.
api-version
 query True

string

minLength: 1

Versión de la API que se va a usar para esta operación.
format
 query

PolicyExportFormat

Formato de exportación de directivas.

Respuestas

Nombre Tipo Description
200 OK

PolicyContract

Información de la directiva de operación de API.

Encabezados

ETag: 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

ApiManagementGetWorkspaceApiOperationPolicy

Solicitud de ejemplo

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/5600b539c53f5b0062040001/operations/5600b53ac53f5b0062080006/policies/policy?api-version=2024-05-01

Respuesta de muestra

status code:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/5600b539c53f5b0062040001/operations/5600b53ac53f5b0062080006/policies/policy",
  "type": "Microsoft.ApiManagement/service/workspaces/apis/operations/policies",
  "name": "policy",
  "properties": {
    "value": "<policies>\r\n  <inbound>\r\n    <base />\r\n  </inbound>\r\n  <backend>\r\n    <base />\r\n  </backend>\r\n  <outbound>\r\n    <base />\r\n    <set-header name=\"X-My-Sample\" exists-action=\"override\">\r\n      <value>This is a sample</value>\r\n      <!-- for multiple headers with the same name add additional value elements -->\r\n    </set-header>\r\n    <jsonp callback-parameter-name=\"ProcessResponse\" />\r\n  </outbound>\r\n</policies>"
  }
}

Definiciones

Nombre Description
ErrorAdditionalInfo

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

Detalle del error.
ErrorResponse

Respuesta de error
PolicyContentFormat

Formato de policyContent.
PolicyContract

Detalles del contrato de directiva.
PolicyExportFormat

Formato de exportación de directivas.
PolicyIdName

Identificador de la 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.

PolicyContentFormat

Enumeración

Formato de policyContent.

Valor Description
rawxml

El contenido está insertado y el tipo de contenido es un documento de directiva no codificado xml.
rawxml-link

El documento de directiva no está codificado en XML y se hospeda en un punto de conexión HTTP accesible desde el servicio API Management.
xml

El contenido está insertado y el tipo de contenido es un documento XML.
xml-link

El documento XML de directiva se hospeda en un punto de conexión HTTP accesible desde el servicio API Management.

PolicyContract

Object

Detalles del contrato 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.format

PolicyContentFormat

xml

Formato de policyContent.
properties.value

string

Contenido de la directiva tal como se define con el formato .
type

string

Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

PolicyExportFormat

Enumeración

Formato de exportación de directivas.

Valor Description
rawxml

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

El contenido está insertado y el tipo de contenido es un documento XML.

PolicyIdName

Enumeración

Identificador de la directiva.

Valor Description
policy