Delen via


Authorization - List By Authorization Provider

Een lijst met autorisatieproviders die zijn gedefinieerd binnen een autorisatieprovider.

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

URI-parameters

Name In Vereist Type Description
authorizationProviderId
path True

string

Id van de autorisatieprovider.

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

resourceGroupName
path True

string

De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.

serviceName
path True

string

De naam van de API Management service.

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

subscriptionId
path True

string

De id van het doelabonnement.

api-version
query True

string

De API-versie die voor deze bewerking moet worden gebruikt.

$filter
query

string

| Veld | Gebruik | Ondersteunde operators | Ondersteunde functies |
|-------------|-------------|-------------|-------------|
| naam | filteren | ge, le, eq, ne, gt, lt | subtekenreeks, bevat, begint met, eindigtmet |
| displayName | filteren | ge, le, eq, ne, gt, lt | subtekenreeks, bevat, begintmet, eindigtmet |

$skip
query

integer

int32

Aantal records dat moet worden overgeslagen.

$top
query

integer

int32

Het aantal te retourneren records.

Antwoorden

Name Type Description
200 OK

AuthorizationCollection

Een verzameling van de autorisatie-entiteiten voor de opgegeven autorisatieprovider.

Other Status Codes

ErrorResponse

Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom.

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

Scopes

Name Description
user_impersonation uw gebruikersaccount imiteren

Voorbeelden

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

Definities

Name Description
AuthorizationCollection

Weergave van de autorisatielijst met pagina's.

AuthorizationContract

Autorisatiecontract.

AuthorizationError

Details van autorisatiefout.

AuthorizationType

Opties voor autorisatietype

ErrorFieldContract

Fout Veldcontract.

ErrorResponse

Foutreactie.

OAuth2GrantType

Opties voor OAuth2-toekenningstype

AuthorizationCollection

Weergave van de autorisatielijst met pagina's.

Name Type Description
count

integer

Totaal aantal records voor alle pagina's.

nextLink

string

Koppeling naar volgende pagina, indien aanwezig.

value

AuthorizationContract[]

Paginawaarden.

AuthorizationContract

Autorisatiecontract.

Name Type Description
id

string

Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

De naam van de resource

properties.authorizationType

AuthorizationType

Opties voor autorisatietype

properties.error

AuthorizationError

properties.oauth2grantType

OAuth2GrantType

Opties voor OAuth2-toekenningstype

properties.parameters

object

Autorisatieparameters

properties.status

string

Status van de autorisatie

type

string

Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

AuthorizationError

Details van autorisatiefout.

Name Type Description
code

string

Foutcode

message

string

Foutbericht

AuthorizationType

Opties voor autorisatietype

Name Type Description
OAuth2

string

OAuth2-autorisatietype

ErrorFieldContract

Fout Veldcontract.

Name Type Description
code

string

Foutcode op eigenschapsniveau.

message

string

Door mensen leesbare weergave van fout op eigenschapsniveau.

target

string

Naam van eigenschap.

ErrorResponse

Foutreactie.

Name Type Description
error.code

string

Door de service gedefinieerde foutcode. Deze code fungeert als een substatus voor de HTTP-foutcode die is opgegeven in het antwoord.

error.details

ErrorFieldContract[]

De lijst met ongeldige velden verzenden in aanvraag, in het geval van een validatiefout.

error.message

string

Door mensen leesbare weergave van de fout.

OAuth2GrantType

Opties voor OAuth2-toekenningstype

Name Type Description
AuthorizationCode

string

Autorisatiecode verlenen

ClientCredentials

string

Verlenen van clientreferenties