Udostępnij za pośrednictwem


Microsoft.ApiManagement service/authorizationProviders 2022-08-01

Definicja zasobu Bicep

Typ zasobu service/authorizationProviders można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.ApiManagement/service/authorizationProviders, dodaj następujący kod Bicep do szablonu.

resource symbolicname 'Microsoft.ApiManagement/service/authorizationProviders@2022-08-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    displayName: 'string'
    identityProvider: 'string'
    oauth2: {
      grantTypes: {
        authorizationCode: {
          {customized property}: 'string'
        }
        clientCredentials: {
          {customized property}: 'string'
        }
      }
      redirectUrl: 'string'
    }
  }
}

Wartości właściwości

AuthorizationProviderContractProperties

Nazwa Opis Wartość
displayName Nazwa dostawcy autoryzacji. Musi mieć długość od 1 do 300 znaków. struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 300
identityProvider Nazwa dostawcy tożsamości. Musi mieć długość od 1 do 300 znaków. struna
oauth2 Ustawienia protokołu OAuth2 AuthorizationProviderOAuth2Settings

AuthorizationProviderOAuth2GrantTypes

Nazwa Opis Wartość
authorizationCode Parametry udzielania kodu autoryzacji OAuth2 AuthorizationProviderOAuth2GrantTypesAuthorizationCode
clientCredentials Parametry udzielania poświadczeń klienta OAuth2 AuthorizationProviderOAuth2GrantTypesClientCredentials

AuthorizationProviderOAuth2GrantTypesAuthorizationCode

Nazwa Opis Wartość

AuthorizationProviderOAuth2GrantTypesClientCredentials

Nazwa Opis Wartość

AuthorizationProviderOAuth2Settings

Nazwa Opis Wartość
grantTypes Ustawienia protokołu OAuth2 AuthorizationProviderOAuth2GrantTypes
redirectUrl Adres URL przekierowania do ustawienia w aplikacji OAuth. struna

Microsoft.ApiManagement/service/authorizationProviders

Nazwa Opis Wartość
nazwa Nazwa zasobu struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 256
Wzorzec = ^[^*#&+:<>?]+$ (wymagane)
rodzic W Bicep można określić zasób nadrzędny dla zasobu podrzędnego. Tę właściwość należy dodać tylko wtedy, gdy zasób podrzędny jest zadeklarowany poza zasobem nadrzędnym.

Aby uzyskać więcej informacji, zobacz Zasób podrzędny poza zasobem nadrzędnym.
Nazwa symboliczna zasobu typu: usługi
Właściwości Właściwości kontraktu dostawcy autoryzacji. AuthorizationProviderContractProperties

Definicja zasobu szablonu usługi ARM

Typ zasobu service/authorizationProviders można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.ApiManagement/service/authorizationProviders, dodaj następujący kod JSON do szablonu.

{
  "type": "Microsoft.ApiManagement/service/authorizationProviders",
  "apiVersion": "2022-08-01",
  "name": "string",
  "properties": {
    "displayName": "string",
    "identityProvider": "string",
    "oauth2": {
      "grantTypes": {
        "authorizationCode": {
          "{customized property}": "string"
        },
        "clientCredentials": {
          "{customized property}": "string"
        }
      },
      "redirectUrl": "string"
    }
  }
}

Wartości właściwości

AuthorizationProviderContractProperties

Nazwa Opis Wartość
displayName Nazwa dostawcy autoryzacji. Musi mieć długość od 1 do 300 znaków. struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 300
identityProvider Nazwa dostawcy tożsamości. Musi mieć długość od 1 do 300 znaków. struna
oauth2 Ustawienia protokołu OAuth2 AuthorizationProviderOAuth2Settings

AuthorizationProviderOAuth2GrantTypes

Nazwa Opis Wartość
authorizationCode Parametry udzielania kodu autoryzacji OAuth2 AuthorizationProviderOAuth2GrantTypesAuthorizationCode
clientCredentials Parametry udzielania poświadczeń klienta OAuth2 AuthorizationProviderOAuth2GrantTypesClientCredentials

AuthorizationProviderOAuth2GrantTypesAuthorizationCode

Nazwa Opis Wartość

AuthorizationProviderOAuth2GrantTypesClientCredentials

Nazwa Opis Wartość

AuthorizationProviderOAuth2Settings

Nazwa Opis Wartość
grantTypes Ustawienia protokołu OAuth2 AuthorizationProviderOAuth2GrantTypes
redirectUrl Adres URL przekierowania do ustawienia w aplikacji OAuth. struna

Microsoft.ApiManagement/service/authorizationProviders

Nazwa Opis Wartość
apiVersion Wersja interfejsu API '2022-08-01'
nazwa Nazwa zasobu struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 256
Wzorzec = ^[^*#&+:<>?]+$ (wymagane)
Właściwości Właściwości kontraktu dostawcy autoryzacji. AuthorizationProviderContractProperties
typ Typ zasobu "Microsoft.ApiManagement/service/authorizationProviders"

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu service/authorizationProviders można wdrożyć przy użyciu operacji docelowych:

  • grupy zasobów

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.ApiManagement/service/authorizationProviders, dodaj następujący program Terraform do szablonu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/authorizationProviders@2022-08-01"
  name = "string"
  body = jsonencode({
    properties = {
      displayName = "string"
      identityProvider = "string"
      oauth2 = {
        grantTypes = {
          authorizationCode = {
            {customized property} = "string"
          }
          clientCredentials = {
            {customized property} = "string"
          }
        }
        redirectUrl = "string"
      }
    }
  })
}

Wartości właściwości

AuthorizationProviderContractProperties

Nazwa Opis Wartość
displayName Nazwa dostawcy autoryzacji. Musi mieć długość od 1 do 300 znaków. struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 300
identityProvider Nazwa dostawcy tożsamości. Musi mieć długość od 1 do 300 znaków. struna
oauth2 Ustawienia protokołu OAuth2 AuthorizationProviderOAuth2Settings

AuthorizationProviderOAuth2GrantTypes

Nazwa Opis Wartość
authorizationCode Parametry udzielania kodu autoryzacji OAuth2 AuthorizationProviderOAuth2GrantTypesAuthorizationCode
clientCredentials Parametry udzielania poświadczeń klienta OAuth2 AuthorizationProviderOAuth2GrantTypesClientCredentials

AuthorizationProviderOAuth2GrantTypesAuthorizationCode

Nazwa Opis Wartość

AuthorizationProviderOAuth2GrantTypesClientCredentials

Nazwa Opis Wartość

AuthorizationProviderOAuth2Settings

Nazwa Opis Wartość
grantTypes Ustawienia protokołu OAuth2 AuthorizationProviderOAuth2GrantTypes
redirectUrl Adres URL przekierowania do ustawienia w aplikacji OAuth. struna

Microsoft.ApiManagement/service/authorizationProviders

Nazwa Opis Wartość
nazwa Nazwa zasobu struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 256
Wzorzec = ^[^*#&+:<>?]+$ (wymagane)
parent_id Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu. Identyfikator zasobu typu: usługi
Właściwości Właściwości kontraktu dostawcy autoryzacji. AuthorizationProviderContractProperties
typ Typ zasobu "Microsoft.ApiManagement/service/authorizationProviders@2022-08-01"