次の方法で共有

Microsoft.ApiManagement サービス/authorizationServers

Bicep リソース定義

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

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

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

リソースの形式

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

resource symbolicname 'Microsoft.ApiManagement/service/authorizationServers@2024-06-01-preview' = {
  parent: resourceSymbolicName
  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
  }
}

プロパティ値

Microsoft.ApiManagement/service/authorizationServers

名前 形容 価値
名前 リソース名 糸

制約：
最小長 = 1
最大長 = 80
パターン = ^[^*#&+:<>?]+$ (必須)
親 Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。

詳細については、「親リソースの外部 子リソース」を参照してください。		 種類のリソースのシンボリック名: サービス
プロパティ 外部 OAuth 承認サーバー コントラクトのプロパティ。 AuthorizationServerContractProperties の

AuthorizationServerContractProperties (承認サーバーコントラクトプロパティ)

名前 形容 価値
authorizationエンドポイント OAuth 承認エンドポイント。 http://tools.ietf.org/html/rfc6749#section-3.2を参照してください。 string (必須)
authorizationメソッド 承認エンドポイントでサポートされている HTTP 動詞。 GET は常に存在する必要があります。 POST は省略可能です。 次のいずれかを含む文字列配列:
「削除」
「ゲット」
「ヘッド」
「オプション」
「パッチ」
「ポスト」
「プット」
「トレース」
bearerTokenSendingメソッド アクセス トークンを API に渡すメカニズムを指定します。 次のいずれかを含む文字列配列:
'authorizationHeader'
'クエリ'
クライアント認証メソッド この承認サーバーのトークン エンドポイントでサポートされる認証方法。 使用できる値は Basic または Body です。 Body を指定すると、クライアント資格情報とその他のパラメーターが要求本文内でアプリケーション/x-www-form-urlencoded 形式で渡されます。 次のいずれかを含む文字列配列:
「ベーシック」
「ボディ」
クライアントID この承認サーバーに登録されているクライアントまたはアプリ ID。 string (必須)
clientRegistrationEndpoint この承認サーバーのクライアントまたはアプリの登録が実行されるページへの省略可能な参照。 参照されるエンティティへの絶対 URL が含まれています。 string (必須)
クライアントシークレット この承認サーバーに登録されているクライアントまたはアプリ シークレット。 このプロパティは'GET' 操作では入力されません。 値を取得するには、'/listSecrets' POST 要求を使用します。 糸

制約：
機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。
デフォルトスコープ 既定で要求されるアクセス トークン スコープ。 API レベルでオーバーライドできます。 スペース区切りの値を含む文字列の形式で指定する必要があります。 文字列
形容 承認サーバーの説明。 HTML 書式設定タグを含めることができます。 文字列
ディスプレイ名 ユーザー フレンドリな承認サーバー名。 糸

制約：
最小長 = 1
最大長 = 50 (必須)
grantTypes (グラントタイプ) クライアントがアクセス トークンを要求するために使用する承認付与の形式。 次のいずれかを含む文字列配列:
'authorizationCode'
'clientCredentials'
「暗黙的」
'resourceOwnerPassword' (必須)
リソースオーナーパスワード この承認サーバーでリソース所有者のパスワード許可の種類がサポートされている場合は、必要に応じて指定できます。 既定のリソース所有者のパスワード。 文字列
resourceOwnerユーザー名 この承認サーバーでリソース所有者のパスワード許可の種類がサポートされている場合は、必要に応じて指定できます。 既定のリソース所有者のユーザー名。 文字列
サポートステート true の場合、承認サーバーには、承認要求から応答までの状態パラメーターが含まれます。 クライアントは、状態パラメーターを使用してプロトコル のセキュリティを高める場合があります。 ブール (bool)
tokenBodyParameters (トークンボディパラメータ) 名前と値の文字列プロパティを持つ JSON オブジェクトの配列として表される、この承認サーバーのトークン エンドポイントに必要な追加パラメーター ({"name" : "name value"、"value": "a value"})。 TokenBodyパラメータ契約[]
tokenEndpoint（トークンエンドポイント） OAuth トークン エンドポイント。 参照されるエンティティへの絶対 URI が含まれています。 文字列
useInApiドキュメンテーション true の場合、承認サーバーは開発者ポータルの API ドキュメントで使用されます。 値が指定されていない場合、既定では False。 ブール (bool)
useInTestConsoleの true の場合、承認サーバーは開発者ポータルのテスト コンソールで使用できます。 値が指定されていない場合は、既定で True です。 ブール (bool)

TokenBodyParameter契約

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

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

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

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

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

リソースの形式

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

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

プロパティ値

Microsoft.ApiManagement/service/authorizationServers

名前 形容 価値
apiVersion (英語) API のバージョン 「2024-06-01-プレビュー」
名前 リソース名 糸

制約：
最小長 = 1
最大長 = 80
パターン = ^[^*#&+:<>?]+$ (必須)
プロパティ 外部 OAuth 承認サーバー コントラクトのプロパティ。 AuthorizationServerContractProperties の
型 リソースの種類 'Microsoft.ApiManagement/service/authorizationServers'

AuthorizationServerContractProperties (承認サーバーコントラクトプロパティ)

名前 形容 価値
authorizationエンドポイント OAuth 承認エンドポイント。 http://tools.ietf.org/html/rfc6749#section-3.2を参照してください。 string (必須)
authorizationメソッド 承認エンドポイントでサポートされている HTTP 動詞。 GET は常に存在する必要があります。 POST は省略可能です。 次のいずれかを含む文字列配列:
「削除」
「ゲット」
「ヘッド」
「オプション」
「パッチ」
「ポスト」
「プット」
「トレース」
bearerTokenSendingメソッド アクセス トークンを API に渡すメカニズムを指定します。 次のいずれかを含む文字列配列:
'authorizationHeader'
'クエリ'
クライアント認証メソッド この承認サーバーのトークン エンドポイントでサポートされる認証方法。 使用できる値は Basic または Body です。 Body を指定すると、クライアント資格情報とその他のパラメーターが要求本文内でアプリケーション/x-www-form-urlencoded 形式で渡されます。 次のいずれかを含む文字列配列:
「ベーシック」
「ボディ」
クライアントID この承認サーバーに登録されているクライアントまたはアプリ ID。 string (必須)
clientRegistrationEndpoint この承認サーバーのクライアントまたはアプリの登録が実行されるページへの省略可能な参照。 参照されるエンティティへの絶対 URL が含まれています。 string (必須)
クライアントシークレット この承認サーバーに登録されているクライアントまたはアプリ シークレット。 このプロパティは'GET' 操作では入力されません。 値を取得するには、'/listSecrets' POST 要求を使用します。 糸

制約：
機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。
デフォルトスコープ 既定で要求されるアクセス トークン スコープ。 API レベルでオーバーライドできます。 スペース区切りの値を含む文字列の形式で指定する必要があります。 文字列
形容 承認サーバーの説明。 HTML 書式設定タグを含めることができます。 文字列
ディスプレイ名 ユーザー フレンドリな承認サーバー名。 糸

制約：
最小長 = 1
最大長 = 50 (必須)
grantTypes (グラントタイプ) クライアントがアクセス トークンを要求するために使用する承認付与の形式。 次のいずれかを含む文字列配列:
'authorizationCode'
'clientCredentials'
「暗黙的」
'resourceOwnerPassword' (必須)
リソースオーナーパスワード この承認サーバーでリソース所有者のパスワード許可の種類がサポートされている場合は、必要に応じて指定できます。 既定のリソース所有者のパスワード。 文字列
resourceOwnerユーザー名 この承認サーバーでリソース所有者のパスワード許可の種類がサポートされている場合は、必要に応じて指定できます。 既定のリソース所有者のユーザー名。 文字列
サポートステート true の場合、承認サーバーには、承認要求から応答までの状態パラメーターが含まれます。 クライアントは、状態パラメーターを使用してプロトコル のセキュリティを高める場合があります。 ブール (bool)
tokenBodyParameters (トークンボディパラメータ) 名前と値の文字列プロパティを持つ JSON オブジェクトの配列として表される、この承認サーバーのトークン エンドポイントに必要な追加パラメーター ({"name" : "name value"、"value": "a value"})。 TokenBodyパラメータ契約[]
tokenEndpoint（トークンエンドポイント） OAuth トークン エンドポイント。 参照されるエンティティへの絶対 URI が含まれています。 文字列
useInApiドキュメンテーション true の場合、承認サーバーは開発者ポータルの API ドキュメントで使用されます。 値が指定されていない場合、既定では False。 ブール (bool)
useInTestConsoleの true の場合、承認サーバーは開発者ポータルのテスト コンソールで使用できます。 値が指定されていない場合は、既定で True です。 ブール (bool)

TokenBodyParameter契約

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

使用例

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

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

  • リソース グループの

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

リソースの形式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/authorizationServers@2024-06-01-preview"
  name = "string"
  parent_id = "string"
  body = {
    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
    }
  }
}

