Authorization Provider - List By Service

Служба:: API Management

Версия API:: 2024-05-01

Перечисляет коллекцию поставщиков авторизации, определенных в экземпляре службы.

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

С использованием необязательных параметров:

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Имя группы ресурсов. Имя не учитывает регистр.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Имя службы управления API.
subscriptionId	path	True	string (uuid)	Идентификатор целевой подписки. Значение должно быть UUID.
api-version	query	True	string minLength: 1	Версия API, используемая для этой операции.
$filter	query		string	\| Поле \| Использование \| Поддерживаемые операторы \| Поддерживаемые функции \| \|-------------\|-------------\|-------------\|-------------\| \| 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) minimum: 0	Количество пропускаемых записей.
$top	query		integer (int32) minimum: 1	Количество возвращаемых записей.

Ответы

Имя	Тип	Описание
200 OK	AuthorizationProviderCollection	Коллекция сущностей поставщика авторизации для указанного экземпляра службы управления API.
Other Status Codes	ErrorResponse	Ответ на ошибку, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

ApiManagementListAuthorizationProviders

Образец запроса

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

Пример ответа

Код состояния:: 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": ""
}

Определения

Имя	Описание
AuthorizationProviderCollection	Представление списка поставщиков авторизации paged.
AuthorizationProviderContract	Контракт поставщика авторизации.
AuthorizationProviderOAuth2GrantTypes	Параметры типов предоставления поставщиком авторизации oauth2
AuthorizationProviderOAuth2Settings	Сведения о параметрах OAuth2
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку

AuthorizationProviderCollection

Object

Представление списка поставщиков авторизации paged.

Имя	Тип	Описание
nextLink	string	Следующая ссылка на страницу, если она есть.
value	AuthorizationProviderContract[]	Значения страницы.

AuthorizationProviderContract

Object

Контракт поставщика авторизации.

Имя	Тип	Описание
id	string	Полный идентификатор ресурса для ресурса. Пример - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Имя ресурса
properties.displayName	string minLength: 1 maxLength: 300	Имя поставщика авторизации. Должно составлять от 1 до 300 символов.
properties.identityProvider	string	Имя поставщика удостоверений. Должно составлять от 1 до 300 символов.
properties.oauth2	AuthorizationProviderOAuth2Settings	Параметры OAuth2
type	string	Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

AuthorizationProviderOAuth2GrantTypes

Object

Параметры типов предоставления поставщиком авторизации oauth2

Имя	Тип	Описание
authorizationCode	object	Параметры предоставления кода авторизации OAuth2
clientCredentials	object	Параметры предоставления учетных данных клиента OAuth2

AuthorizationProviderOAuth2Settings

Object

Сведения о параметрах OAuth2

Имя	Тип	Описание
grantTypes	AuthorizationProviderOAuth2GrantTypes	Параметры OAuth2
redirectUrl	string	URL-адрес перенаправления, заданный в приложении OAuth.

ErrorAdditionalInfo

Object

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorDetail

Object

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Object

Ответ на ошибку

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

Поделиться через

Authorization Provider - List By Service

Параметры URI

Ответы

Безопасность

azure_auth

Области

Примеры

ApiManagementListAuthorizationProviders

Образец запроса

Пример ответа

Определения

AuthorizationProviderCollection

AuthorizationProviderContract

AuthorizationProviderOAuth2GrantTypes

AuthorizationProviderOAuth2Settings

ErrorAdditionalInfo

ErrorDetail

ErrorResponse