Compartilhar via


Authorization - List By Authorization Provider

Lista uma coleção de provedores de autorização definidos em um provedor de autorização.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationProviders/{authorizationProviderId}/authorizations?api-version=2022-08-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationProviders/{authorizationProviderId}/authorizations?$filter={$filter}&$top={$top}&$skip={$skip}&api-version=2022-08-01

Parâmetros de URI

Nome Em Obrigatório Tipo Description
authorizationProviderId
path True

string

Identificador do provedor de autorização.

Regex pattern: ^[^*#&+:<>?]+$

resourceGroupName
path True

string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

serviceName
path True

string

O nome do serviço Gerenciamento de API.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

A ID da assinatura de destino.

api-version
query True

string

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 | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |

$skip
query

integer

int32

Número de registros a serem ignorados.

$top
query

integer

int32

Número de registros a serem retornados.

Respostas

Nome Tipo Description
200 OK

AuthorizationCollection

Uma coleção das entidades de autorização para o provedor de autorização especificado.

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.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nome Description
user_impersonation representar sua conta de usuário

Exemplos

ApiManagementListAuthorizationsAuthCode
ApiManagementListAuthorizationsClientCred

ApiManagementListAuthorizationsAuthCode

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithauthcode/authorizations?api-version=2022-08-01

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithauthcode/authorizations/authz1",
      "type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations",
      "name": "authz1",
      "properties": {
        "authorizationType": "OAuth2",
        "oauth2grantType": "AuthorizationCode",
        "status": "Connected"
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithauthcode/authorizations/authz2",
      "type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations",
      "name": "authz2",
      "properties": {
        "authorizationType": "OAuth2",
        "oauth2grantType": "AuthorizationCode",
        "status": "Error",
        "error": {
          "code": "Unauthenticated",
          "message": "This connection is not authenticated."
        }
      }
    }
  ],
  "nextLink": ""
}

ApiManagementListAuthorizationsClientCred

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithclientcred/authorizations?api-version=2022-08-01

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithclientcred/authorizations/authz1",
      "type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations",
      "name": "authz1",
      "properties": {
        "authorizationType": "OAuth2",
        "oauth2grantType": "ClientCredentials",
        "parameters": {
          "clientId": "53790925-fdd3-4b80-bc7a-4c3aaf25801d"
        },
        "status": "Connected"
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithclientcred/authorizations/authz2",
      "type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations",
      "name": "authz2",
      "properties": {
        "authorizationType": "OAuth2",
        "oauth2grantType": "ClientCredentials",
        "parameters": {
          "clientId": "53790925-fdd3-4b80-bc7a-4c3aaf25801d"
        },
        "status": "Error",
        "error": {
          "code": "Unauthorized",
          "message": "Failed to acquire access token for service using client credentials flow: IdentityProvider=aadwithclientcred. Correlation Id=6299d09b-03b7-46ed-b355-0453451d7e49, UTC TimeStamp=5/14/2022 4:53:19 PM, Error: Failed to exchange client credentials for token. Response code=Unauthorized, Details:\r\n{\"error\":\"invalid_client\",\"error_description\":\"AADSTS7000215: Invalid client secret provided. Ensure the secret being sent in the request is the client secret value, not the client secret ID, for a secret added to app '53790925-fdd3-4b80-bc7a-4c3aaf25801d'.\\r\\nTrace ID: 4a18d3cd-9ad5-4664-b3eb-daaa2f435f00\\r\\nCorrelation ID: dde60c16-35cb-4572-8226-bfb4233af8d7\\r\\nTimestamp: 2022-05-14 16:53:19Z\",\"error_codes\":[7000215],\"timestamp\":\"2022-05-14 16:53:19Z\",\"trace_id\":\"4a18d3cd-9ad5-4664-b3eb-daaa2f435f00\",\"correlation_id\":\"dde60c16-35cb-4572-8226-bfb4233af8d7\",\"error_uri\":\"https://login.windows.net/error?code=7000215\"}"
        }
      }
    }
  ],
  "nextLink": ""
}

Definições

Nome Description
AuthorizationCollection

Representação de lista de autorização paginada.

AuthorizationContract

Contrato de autorização.

AuthorizationError

Detalhes do erro de autorização.

AuthorizationType

Opções de tipo de autorização

ErrorFieldContract

Contrato de campo de erro.

ErrorResponse

Resposta de erro.

OAuth2GrantType

Opções de tipo de concessão OAuth2

AuthorizationCollection

Representação de lista de autorização paginada.

Nome Tipo Description
count

integer

Número total de contagem de registros em todas as páginas.

nextLink

string

Próximo link da página, se houver.

value

AuthorizationContract[]

Valores de página.

AuthorizationContract

Contrato de autorização.

Nome Tipo 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.authorizationType

AuthorizationType

Opções de tipo de autorização

properties.error

AuthorizationError

properties.oauth2grantType

OAuth2GrantType

Opções de tipo de concessão OAuth2

properties.parameters

object

Parâmetros de autorização

properties.status

string

Status da autorização

type

string

Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

AuthorizationError

Detalhes do erro de autorização.

Nome Tipo Description
code

string

Código do erro

message

string

Mensagem de erro

AuthorizationType

Opções de tipo de autorização

Nome Tipo Description
OAuth2

string

Tipo de autorização OAuth2

ErrorFieldContract

Contrato de campo de erro.

Nome Tipo Description
code

string

Código de erro no nível da propriedade.

message

string

Representação legível por humanos do erro no nível da propriedade.

target

string

Nome da propriedade.

ErrorResponse

Resposta de erro.

Nome Tipo Description
error.code

string

Código de erro definido pelo serviço. Esse código atua como um substatus do código de erro HTTP especificado na resposta.

error.details

ErrorFieldContract[]

A lista de campos inválidos enviados na solicitação, em caso de erro de validação.

error.message

string

Representação legível ao olho humano do erro.

OAuth2GrantType

Opções de tipo de concessão OAuth2

Nome Tipo Description
AuthorizationCode

string

Concessão de código de autorização

ClientCredentials

string

Concessão de credencial do cliente