Authorization Provider - List By Service

Serviço:: API Management

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

Lista uma coleção de provedores de autorização definidos em uma instância de serviço.

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

Com parâmetros opcionais:

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

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 \| GE, LE, EQ, NE, GT, LT \| substringof, contém, começa, termina com \| \| displayName \| Filtrar \| GE, LE, EQ, NE, GT, LT \| substringof, contém, começa, termina com \|
$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	AuthorizationProviderCollection	Uma coleção das entidades do Provedor de Autorização para a instância de serviço de Gerenciamento de API especificada.
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

ApiManagementListAuthorizationProviders

Pedido de amostra

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders?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/authorizationProviders/aadwithauthcode",
      "type": "Microsoft.ApiManagement/service/authorizationProviders",
      "name": "aadwithauthcode",
      "properties": {
        "displayName": "aadwithauthcode",
        "identityProvider": "aad",
        "oauth2": {
          "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1",
          "grantTypes": {
            "authorizationCode": {
              "clientId": "53790825-fdd3-4b80-bc7a-4c3aaf25801d",
              "scopes": "User.Read.All Group.Read.All",
              "loginUri": "https://login.windows.net",
              "resourceUri": "https://graph.microsoft.com",
              "tenantId": "common"
            }
          }
        }
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithclientcred",
      "type": "Microsoft.ApiManagement/service/authorizationProviders",
      "name": "aadwithclientcred",
      "properties": {
        "displayName": "aadwithclientcred",
        "identityProvider": "aad",
        "oauth2": {
          "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1",
          "grantTypes": {
            "clientCredentials": {
              "scopes": "User.Read.All Group.Read.All",
              "loginUri": "https://login.windows.net",
              "resourceUri": "https://graph.microsoft.com",
              "tenantId": "common"
            }
          }
        }
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/google",
      "type": "Microsoft.ApiManagement/service/authorizationProviders",
      "name": "google",
      "properties": {
        "displayName": "google",
        "identityProvider": "google",
        "oauth2": {
          "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1",
          "grantTypes": {
            "authorizationCode": {
              "clientId": "99999999-xxxxxxxxxxxxxxxxxxxxxxxx.apps.googleusercontent.com",
              "scopes": "openid https://www.googleapis.com/auth/userinfo.profile https://www.googleapis.com/auth/userinfo.email"
            }
          }
        }
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/eventbrite",
      "type": "Microsoft.ApiManagement/service/authorizationProviders",
      "name": "eventbrite",
      "properties": {
        "displayName": "eventbrite",
        "identityProvider": "oauth2",
        "oauth2": {
          "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1",
          "grantTypes": {
            "authorizationCode": {
              "clientId": "clientid",
              "scopes": null,
              "authorizationUrl": "https://www.eventbrite.com/oauth/authorize",
              "refreshUrl": "https://www.eventbrite.com/oauth/token",
              "tokenUrl": "https://www.eventbrite.com/oauth/token"
            }
          }
        }
      }
    }
  ],
  "nextLink": ""
}

Definições

Name	Description
AuthorizationProviderCollection	Representação da lista do Provedor de Autorização Paged.
AuthorizationProviderContract	Contrato de Provedor de Autorização.
AuthorizationProviderOAuth2GrantTypes	Configurações de tipos de concessão oauth2 do provedor de autorização
AuthorizationProviderOAuth2Settings	Detalhes das configurações do OAuth2
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro

AuthorizationProviderCollection

Object

Representação da lista do Provedor de Autorização Paged.

Name	Tipo	Description
nextLink	string	Link da próxima página, se houver.
value	AuthorizationProviderContract[]	Valores de página.

AuthorizationProviderContract

Object

Contrato de Provedor de Autorização.

Name	Tipo	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.displayName	string minLength: 1 maxLength: 300	Nome do provedor de autorização. Deve ter de 1 a 300 caracteres.
properties.identityProvider	string	Nome do provedor de identidade. Deve ter de 1 a 300 caracteres.
properties.oauth2	AuthorizationProviderOAuth2Settings	Configurações do OAuth2
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

AuthorizationProviderOAuth2GrantTypes

Object

Configurações de tipos de concessão oauth2 do provedor de autorização

Name	Tipo	Description
authorizationCode	object	Parâmetros de concessão do código de autorização OAuth2
clientCredentials	object	Parâmetros de concessão de credenciais do cliente OAuth2

AuthorizationProviderOAuth2Settings

Object

Detalhes das configurações do OAuth2

Name	Tipo	Description
grantTypes	AuthorizationProviderOAuth2GrantTypes	Configurações do OAuth2
redirectUrl	string	URL de redirecionamento a ser definido no aplicativo OAuth.

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.

Partilhar via

Authorization Provider - List By Service

Parâmetros do URI

Respostas

Segurança

azure_auth

Âmbitos

Exemplos

ApiManagementListAuthorizationProviders

Pedido de amostra

Resposta da amostra

Definições

AuthorizationProviderCollection

AuthorizationProviderContract

AuthorizationProviderOAuth2GrantTypes

AuthorizationProviderOAuth2Settings

ErrorAdditionalInfo

ErrorDetail

ErrorResponse