Sdílet prostřednictvím


Služba Microsoft.ApiManagement / authorizationProviders 2022-08-01

Definice prostředku Bicep

Typ prostředku service/authorizationProviders je možné nasadit s operacemi, které cílí:

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.ApiManagement/service/authorizationProviders, přidejte do šablony následující bicep.

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

Hodnoty vlastností

AuthorizationProviderContractProperties

Jméno Popis Hodnota
displayName Název zprostředkovatele autorizace. Musí mít délku 1 až 300 znaků. řetězec

Omezení:
Minimální délka = 1
Maximální délka = 300
identityProvider Název zprostředkovatele identity. Musí mít délku 1 až 300 znaků. řetězec
oauth2 Nastavení OAuth2 AuthorizationProviderOAuth2Settings

AuthorizationProviderOAuth2GrantTypes

Jméno Popis Hodnota
authorizationCode Parametry udělení autorizačního kódu OAuth2 AuthorizationProviderOAuth2GrantTypesAuthorizationCode
clientCredentials Parametry udělení přihlašovacích údajů klienta OAuth2 AuthorizationProviderOAuth2GrantTypesClientCredentials

AuthorizationProviderOAuth2GrantTypesAuthorizationCode

Jméno Popis Hodnota

AuthorizationProviderOAuth2GrantTypesClientCredentials

Jméno Popis Hodnota

AuthorizationProviderOAuth2Settings

Jméno Popis Hodnota
grantTypes Nastavení OAuth2 AuthorizationProviderOAuth2GrantTypes
redirectUrl Adresu URL pro přesměrování, která se má nastavit v aplikaci OAuth. řetězec

Microsoft.ApiManagement/service/authorizationProviders

Jméno Popis Hodnota
Jméno Název prostředku řetězec

Omezení:
Minimální délka = 1
Maximální délka = 256
Model = ^[^*#&+:<>?]+$ (povinné)
rodič V bicep můžete zadat nadřazený prostředek pro podřízený prostředek. Tuto vlastnost je potřeba přidat pouze v případě, že je podřízený prostředek deklarován mimo nadřazený prostředek.

Další informace najdete v tématu Podřízený prostředek mimo nadřazený prostředek.
Symbolický název prostředku typu: služby
vlastnosti Vlastnosti smlouvy zprostředkovatele autorizace AuthorizationProviderContractProperties

Definice prostředku šablony ARM

Typ prostředku service/authorizationProviders je možné nasadit s operacemi, které cílí:

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.ApiManagement/service/authorizationProviders, přidejte do šablony následující JSON.

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

Hodnoty vlastností

AuthorizationProviderContractProperties

Jméno Popis Hodnota
displayName Název zprostředkovatele autorizace. Musí mít délku 1 až 300 znaků. řetězec

Omezení:
Minimální délka = 1
Maximální délka = 300
identityProvider Název zprostředkovatele identity. Musí mít délku 1 až 300 znaků. řetězec
oauth2 Nastavení OAuth2 AuthorizationProviderOAuth2Settings

AuthorizationProviderOAuth2GrantTypes

Jméno Popis Hodnota
authorizationCode Parametry udělení autorizačního kódu OAuth2 AuthorizationProviderOAuth2GrantTypesAuthorizationCode
clientCredentials Parametry udělení přihlašovacích údajů klienta OAuth2 AuthorizationProviderOAuth2GrantTypesClientCredentials

AuthorizationProviderOAuth2GrantTypesAuthorizationCode

Jméno Popis Hodnota

AuthorizationProviderOAuth2GrantTypesClientCredentials

Jméno Popis Hodnota

AuthorizationProviderOAuth2Settings

Jméno Popis Hodnota
grantTypes Nastavení OAuth2 AuthorizationProviderOAuth2GrantTypes
redirectUrl Adresu URL pro přesměrování, která se má nastavit v aplikaci OAuth. řetězec

Microsoft.ApiManagement/service/authorizationProviders

Jméno Popis Hodnota
apiVersion Verze rozhraní API '2022-08-01'
Jméno Název prostředku řetězec

Omezení:
Minimální délka = 1
Maximální délka = 256
Model = ^[^*#&+:<>?]+$ (povinné)
vlastnosti Vlastnosti smlouvy zprostředkovatele autorizace AuthorizationProviderContractProperties
typ Typ prostředku Microsoft.ApiManagement/service/authorizationProviders

Definice prostředku Terraformu (poskytovatel AzAPI)

Typ prostředku service/authorizationProviders je možné nasadit s operacemi, které cílí:

  • skupiny prostředků

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.ApiManagement/service/authorizationProviders, přidejte do šablony následující Terraform.

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

Hodnoty vlastností

AuthorizationProviderContractProperties

Jméno Popis Hodnota
displayName Název zprostředkovatele autorizace. Musí mít délku 1 až 300 znaků. řetězec

Omezení:
Minimální délka = 1
Maximální délka = 300
identityProvider Název zprostředkovatele identity. Musí mít délku 1 až 300 znaků. řetězec
oauth2 Nastavení OAuth2 AuthorizationProviderOAuth2Settings

AuthorizationProviderOAuth2GrantTypes

Jméno Popis Hodnota
authorizationCode Parametry udělení autorizačního kódu OAuth2 AuthorizationProviderOAuth2GrantTypesAuthorizationCode
clientCredentials Parametry udělení přihlašovacích údajů klienta OAuth2 AuthorizationProviderOAuth2GrantTypesClientCredentials

AuthorizationProviderOAuth2GrantTypesAuthorizationCode

Jméno Popis Hodnota

AuthorizationProviderOAuth2GrantTypesClientCredentials

Jméno Popis Hodnota

AuthorizationProviderOAuth2Settings

Jméno Popis Hodnota
grantTypes Nastavení OAuth2 AuthorizationProviderOAuth2GrantTypes
redirectUrl Adresu URL pro přesměrování, která se má nastavit v aplikaci OAuth. řetězec

Microsoft.ApiManagement/service/authorizationProviders

Jméno Popis Hodnota
Jméno Název prostředku řetězec

Omezení:
Minimální délka = 1
Maximální délka = 256
Model = ^[^*#&+:<>?]+$ (povinné)
parent_id ID prostředku, který je nadřazený pro tento prostředek. ID prostředku typu: služby
vlastnosti Vlastnosti smlouvy zprostředkovatele autorizace AuthorizationProviderContractProperties
typ Typ prostředku Microsoft.ApiManagement/service/authorizationProviders@2022-08-01