Microsoft.ApiManagement サービス/portalsettings 'delegation' 2021-08-01

Bicep リソース定義

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

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

name プロパティのオプション

service/portalsettings リソースは 、name プロパティの値に基づいて異なるプロパティを受け入れます。 この記事では、 を設定 name: 'delegation'するときに使用できるプロパティを示します。

その他のオプションについては、以下を参照してください。

リソース形式

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

resource symbolicname 'Microsoft.ApiManagement/service/portalsettings@2021-08-01' = {
  name: 'delegation'
  parent: resourceSymbolicName
  properties: {
    subscriptions: {
      enabled: bool
    }
    url: 'string'
    userRegistration: {
      enabled: bool
    }
    validationKey: 'string'
  }
}

プロパティ値

service/portalsettings-delegation

名前 説明
name リソース名

Bicep で子リソースの名前と型を設定する方法を参照してください。
'delegation'
parent Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。

詳細については、「 親リソースの外部にある子リソース」を参照してください。
種類のリソースのシンボル名: service
properties 委任設定のコントラクト プロパティ。 PortalDelegationSettingsProperties

PortalDelegationSettingsProperties

名前 説明
subscriptions サブスクリプション委任の設定。 SubscriptionsDelegationSettingsProperties
url 委任 URL。 string
userRegistration ユーザー登録委任の設定。 RegistrationDelegationSettingsProperties
validationKey 要求が Azure API Managementから送信されていることを検証するための base64 でエンコードされた検証キー。 string

SubscriptionsDelegationSettingsProperties

名前 説明
enabled サブスクリプションの委任を有効または無効にします。 [bool]

RegistrationDelegationSettingsProperties

名前 説明
enabled ユーザー登録の委任を有効または無効にします。 [bool]

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

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

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

name プロパティのオプション

service/portalsettings リソースは 、name プロパティの値に基づいて異なるプロパティを受け入れます。 この記事では、 を設定 name: 'delegation'するときに使用できるプロパティを示します。

その他のオプションについては、以下を参照してください。

リソース形式

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

{
  "type": "Microsoft.ApiManagement/service/portalsettings",
  "apiVersion": "2021-08-01",
  "name": "delegation",
  "properties": {
    "subscriptions": {
      "enabled": "bool"
    },
    "url": "string",
    "userRegistration": {
      "enabled": "bool"
    },
    "validationKey": "string"
  }
}

プロパティ値

service/portalsettings-delegation

名前 説明
type リソースの種類 'Microsoft.ApiManagement/service/portalsettings'
apiVersion リソース API のバージョン '2021-08-01'
name リソース名

JSON ARM テンプレートで子リソースの名前と型を設定する方法を参照してください。
'delegation'
properties 委任設定コントラクトのプロパティ。 PortalDelegationSettingsProperties

PortalDelegationSettingsProperties

名前 説明
subscriptions サブスクリプション委任の設定。 SubscriptionsDelegationSettingsProperties
url 委任 URL。 string
userRegistration ユーザー登録の委任設定。 RegistrationDelegationSettingsProperties
validationKey 要求が Azure API Managementから送信されていることを検証するための base64 でエンコードされた検証キー。 string

SubscriptionsDelegationSettingsProperties

名前 説明
enabled サブスクリプションの委任を有効または無効にします。 [bool]

RegistrationDelegationSettingsProperties

名前 説明
enabled ユーザー登録の委任を有効または無効にします。 [bool]

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

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

  • リソース グループ

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

name プロパティのオプション

service/portalsettings リソースは 、name プロパティの値に基づいて異なるプロパティを受け入れます。 この記事では、 を設定 name: 'delegation'するときに使用できるプロパティを示します。

その他のオプションについては、以下を参照してください。

リソース形式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/portalsettings@2021-08-01"
  name = "delegation"
  parent_id = "string"
  body = jsonencode({
    properties = {
      subscriptions = {
        enabled = bool
      }
      url = "string"
      userRegistration = {
        enabled = bool
      }
      validationKey = "string"
    }
  })
}

プロパティ値

service/portalsettings-delegation

名前 説明
type リソースの種類 "Microsoft.ApiManagement/service/portalsettings@2021-08-01"
name リソース名 "委任"
parent_id このリソースの親であるリソースの ID。 種類のリソースの ID: サービス
properties 委任設定コントラクトのプロパティ。 PortalDelegationSettingsProperties

PortalDelegationSettingsProperties

名前 説明
subscriptions サブスクリプション委任の設定。 SubscriptionsDelegationSettingsProperties
url 委任 URL。 string
userRegistration ユーザー登録の委任設定。 RegistrationDelegationSettingsProperties
validationKey 要求が Azure API Managementから送信されていることを検証するための base64 でエンコードされた検証キー。 string

SubscriptionsDelegationSettingsProperties

名前 説明
enabled サブスクリプションの委任を有効または無効にします。 [bool]

RegistrationDelegationSettingsProperties

名前 説明
enabled ユーザー登録の委任を有効または無効にします。 [bool]