Microsoft.ApiManagement サービス/authorizationServers 2023-03-01-preview

[アーティクル]
01/16/2024

Bicep リソース定義

service/authorizationServers リソースの種類は、次を対象とする操作と共にデプロイできます。

リソースグループ - リソースグループのデプロイコマンドを参照してください

各 API バージョンの変更されたプロパティの一覧については、「変更ログ」を参照してください。

リソース形式

Microsoft.ApiManagement/service/authorizationServers リソースを作成するには、次の Bicep をテンプレートに追加します。

resource symbolicname 'Microsoft.ApiManagement/service/authorizationServers@2023-03-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    authorizationEndpoint: 'string'
    authorizationMethods: [
      'string'
    ]
    bearerTokenSendingMethods: [
      'string'
    ]
    clientAuthenticationMethod: [
      'string'
    ]
    clientId: 'string'
    clientRegistrationEndpoint: 'string'
    clientSecret: 'string'
    defaultScope: 'string'
    description: 'string'
    displayName: 'string'
    grantTypes: [
      'string'
    ]
    resourceOwnerPassword: 'string'
    resourceOwnerUsername: 'string'
    supportState: bool
    tokenBodyParameters: [
      {
        name: 'string'
        value: 'string'
      }
    ]
    tokenEndpoint: 'string'
    useInApiDocumentation: bool
    useInTestConsole: bool
  }
}

プロパティ値

service/authorizationServers

名前	説明	値
name	リソース名 Bicep で子リソースの名前と型を設定する方法を参照してください。	string (必須) 文字制限: 1 から 80 有効な文字: 英数字とハイフン。先頭は文字、末尾は英数字にします。
parent	Bicep では、子リソースの親リソースを指定できます。このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。詳細については、「親リソースの外部の子リソース」を参照してください。	種類のリソースのシンボル名: service
properties	外部 OAuth 承認サーバーコントラクトのプロパティ。	AuthorizationServerContractProperties

AuthorizationServerContractProperties

名前	説明	値
authorizationEndpoint	OAuth 承認エンドポイント。「`http://tools.ietf.org/html/rfc6749#section-3.2.`」を参照してください。	string (必須)
authorizationMethods	承認エンドポイントによってサポートされる HTTP 動詞。 GET は常に存在する必要があります。 POST は省略可能です。	次のいずれかを含む文字列配列: 'DELETE' 'GET' 'HEAD' 'OPTIONS' 'PATCH' 'POST' 'PUT' 'TRACE'
bearerTokenSendingMethods	アクセストークンを API に渡すメカニズムを指定します。	次のいずれかを含む文字列配列: 'authorizationHeader' 'query'
clientAuthenticationMethod	この承認サーバーのトークンエンドポイントによってサポートされる認証の方法。使用できる値は Basic または Body です。 Body を指定すると、クライアント資格情報とその他のパラメーターがアプリケーション/x-www-form-urlencoded 形式で要求本文内で渡されます。	次のいずれかを含む文字列配列: 'Basic' 'Body'
clientId	この承認サーバーに登録されているクライアント ID またはアプリ ID。	string (必須)
clientRegistrationEndpoint	この承認サーバーに対するクライアントまたはアプリの登録が実行されるページへの参照 (オプション)。参照するエンティティの絶対 URL が含まれます。	string (必須)
clientSecret	この承認サーバーに登録されているクライアントシークレットまたはアプリシークレット。このプロパティは、'GET' 操作では入力されません。値を取得するには、'/listSecrets' POST 要求を使用します。	string
defaultScope	既定で要求されるアクセストークンスコープ。 API レベルでオーバーライドできます。スペース区切り値を含む文字列の形式で提供される必要があります。	string
description	承認サーバーの説明。 HTML 書式設定タグを含めることができます。	string
displayName	ユーザーフレンドリな承認サーバー名。	string (必須)
grantTypes	クライアントがアクセストークンの要求に使用する承認許可の形式。	次のいずれかを含む文字列配列: 'authorizationCode' 'clientCredentials' 'implicit' 'resourceOwnerPassword' (必須)
resourceOwnerPassword	リソース所有者のパスワード許可タイプがこの承認サーバーでサポートされている場合、オプションとして指定できます。既定のリソース所有者のパスワードです。	string
resourceOwnerUsername	リソース所有者のパスワード許可タイプがこの承認サーバーでサポートされている場合、オプションとして指定できます。既定のリソース所有者のユーザー名。	string
supportState	true の場合、承認サーバーには、承認要求から応答への状態パラメーターが含まれます。クライアントは状態パラメーターを使用して、プロトコルのセキュリティを高めることができます。	[bool]
tokenBodyParameters	名前と値の文字列プロパティを持つ JSON オブジェクトの配列として表される、この承認サーバーのトークンエンドポイントに必要な追加パラメーター (つまり、{"name" : "name value", "value": "a value"})。	TokenBodyParameterContract[]
tokenEndpoint	OAuth トークンエンドポイント。参照するエンティティの絶対 URI が含まれます。	string
useInApiDocumentation	true の場合、承認サーバーは開発者ポータルの API ドキュメントで使用されます。値が指定されていない場合、既定では False。	[bool]
useInTestConsole	true の場合、承認サーバーは開発者ポータルのテストコンソールで使用できます。値が指定されていない場合は、既定で True を指定します。	[bool]

