Partilhar via

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 do URI

Name Em Necessá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 um UUID.
api-version
 query True

string

minLength: 1

A versão da API a ser usada para esta operação.
$filter
 query

string

| Campo | Utilização | Operadores suportados | Funções suportadas |
|-------------|-------------|-------------|-------------|
| nome | filtrar, orderBy | GE, LE, EQ, NE, GT, LT | substringof, contém, começa, termina com |
| descrição | Filtrar | GE, LE, EQ, NE, GT, LT | substringof, contém, começa, termina com |
| valor | Filtrar | GE, LE, EQ, NE, GT, LT | substringof, contém, começa, termina com |
$orderby
 query

string

OData ordem por opção de consulta.
$skip
 query

integer (int32)

minimum: 0

Número de registos a ignorar.
$top
 query

integer (int32)

minimum: 1

Número de registos a devolver.

Respostas

Name Tipo Description
200 OK

PolicyFragmentCollection

Retornou com êxito uma matriz de fragmentos de política.
Other Status Codes

ErrorResponse

Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Ative Directory.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name Description
user_impersonation personificar a sua conta de utilizador

Exemplos

ApiManagementListPolicyFragments

Pedido de amostra

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 da amostra

Código de estado:
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

Name Description
ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.
ErrorDetail

O detalhe do erro.
ErrorResponse

Resposta de erro
PolicyFragmentCollection

A resposta da operação get policy fragments.
PolicyFragmentContentFormat

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

Detalhes do contrato de fragmento de política.

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

Name Tipo Description
info

object

As informações adicionais.
type

string

O tipo de informação adicional.

ErrorDetail

Object

O detalhe do erro.

Name Tipo Description
additionalInfo

ErrorAdditionalInfo[]

O erro informações adicionais.
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

Object

Resposta de erro

Name Tipo Description
error

ErrorDetail

O objeto de erro.

PolicyFragmentCollection

Object

A resposta da operação get policy fragments.

Name Tipo Description
count

integer (int64)

Número total de registros contados.
nextLink

string

Link da próxima página, se houver.
value

PolicyFragmentContract[]

Valor do contrato de 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 codificado não XML.
xml

O conteúdo está embutido e o tipo de conteúdo é um documento XML.

PolicyFragmentContract

Object

Detalhes do contrato de fragmento de política.

Name Tipo Default value Description
id

string

ID de recurso totalmente qualificado 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 de 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"