Microsoft.ApiManagement service/authorizationServers 2023-09-01-preview

[アーティクル]
07/24/2024

Bicep リソース定義

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

リソースグループの - リソースグループのデプロイコマンド参照

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

リソースの形式

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

resource symbolicname 'Microsoft.ApiManagement/service/authorizationServers@2023-09-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

名前	形容	価値
名前	リソース名 Bicepで子リソースの名前と種類設定する方法を参照してください。	string (必須) 文字制限: 1 ~ 80 有効な文字: 英数字とハイフン。文字で始まり、英数字で終わる。
親	Bicep では、子リソースの親リソースを指定できます。このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。詳細については、「親リソースの外部子リソース」を参照してください。	種類のリソースのシンボリック名: サービス
プロパティ	外部 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。	string (必須)
clientRegistrationEndpoint	この承認サーバーのクライアントまたはアプリの登録が実行されるページへの省略可能な参照。参照されるエンティティへの絶対 URL が含まれています。	string (必須)
clientSecret	この承認サーバーに登録されているクライアントまたはアプリシークレット。このプロパティは'GET' 操作では入力されません。値を取得するには、'/listSecrets' POST 要求を使用します。	糸制約：機密性の高い値。セキュリティで保護されたパラメーターとして渡します。
defaultScope	既定で要求されるアクセストークンスコープ。 API レベルでオーバーライドできます。スペース区切りの値を含む文字列の形式で指定する必要があります。	糸
形容	承認サーバーの説明。 HTML 書式設定タグを含めることができます。	糸
displayName	ユーザーフレンドリな承認サーバー名。	string (必須) 制約：最小長 = 1 最大長 = 50
grantTypes	クライアントがアクセストークンを要求するために使用する承認付与の形式。	次のいずれかを含む文字列配列: 'authorizationCode' 'clientCredentials' 'implicit' 'resourceOwnerPassword' (必須)
resourceOwnerPassword	この承認サーバーでリソース所有者のパスワード許可の種類がサポートされている場合は、必要に応じて指定できます。既定のリソース所有者のパスワード。	糸
resourceOwnerUsername	この承認サーバーでリソース所有者のパスワード許可の種類がサポートされている場合は、必要に応じて指定できます。既定のリソース所有者のユーザー名。	糸
supportState	true の場合、承認サーバーには、承認要求から応答までの状態パラメーターが含まれます。クライアントは、状態パラメーターを使用してプロトコルのセキュリティを高める場合があります。	bool
tokenBodyParameters	名前と値の文字列プロパティを持つ JSON オブジェクトの配列として表される、この承認サーバーのトークンエンドポイントに必要な追加パラメーター ({"name" : "name value"、"value": "a value"})。	TokenBodyParameterContract[]
tokenEndpoint	OAuth トークンエンドポイント。参照されるエンティティへの絶対 URI が含まれています。	糸
useInApiDocumentation	true の場合、承認サーバーは開発者ポータルの API ドキュメントで使用されます。値が指定されていない場合、既定では False。	bool
useInTestConsole	true の場合、承認サーバーは開発者ポータルのテストコンソールで使用できます。値が指定されていない場合は、既定で True です。	bool

TokenBodyParameterContract

名前	形容	価値
名前	body パラメーター名。	string (必須)
価値	body パラメーター値。	string (必須)

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

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

リソースグループの - リソースグループのデプロイコマンド参照

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

リソースの形式

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