TokenBodyParameterContract

名前	説明	値
name	body パラメーター名。	string (必須)
value	body パラメーター値。	string (必須)

ARM テンプレートリソース定義

service/authorizationServers リソースの種類は、次をターゲットとする操作でデプロイできます。

リソースグループ - リソースグループのデプロイコマンドに関するページを参照してください

各 API バージョンの変更されたプロパティの一覧については、「変更ログ」を参照してください。

リソース形式

Microsoft.ApiManagement/service/authorizationServers リソースを作成するには、次の JSON をテンプレートに追加します。

{
  "type": "Microsoft.ApiManagement/service/authorizationServers",
  "apiVersion": "2023-03-01-preview",
  "name": "string",
  "properties": {
    "authorizationEndpoint": "string",
    "authorizationMethods": [ "string" ],
    "bearerTokenSendingMethods": [ "string" ],
    "clientAuthenticationMethod": [ "string" ],
    "clientId": "string",
    "clientRegistrationEndpoint": "string",
    "clientSecret": "string",
    "defaultScope": "string",
    "description": "string",
    "displayName": "string",
    "grantTypes": [ "string" ],
    "resourceOwnerPassword": "string",
    "resourceOwnerUsername": "string",
    "supportState": "bool",
    "tokenBodyParameters": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "tokenEndpoint": "string",
    "useInApiDocumentation": "bool",
    "useInTestConsole": "bool"
  }
}

プロパティ値

service/authorizationServers

名前	説明	値
type	リソースの種類	'Microsoft.ApiManagement/service/authorizationServers'
apiVersion	リソース API のバージョン	'2023-03-01-preview'
name	リソース名 JSON ARM テンプレートで子リソースの名前と型を設定する方法を参照してください。	string (必須) 文字数制限: 1 から 80 有効な文字: 英数字とハイフン。先頭は文字、末尾は英数字にします。
properties	外部 OAuth 承認サーバーコントラクトのプロパティ。	AuthorizationServerContractProperties

AuthorizationServerContractProperties

