Policy Fragment - List By Service

Servicio:

API Management

Versión de la API:

2024-05-01

Obtiene todos los fragmentos de directiva.

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

Con parámetros opcionales:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policyFragments?api-version=2024-05-01&$filter={$filter}&$orderby={$orderby}&$top={$top}&$skip={$skip}

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.
$filter	query		string	| Campo | Uso | Operadores admitidos | Funciones admitidas | |-------------|-------------|-------------|-------------| | name | filter, orderBy | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | value | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
$orderby	query		string	OData order by query option (Orden de OData por opción de consulta).
$skip	query		integer (int32) minimum: 0	Número de registros que se van a omitir.
$top	query		integer (int32) minimum: 1	Número de registros que se van a devolver.

Respuestas

Nombre	Tipo	Description
200 OK	PolicyFragmentCollection	Devolvió correctamente una matriz de fragmentos de directiva.
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

ApiManagementListPolicyFragments

Solicitud de ejemplo

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyFragments?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/policyFragments/policyFragment1",
      "type": "Microsoft.ApiManagement/service/policyFragments",
      "name": "policyFragment1",
      "properties": {
        "format": "xml",
        "description": "A policy fragment example",
        "value": "<fragment><json-to-xml apply=\"always\" consider-accept-header=\"false\" /></fragment>"
      }
    }
  ],
  "count": 1,
  "nextLink": ""
}

Definiciones

Nombre	Description
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
PolicyFragmentCollection	Respuesta de la operación obtener fragmentos de directiva.
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.

PolicyFragmentCollection

Object

Respuesta de la operación obtener fragmentos de directiva.

Nombre	Tipo	Description
count	integer (int64)	Número total de recuento de registros.
nextLink	string	Vínculo de página siguiente si existe.
value	PolicyFragmentContract[]	Valor del contrato de fragmento de directiva.

PolicyFragmentContentFormat

Enumeración

Formato del contenido del fragmento de directiva.

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.

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"