Authorization Provider - List By Service

Hizmet:: API Management

API Sürümü:: 2024-05-01

Bir hizmet örneği içinde tanımlanan yetkilendirme sağlayıcıları koleksiyonunu listeler.

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

İsteğe bağlı parametrelerle:

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 Parametreleri

Name	İçinde	Gerekli	Tür	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Kaynak grubunun adı. Ad büyük/küçük harfe duyarsız.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	API Management hizmetinin adı.
subscriptionId	path	True	string (uuid)	Hedef aboneliğin kimliği. Değer bir UUID olmalıdır.
api-version	query	True	string minLength: 1	Bu işlem için kullanılacak API sürümü.
$filter	query		string	\| Alan \| Kullanım \| Desteklenen işleçler \| Desteklenen işlevler \| \|-------------\|-------------\|-------------\|-------------\| \| ad \| filtre \| ge, le, eq, ne, gt, lt \| substringof, contains, startswith, endswith \| \| displayName \| filtre \| ge, le, eq, ne, gt, lt \| substringof, contains, startswith, endswith \|
$skip	query		integer (int32) minimum: 0	Atlana kayıt sayısı.
$top	query		integer (int32) minimum: 1	Döndürülecek kayıt sayısı.

Yanıtlar

Name	Tür	Description
200 OK	AuthorizationProviderCollection	Belirtilen API Management hizmet örneği için Yetkilendirme Sağlayıcısı varlıklarının koleksiyonu.
Other Status Codes	ErrorResponse	İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Akışı.

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

ApiManagementListAuthorizationProviders

Örnek isteği

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

Örnek yanıt

Durum kodu:: 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": ""
}

Tanımlar

Name	Description
AuthorizationProviderCollection	Sayfalanmış Yetkilendirme Sağlayıcısı liste gösterimi.
AuthorizationProviderContract	Yetkilendirme Sağlayıcısı sözleşmesi.
AuthorizationProviderOAuth2GrantTypes	Yetkilendirme Sağlayıcısı oauth2 verme türleri ayarları
AuthorizationProviderOAuth2Settings	OAuth2 ayarları ayrıntıları
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
ErrorDetail	Hata ayrıntısı.
ErrorResponse	Hata yanıtı

AuthorizationProviderCollection

Object

Sayfalanmış Yetkilendirme Sağlayıcısı liste gösterimi.

Name	Tür	Description
nextLink	string	Varsa sonraki sayfa bağlantısı.
value	AuthorizationProviderContract[]	Sayfa değerleri.

AuthorizationProviderContract

Object

Yetkilendirme Sağlayıcısı sözleşmesi.

Name	Tür	Description
id	string	Kaynağın tam kaynak kimliği. Örn - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Kaynağın adı
properties.displayName	string minLength: 1 maxLength: 300	Yetkilendirme Sağlayıcısı adı. 1 ile 300 karakter uzunluğunda olmalıdır.
properties.identityProvider	string	Kimlik sağlayıcısı adı. 1 ile 300 karakter uzunluğunda olmalıdır.
properties.oauth2	AuthorizationProviderOAuth2Settings	OAuth2 ayarları
type	string	Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts"

AuthorizationProviderOAuth2GrantTypes

Object

Yetkilendirme Sağlayıcısı oauth2 verme türleri ayarları

Name	Tür	Description
authorizationCode	object	OAuth2 yetkilendirme kodu verme parametreleri
clientCredentials	object	OAuth2 istemci kimlik bilgisi verme parametreleri

AuthorizationProviderOAuth2Settings

Object

OAuth2 ayarları ayrıntıları

Name	Tür	Description
grantTypes	AuthorizationProviderOAuth2GrantTypes	OAuth2 ayarları
redirectUrl	string	URL'yi OAuth uygulamasında ayarlanacak şekilde yeniden yönlendirin.

ErrorAdditionalInfo

Object

Kaynak yönetimi hatası ek bilgileri.

Name	Tür	Description
info	object	Ek bilgiler.
type	string	Ek bilgi türü.

ErrorDetail

Object

Hata ayrıntısı.

Name	Tür	Description
additionalInfo	ErrorAdditionalInfo[]	Hata ek bilgileri.
code	string	Hata kodu.
details	ErrorDetail[]	Hata ayrıntıları.
message	string	Hata iletisi.
target	string	Hata hedefi.

ErrorResponse

Object

Hata yanıtı

Name	Tür	Description
error	ErrorDetail	Hata nesnesi.

Aracılığıyla paylaş

Authorization Provider - List By Service

URI Parametreleri

Yanıtlar

Güvenlik

azure_auth

Kapsamlar

Örnekler

ApiManagementListAuthorizationProviders

Örnek isteği

Örnek yanıt

Tanımlar

AuthorizationProviderCollection

AuthorizationProviderContract

AuthorizationProviderOAuth2GrantTypes

AuthorizationProviderOAuth2Settings

ErrorAdditionalInfo

ErrorDetail

ErrorResponse