名前	説明	値
authorizationEndpoint	OAuth 承認エンドポイント。「`http://tools.ietf.org/html/rfc6749#section-3.2.`」を参照してください。	string (必須)
authorizationMethods	承認エンドポイントによってサポートされる HTTP 動詞。 GET は常に存在する必要があります。 POST は省略可能です。	次のいずれかを含む文字列配列: 'DELETE' 'GET' 'HEAD' 'OPTIONS' 'PATCH' 'POST' 'PUT' 'TRACE'
bearerTokenSendingMethods	アクセストークンを API に渡すメカニズムを指定します。	次のいずれかを含む文字列配列: 'authorizationHeader' 'query'
clientAuthenticationMethod	この承認サーバーのトークンエンドポイントによってサポートされる認証の方法。使用できる値は Basic または Body です。 Body を指定すると、クライアント資格情報とその他のパラメーターは、要求本文内で application/x-www-form-urlencoded 形式で渡されます。	次のいずれかを含む文字列配列: 'Basic' 'Body'
clientId	この承認サーバーに登録されているクライアント ID またはアプリ ID。	string (必須)
clientRegistrationEndpoint	この承認サーバーに対するクライアントまたはアプリの登録が実行されるページへの参照 (オプション)。参照するエンティティの絶対 URL が含まれます。	string (必須)
clientSecret	この承認サーバーに登録されているクライアントシークレットまたはアプリシークレット。このプロパティは 'GET' 操作では入力されません。値を取得するには、'/listSecrets' POST 要求を使用します。	string
defaultScope	既定で要求されるアクセストークンスコープ。 API レベルでオーバーライドできます。スペース区切り値を含む文字列の形式で提供される必要があります。	string
description	承認サーバーの説明。 HTML 書式設定タグを含めることができます。	string
displayName	ユーザーフレンドリな承認サーバー名。	string (必須)
grantTypes	クライアントがアクセストークンの要求に使用する承認付与の形式。	次のいずれかを含む文字列配列: 'authorizationCode' 'clientCredentials' 'implicit' 'resourceOwnerPassword' (必須)
resourceOwnerPassword	リソース所有者のパスワード許可タイプがこの承認サーバーでサポートされている場合、オプションとして指定できます。既定のリソース所有者のパスワードです。	string
resourceOwnerUsername	リソース所有者のパスワード許可タイプがこの承認サーバーでサポートされている場合、オプションとして指定できます。既定のリソース所有者のユーザー名。	string
supportState	true の場合、承認サーバーには、承認要求から応答への状態パラメーターが含まれます。クライアントは状態パラメーターを使用して、プロトコルのセキュリティを高めることができます。	[bool]
tokenBodyParameters	名前と値の文字列プロパティを持つ JSON オブジェクトの配列として表される、この承認サーバーのトークンエンドポイントに必要な追加パラメーター (つまり、{"name" : "name value", "value": "a value"})。	TokenBodyParameterContract[]
tokenEndpoint	OAuth トークンエンドポイント。参照するエンティティの絶対 URI が含まれます。	string
useInApiDocumentation	true の場合、承認サーバーは開発者ポータルの API ドキュメントで使用されます。値が指定されていない場合、既定では False。	[bool]
useInTestConsole	true の場合、承認サーバーは開発者ポータルのテストコンソールで使用できます。値が指定されていない場合は、既定で True を指定します。	[bool]

TokenBodyParameterContract

名前	説明	値
name	body パラメーター名。	string (必須)
value	body パラメーター値。	string (必須)

Terraform (AzAPI プロバイダー) リソース定義

service/authorizationServers リソースの種類は、次をターゲットとする操作でデプロイできます。

リソースグループ

各 API バージョンの変更されたプロパティの一覧については、「変更ログ」を参照してください。

リソース形式

Microsoft.ApiManagement/service/authorizationServers リソースを作成するには、次の Terraform をテンプレートに追加します。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/authorizationServers@2023-03-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      authorizationEndpoint = "string"
      authorizationMethods = [
        "string"
      ]
      bearerTokenSendingMethods = [
        "string"
      ]
      clientAuthenticationMethod = [
        "string"
      ]
      clientId = "string"
      clientRegistrationEndpoint = "string"
      clientSecret = "string"
      defaultScope = "string"
      description = "string"
      displayName = "string"
      grantTypes = [
        "string"
      ]
      resourceOwnerPassword = "string"
      resourceOwnerUsername = "string"
      supportState = bool
      tokenBodyParameters = [
        {
          name = "string"
          value = "string"
        }
      ]
      tokenEndpoint = "string"
      useInApiDocumentation = bool
      useInTestConsole = bool
    }
  })
}

プロパティ値

service/authorizationServers

名前	説明	値
type	リソースの種類	"Microsoft.ApiManagement/service/authorizationServers@2023-03-01-preview"
name	リソース名	string (必須) 文字数制限: 1 から 80 有効な文字: 英数字とハイフン。先頭は文字、末尾は英数字にします。
parent_id	このリソースの親であるリソースの ID。	種類のリソースの ID: サービス
properties	外部 OAuth 承認サーバーコントラクトのプロパティ。	AuthorizationServerContractProperties

AuthorizationServerContractProperties