{
  "type": "Microsoft.ApiManagement/service/authorizationServers",
  "apiVersion": "2023-09-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

名前	形容	価値
種類	リソースの種類	'Microsoft.ApiManagement/service/authorizationServers'
apiVersion	リソース API のバージョン	'2023-09-01-preview'
名前	リソース名 JSON ARM テンプレートで子リソースの名前と型設定する方法を参照してください。	string (必須) 文字制限: 1 ~ 80 有効な文字: 英数字とハイフン。文字で始まり、英数字で終わる。
プロパティ	外部 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。	string (必須)
clientRegistrationEndpoint	この承認サーバーのクライアントまたはアプリの登録が実行されるページへの省略可能な参照。参照されるエンティティへの絶対 URL が含まれています。	string (必須)
clientSecret	この承認サーバーに登録されているクライアントまたはアプリシークレット。このプロパティは'GET' 操作では入力されません。値を取得するには、'/listSecrets' POST 要求を使用します。	糸制約：機密性の高い値。セキュリティで保護されたパラメーターとして渡します。
defaultScope	既定で要求されるアクセストークンスコープ。 API レベルでオーバーライドできます。スペース区切りの値を含む文字列の形式で指定する必要があります。	糸
形容	承認サーバーの説明。 HTML 書式設定タグを含めることができます。	糸
displayName	ユーザーフレンドリな承認サーバー名。	string (必須) 制約：最小長 = 1 最大長 = 50
grantTypes	クライアントがアクセストークンを要求するために使用する承認付与の形式。	次のいずれかを含む文字列配列: 'authorizationCode' 'clientCredentials' 'implicit' 'resourceOwnerPassword' (必須)
resourceOwnerPassword	この承認サーバーでリソース所有者のパスワード許可の種類がサポートされている場合は、必要に応じて指定できます。既定のリソース所有者のパスワード。	糸
resourceOwnerUsername	この承認サーバーでリソース所有者のパスワード許可の種類がサポートされている場合は、必要に応じて指定できます。既定のリソース所有者のユーザー名。	糸
supportState	true の場合、承認サーバーには、承認要求から応答までの状態パラメーターが含まれます。クライアントは、状態パラメーターを使用してプロトコルのセキュリティを高める場合があります。	bool
tokenBodyParameters	名前と値の文字列プロパティを持つ JSON オブジェクトの配列として表される、この承認サーバーのトークンエンドポイントに必要な追加パラメーター ({"name" : "name value"、"value": "a value"})。	TokenBodyParameterContract[]
tokenEndpoint	OAuth トークンエンドポイント。参照されるエンティティへの絶対 URI が含まれています。	糸
useInApiDocumentation	true の場合、承認サーバーは開発者ポータルの API ドキュメントで使用されます。値が指定されていない場合、既定では False。	bool
useInTestConsole	true の場合、承認サーバーは開発者ポータルのテストコンソールで使用できます。値が指定されていない場合は、既定で True です。	bool

TokenBodyParameterContract

名前	形容	価値
名前	body パラメーター名。	string (必須)
価値	body パラメーター値。	string (必須)

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

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

リソースグループの

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

リソースの形式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/authorizationServers@2023-09-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

名前	形容	価値
種類	リソースの種類	"Microsoft.ApiManagement/service/authorizationServers@2023-09-01-preview"
名前	リソース名	string (必須) 文字制限: 1 ~ 80 有効な文字: 英数字とハイフン。文字で始まり、英数字で終わる。
parent_id	このリソースの親であるリソースの ID。	種類のリソースの ID: サービス
プロパティ	外部 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。	string (必須)
clientRegistrationEndpoint	この承認サーバーのクライアントまたはアプリの登録が実行されるページへの省略可能な参照。参照されるエンティティへの絶対 URL が含まれています。	string (必須)
clientSecret	この承認サーバーに登録されているクライアントまたはアプリシークレット。このプロパティは'GET' 操作では入力されません。値を取得するには、'/listSecrets' POST 要求を使用します。	糸制約：機密性の高い値。セキュリティで保護されたパラメーターとして渡します。
defaultScope	既定で要求されるアクセストークンスコープ。 API レベルでオーバーライドできます。スペース区切りの値を含む文字列の形式で指定する必要があります。	糸
形容	承認サーバーの説明。 HTML 書式設定タグを含めることができます。	糸
displayName	ユーザーフレンドリな承認サーバー名。	string (必須) 制約：最小長 = 1 最大長 = 50
grantTypes	クライアントがアクセストークンを要求するために使用する承認付与の形式。	次のいずれかを含む文字列配列: "authorizationCode" "clientCredentials" "implicit" "resourceOwnerPassword" (必須)
resourceOwnerPassword	この承認サーバーでリソース所有者のパスワード許可の種類がサポートされている場合は、必要に応じて指定できます。既定のリソース所有者のパスワード。	糸
resourceOwnerUsername	この承認サーバーでリソース所有者のパスワード許可の種類がサポートされている場合は、必要に応じて指定できます。既定のリソース所有者のユーザー名。	糸
supportState	true の場合、承認サーバーには、承認要求から応答までの状態パラメーターが含まれます。クライアントは、状態パラメーターを使用してプロトコルのセキュリティを高める場合があります。	bool
tokenBodyParameters	名前と値の文字列プロパティを持つ JSON オブジェクトの配列として表される、この承認サーバーのトークンエンドポイントに必要な追加パラメーター ({"name" : "name value"、"value": "a value"})。	TokenBodyParameterContract[]
tokenEndpoint	OAuth トークンエンドポイント。参照されるエンティティへの絶対 URI が含まれています。	糸
useInApiDocumentation	true の場合、承認サーバーは開発者ポータルの API ドキュメントで使用されます。値が指定されていない場合、既定では False。	bool
useInTestConsole	true の場合、承認サーバーは開発者ポータルのテストコンソールで使用できます。値が指定されていない場合は、既定で True です。	bool

TokenBodyParameterContract

名前	形容	価値
名前	body パラメーター名。	string (必須)
価値	body パラメーター値。	string (必須)

次の方法で共有

Microsoft.ApiManagement service/authorizationServers 2023-09-01-preview

Bicep リソース定義

リソースの形式

プロパティ値

service/authorizationServers

AuthorizationServerContractProperties

TokenBodyParameterContract

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

リソースの形式

プロパティ値

service/authorizationServers

AuthorizationServerContractProperties

TokenBodyParameterContract

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

リソースの形式

プロパティ値

service/authorizationServers

AuthorizationServerContractProperties

TokenBodyParameterContract

フィードバック

その他のリソース

次の方法で共有

Microsoft.ApiManagement service/authorizationServers 2023-09-01-preview

Bicep リソース定義

リソースの形式

プロパティ値

service/authorizationServers

AuthorizationServerContractProperties

TokenBodyParameterContract

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

リソースの形式

プロパティ値

service/authorizationServers

AuthorizationServerContractProperties

TokenBodyParameterContract

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

リソースの形式

プロパティ値

service/authorizationServers

AuthorizationServerContractProperties

TokenBodyParameterContract

フィードバック

その他のリソース

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