Policy Description - List By Service

Servicio:

API Management

Versión de la API:

2024-05-01

Enumera todas las descripciones de directiva.

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

Con parámetros opcionales:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policyDescriptions?scope={scope}&api-version=2024-05-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
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.
scope	query		PolicyScopeContract	Ámbito de directiva.

Respuestas

Nombre	Tipo	Description
200 OK	PolicyDescriptionCollection	Devuelve una matriz de descripciones de directivas.
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

ApiManagementListPolicyDescriptions

Solicitud de ejemplo

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyDescriptions?scope=Api&api-version=2024-05-01

Respuesta de muestra

status code:

200

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyDescriptions/authentication-basic",
      "type": "Microsoft.ApiManagement/service/policyDescriptions",
      "name": "authentication-basic",
      "properties": {
        "description": "Authenticate with the backend service using Basic authentication. Use in the inbound section at API scope.",
        "scope": 268435471
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyDescriptions/authentication-certificate",
      "type": "Microsoft.ApiManagement/service/policyDescriptions",
      "name": "authentication-certificate",
      "properties": {
        "description": "Authenticate with the backend service using a client certificate. Use in the inbound section at API scope.",
        "scope": 268435471
      }
    }
  ],
  "count": 2
}

Definiciones

Nombre	Description
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
PolicyDescriptionCollection	Descripciones de las directivas de API Management.
PolicyDescriptionContract	Detalles de la descripción de la directiva.
PolicyScopeContract	Ámbito 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.

PolicyDescriptionCollection

Object

Descripciones de las directivas de API Management.

Nombre	Tipo	Description
count	integer (int64)	Número total de recuento de registros.
value	PolicyDescriptionContract[]	Descripciones de las directivas de API Management.

PolicyDescriptionContract

Object

Detalles de la descripción de la directiva.

Nombre	Tipo	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	Descripción de la directiva.
properties.scope	integer (int64)	Valor OR binario del ámbito De fragmento de código.
type	string	Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

PolicyScopeContract

Enumeración

Ámbito de directiva.

Valor	Description
All
Api
Operation
Product
Tenant