Policy Fragment - List By Service

Referência

Serviço:: API Management

Versão da API:: 2024-05-01

Obtém todos os fragmentos de política.

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

Com parâmetros opcionais:

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 URI

Nome	Em	Obrigatório	Tipo	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	O nome do serviço de Gerenciamento de API.
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser uma UUID.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.
$filter	query		string	\| Campo \| Uso \| Operadores com suporte \| Funções com suporte \| \|-------------\|-------------\|-------------\|-------------\| \| name \| filter, orderBy \| ge, le, eq, ne, gt, lt \| substringof, contains, startswith, endswith \| \| descrição \| filtro \| ge, le, eq, ne, gt, lt \| substringof, contains, startswith, endswith \| \| value \| filtro \| ge, le, eq, ne, gt, lt \| substringof, contains, startswith, endswith \|
$orderby	query		string	Opção OData order by query.
$skip	query		integer (int32) minimum: 0	Número de registros a serem ignoradas.
$top	query		integer (int32) minimum: 1	Número de registros a serem retornados.

Respostas

Nome	Tipo	Description
200 OK	PolicyFragmentCollection	Retornou com êxito uma matriz de fragmentos de política.
Other Status Codes	ErrorResponse	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

ApiManagementListPolicyFragments

Solicitação de exemplo

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

Resposta de exemplo

Código de status:: 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": ""
}

Definições

Nome	Description
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
PolicyFragmentCollection	A resposta da operação obter fragmentos de política.
PolicyFragmentContentFormat	Formato do conteúdo do fragmento de política.
PolicyFragmentContract	Detalhes do contrato do fragmento de política.

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

PolicyFragmentCollection

Objeto

A resposta da operação obter fragmentos de política.

Nome	Tipo	Description
count	integer (int64)	Número total de contagem de registros.
nextLink	string	Link da próxima página, se houver.
value	PolicyFragmentContract[]	Valor do contrato do fragmento de política.

PolicyFragmentContentFormat

Enumeração

Formato do conteúdo do fragmento de política.

Valor	Description
rawxml	O conteúdo está embutido e o tipo de conteúdo é um documento de política não codificado em XML.
xml	O conteúdo está embutido e o tipo de conteúdo é um documento XML.

PolicyFragmentContract

Objeto

Detalhes do contrato do fragmento 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.description	string minLength: 0 maxLength: 1000		Descrição do fragmento da política.
properties.format	PolicyFragmentContentFormat	xml	Formato do conteúdo do fragmento de política.
properties.provisioningState	string		O estado de provisionamento
properties.value	string		Conteúdo do fragmento de política.
type	string		O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

Compartilhar via

Policy Fragment - List By Service

Parâmetros de URI

Respostas

Segurança

azure_auth

Escopos

Exemplos

ApiManagementListPolicyFragments

Solicitação de exemplo

Resposta de exemplo

Definições

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

PolicyFragmentCollection

PolicyFragmentContentFormat

PolicyFragmentContract

Recursos adicionais