名前	説明	値
authorizationEndpoint	OAuth 承認エンドポイント。「`http://tools.ietf.org/html/rfc6749#section-3.2.`」を参照してください。	string (必須)
authorizationMethods	承認エンドポイントによってサポートされる HTTP 動詞。 GET は常に存在する必要があります。 POST は省略可能です。	次のいずれかを含む文字列配列: "DELETE" "GET" "HEAD" "OPTIONS" "PATCH" "POST" "PUT" "TRACE"
bearerTokenSendingMethods	アクセストークンを API に渡すメカニズムを指定します。	次のいずれかを含む文字列配列: "authorizationHeader" "query"
clientAuthenticationMethod	この承認サーバーのトークンエンドポイントによってサポートされる認証の方法。使用できる値は Basic または Body です。 Body を指定すると、クライアント資格情報とその他のパラメーターがアプリケーション/x-www-form-urlencoded 形式で要求本文内で渡されます。	次のいずれかを含む文字列配列: "Basic" "本文"
clientId	この承認サーバーに登録されているクライアント ID またはアプリ ID。	string (必須)
clientRegistrationEndpoint	この承認サーバーに対するクライアントまたはアプリの登録が実行されるページへの参照 (オプション)。参照するエンティティの絶対 URL が含まれます。	string (必須)
clientSecret	この承認サーバーに登録されているクライアントシークレットまたはアプリシークレット。このプロパティは、'GET' 操作では入力されません。値を取得するには、'/listSecrets' POST 要求を使用します。	string
defaultScope	既定で要求されるアクセストークンスコープ。 API レベルでオーバーライドできます。スペース区切り値を含む文字列の形式で提供される必要があります。	string
description	承認サーバーの説明。 HTML 書式設定タグを含めることができます。	string
displayName	ユーザーフレンドリな承認サーバー名。	string (必須)
grantTypes	クライアントがアクセストークンの要求に使用する承認許可の形式。	次のいずれかを含む文字列配列: "authorizationCode" "clientCredentials" "暗黙的" "resourceOwnerPassword" (必須)
resourceOwnerPassword	リソース所有者のパスワード許可タイプがこの承認サーバーでサポートされている場合、オプションとして指定できます。既定のリソース所有者のパスワードです。	string
resourceOwnerUsername	リソース所有者のパスワード許可タイプがこの承認サーバーでサポートされている場合、オプションとして指定できます。既定のリソース所有者のユーザー名。	string
supportState	true の場合、承認サーバーには、承認要求から応答への state パラメーターが含まれます。クライアントは状態パラメーターを使用して、プロトコルのセキュリティを高めることができます。	[bool]
tokenBodyParameters	名前と値の文字列プロパティを持つ JSON オブジェクトの配列として表される、この承認サーバーのトークンエンドポイントに必要な追加パラメーター ({"name" : "name value","value": "a value"} など)。	TokenBodyParameterContract[]
tokenEndpoint	OAuth トークンエンドポイント。参照するエンティティの絶対 URI が含まれます。	string
useInApiDocumentation	true の場合、承認サーバーは開発者ポータルの API ドキュメントで使用されます。値が指定されていない場合、既定では False です。	[bool]
useInTestConsole	true の場合、承認サーバーは開発者ポータルのテストコンソールで使用できます。値が指定されていない場合は、既定で True を指定します。	[bool]

TokenBodyParameterContract

名前	説明	値
name	body パラメーター名。	string (必須)
value	body パラメーター値。	string (必須)

Share via

Microsoft.ApiManagement サービス/authorizationServers 2023-03-01-preview

Bicep リソース定義

リソース形式

プロパティ値

service/authorizationServers

AuthorizationServerContractProperties

TokenBodyParameterContract

ARM テンプレートリソース定義

リソース形式

プロパティ値

service/authorizationServers

AuthorizationServerContractProperties

TokenBodyParameterContract

Terraform (AzAPI プロバイダー) リソース定義

リソース形式

プロパティ値

service/authorizationServers

AuthorizationServerContractProperties

TokenBodyParameterContract

その他のリソース

Share via

Microsoft.ApiManagement サービス/authorizationServers 2023-03-01-preview

Bicep リソース定義

リソース形式

プロパティ値

service/authorizationServers

AuthorizationServerContractProperties

TokenBodyParameterContract

ARM テンプレート リソース定義

リソース形式

プロパティ値

service/authorizationServers

AuthorizationServerContractProperties

TokenBodyParameterContract

Terraform (AzAPI プロバイダー) リソース定義

リソース形式

プロパティ値

service/authorizationServers

AuthorizationServerContractProperties

TokenBodyParameterContract

その他のリソース

ARM テンプレートリソース定義