プロパティ値

Microsoft.ApiManagement/service/authorizationServers

名前 形容 価値
名前 リソース名 糸

制約：
最小長 = 1
最大長 = 80
パターン = ^[^*#&+:<>?]+$ (必須)
parent_id このリソースの親であるリソースの ID。 種類のリソースの ID: サービス
プロパティ 外部 OAuth 承認サーバー コントラクトのプロパティ。 AuthorizationServerContractProperties の
型 リソースの種類 "Microsoft.ApiManagement/service/authorizationServers@2024-06-01-preview" (英語)

AuthorizationServerContractProperties (承認サーバーコントラクトプロパティ)

名前 形容 価値
authorizationエンドポイント OAuth 承認エンドポイント。 http://tools.ietf.org/html/rfc6749#section-3.2を参照してください。 string (必須)
authorizationメソッド 承認エンドポイントでサポートされている HTTP 動詞。 GET は常に存在する必要があります。 POST は省略可能です。 次のいずれかを含む文字列配列:
「削除」
「ゲット」
「ヘッド」
「オプション」
「パッチ」
「ポスト」
「プット」
「トレース」
bearerTokenSendingメソッド アクセス トークンを API に渡すメカニズムを指定します。 次のいずれかを含む文字列配列:
'authorizationHeader'
'クエリ'
クライアント認証メソッド この承認サーバーのトークン エンドポイントでサポートされる認証方法。 使用できる値は Basic または Body です。 Body を指定すると、クライアント資格情報とその他のパラメーターが要求本文内でアプリケーション/x-www-form-urlencoded 形式で渡されます。 次のいずれかを含む文字列配列:
「ベーシック」
「ボディ」
クライアントID この承認サーバーに登録されているクライアントまたはアプリ ID。 string (必須)
clientRegistrationEndpoint この承認サーバーのクライアントまたはアプリの登録が実行されるページへの省略可能な参照。 参照されるエンティティへの絶対 URL が含まれています。 string (必須)
クライアントシークレット この承認サーバーに登録されているクライアントまたはアプリ シークレット。 このプロパティは'GET' 操作では入力されません。 値を取得するには、'/listSecrets' POST 要求を使用します。 糸

制約：
機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。
デフォルトスコープ 既定で要求されるアクセス トークン スコープ。 API レベルでオーバーライドできます。 スペース区切りの値を含む文字列の形式で指定する必要があります。 文字列
形容 承認サーバーの説明。 HTML 書式設定タグを含めることができます。 文字列
ディスプレイ名 ユーザー フレンドリな承認サーバー名。 糸

制約：
最小長 = 1
最大長 = 50 (必須)
grantTypes (グラントタイプ) クライアントがアクセス トークンを要求するために使用する承認付与の形式。 次のいずれかを含む文字列配列:
'authorizationCode'
'clientCredentials'
「暗黙的」
'resourceOwnerPassword' (必須)
リソースオーナーパスワード この承認サーバーでリソース所有者のパスワード許可の種類がサポートされている場合は、必要に応じて指定できます。 既定のリソース所有者のパスワード。 文字列
resourceOwnerユーザー名 この承認サーバーでリソース所有者のパスワード許可の種類がサポートされている場合は、必要に応じて指定できます。 既定のリソース所有者のユーザー名。 文字列
サポートステート true の場合、承認サーバーには、承認要求から応答までの状態パラメーターが含まれます。 クライアントは、状態パラメーターを使用してプロトコル のセキュリティを高める場合があります。 ブール (bool)
tokenBodyParameters (トークンボディパラメータ) 名前と値の文字列プロパティを持つ JSON オブジェクトの配列として表される、この承認サーバーのトークン エンドポイントに必要な追加パラメーター ({"name" : "name value"、"value": "a value"})。 TokenBodyパラメータ契約[]
tokenEndpoint（トークンエンドポイント） OAuth トークン エンドポイント。 参照されるエンティティへの絶対 URI が含まれています。 文字列
useInApiドキュメンテーション true の場合、承認サーバーは開発者ポータルの API ドキュメントで使用されます。 値が指定されていない場合、既定では False。 ブール (bool)
useInTestConsoleの true の場合、承認サーバーは開発者ポータルのテスト コンソールで使用できます。 値が指定されていない場合は、既定で True です。 ブール (bool)

TokenBodyParameter契約

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