Freigeben über


Microsoft.ApiManagement service/authorizationProviders 2022-08-01

Bicep-Ressourcendefinition

Der Ressourcentyp "service/authorizationProviders" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.ApiManagement/service/authorizationProviders-Ressource zu erstellen, fügen Sie Ihrer Vorlage die folgende Bicep hinzu.

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'
    }
  }
}

Eigenschaftswerte

AuthorizationProviderContractProperties

Name Beschreibung Wert
displayName Name des Autorisierungsanbieters. Muss 1 bis 300 Zeichen lang sein. Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1
IdentityProvider Identitätsanbietername. Muss 1 bis 300 Zeichen lang sein. Schnur
oauth2 OAuth2-Einstellungen AuthorizationProviderOAuth2Settings

AuthorizationProviderOAuth2GrantTypes

Name Beschreibung Wert
authorizationCode OAuth2-Autorisierungscode-Erteilungsparameter AuthorizationProviderOAuth2GrantTypesAuthorizationCode-
clientCredentials OAuth2-Clientanmeldeinformationserteilungsparameter AuthorizationProviderOAuth2GrantTypesClientCredentials

AuthorizationProviderOAuth2GrantTypesAuthorizationCode

Name Beschreibung Wert

AuthorizationProviderOAuth2GrantTypesClientCredentials

Name Beschreibung Wert

AuthorizationProviderOAuth2Settings

Name Beschreibung Wert
grantTypes OAuth2-Einstellungen AuthorizationProviderOAuth2GrantTypes
redirectUrl Umleitungs-URL, die in der OAuth-Anwendung festgelegt werden soll. Schnur

Microsoft.ApiManagement/service/authorizationProviders

Name Beschreibung Wert
Name Der Ressourcenname Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1
Pattern = ^[^*#&+:<>?]+$ (erforderlich)
Elternteil In Bicep können Sie die übergeordnete Ressource für eine untergeordnete Ressource angeben. Sie müssen diese Eigenschaft nur hinzufügen, wenn die untergeordnete Ressource außerhalb der übergeordneten Ressource deklariert wird.

Weitere Informationen finden Sie unter Untergeordnete Ressource außerhalb der übergeordneten Ressource.
Symbolischer Name für Ressource des Typs: Dienst-
Eigenschaften Eigenschaften des Autorisierungsanbietervertrags. AuthorizationProviderContractProperties

ARM-Vorlagenressourcendefinition

Der Ressourcentyp "service/authorizationProviders" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.ApiManagement/service/authorizationProviders-Ressource zu erstellen, fügen Sie Der Vorlage den folgenden JSON-Code hinzu.

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

Eigenschaftswerte

AuthorizationProviderContractProperties

Name Beschreibung Wert
displayName Name des Autorisierungsanbieters. Muss 1 bis 300 Zeichen lang sein. Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1
IdentityProvider Identitätsanbietername. Muss 1 bis 300 Zeichen lang sein. Schnur
oauth2 OAuth2-Einstellungen AuthorizationProviderOAuth2Settings

AuthorizationProviderOAuth2GrantTypes

Name Beschreibung Wert
authorizationCode OAuth2-Autorisierungscode-Erteilungsparameter AuthorizationProviderOAuth2GrantTypesAuthorizationCode-
clientCredentials OAuth2-Clientanmeldeinformationserteilungsparameter AuthorizationProviderOAuth2GrantTypesClientCredentials

AuthorizationProviderOAuth2GrantTypesAuthorizationCode

Name Beschreibung Wert

AuthorizationProviderOAuth2GrantTypesClientCredentials

Name Beschreibung Wert

AuthorizationProviderOAuth2Settings

Name Beschreibung Wert
grantTypes OAuth2-Einstellungen AuthorizationProviderOAuth2GrantTypes
redirectUrl Umleitungs-URL, die in der OAuth-Anwendung festgelegt werden soll. Schnur

Microsoft.ApiManagement/service/authorizationProviders

Name Beschreibung Wert
apiVersion Die API-Version '2022-08-01'
Name Der Ressourcenname Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1
Pattern = ^[^*#&+:<>?]+$ (erforderlich)
Eigenschaften Eigenschaften des Autorisierungsanbietervertrags. AuthorizationProviderContractProperties
Art Der Ressourcentyp "Microsoft.ApiManagement/service/authorizationProviders"

Terraform -Ressourcendefinition (AzAPI-Anbieter)

Der Ressourcentyp "service/authorizationProviders" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

  • Ressourcengruppen

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.ApiManagement/service/authorizationProviders-Ressource zu erstellen, fügen Sie Ihrer Vorlage die folgende Terraform hinzu.

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

Eigenschaftswerte

AuthorizationProviderContractProperties

Name Beschreibung Wert
displayName Name des Autorisierungsanbieters. Muss 1 bis 300 Zeichen lang sein. Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1
IdentityProvider Identitätsanbietername. Muss 1 bis 300 Zeichen lang sein. Schnur
oauth2 OAuth2-Einstellungen AuthorizationProviderOAuth2Settings

AuthorizationProviderOAuth2GrantTypes

Name Beschreibung Wert
authorizationCode OAuth2-Autorisierungscode-Erteilungsparameter AuthorizationProviderOAuth2GrantTypesAuthorizationCode-
clientCredentials OAuth2-Clientanmeldeinformationserteilungsparameter AuthorizationProviderOAuth2GrantTypesClientCredentials

AuthorizationProviderOAuth2GrantTypesAuthorizationCode

Name Beschreibung Wert

AuthorizationProviderOAuth2GrantTypesClientCredentials

Name Beschreibung Wert

AuthorizationProviderOAuth2Settings

Name Beschreibung Wert
grantTypes OAuth2-Einstellungen AuthorizationProviderOAuth2GrantTypes
redirectUrl Umleitungs-URL, die in der OAuth-Anwendung festgelegt werden soll. Schnur

Microsoft.ApiManagement/service/authorizationProviders

Name Beschreibung Wert
Name Der Ressourcenname Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1
Pattern = ^[^*#&+:<>?]+$ (erforderlich)
parent_id Die ID der Ressource, die das übergeordnete Element für diese Ressource ist. ID für Ressource des Typs: Dienst-
Eigenschaften Eigenschaften des Autorisierungsanbietervertrags. AuthorizationProviderContractProperties
Art Der Ressourcentyp "Microsoft.ApiManagement/service/authorizationProviders@2022-08-01"