Share via

Microsoft.ApiManagement サービス/portalsettings 'signup'

  • [アーティクル]

Bicep リソース定義

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

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

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

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

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

リソース形式

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

resource symbolicname 'Microsoft.ApiManagement/service/portalsettings@2023-05-01-preview' = {
  name: 'signup'
  parent: resourceSymbolicName
  properties: {
    enabled: bool
    termsOfService: {
      consentRequired: bool
      enabled: bool
      text: 'string'
    }
  }
}

プロパティ値

service/portalsettings-signup

名前 説明 値
name リソース名

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

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

PortalSignupSettingsProperties

名前 説明 値
enabled ユーザーが開発者ポータルにサインアップできるようにします。 [bool]
termsOfService サービス契約のプロパティ。 TermsOfServiceProperties

TermsOfServiceProperties

名前 説明 値
consentRequired サービス条件への同意をユーザーに求めます。 [bool]
enabled サインアップ プロセス中に利用規約を表示します。 [bool]
text サービス条件テキスト。 string

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

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

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

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

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

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

リソース形式

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

{
  "type": "Microsoft.ApiManagement/service/portalsettings",
  "apiVersion": "2023-05-01-preview",
  "name": "signup",
  "properties": {
    "enabled": "bool",
    "termsOfService": {
      "consentRequired": "bool",
      "enabled": "bool",
      "text": "string"
    }
  }
}

プロパティ値

service/portalsettings-signup

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

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

PortalSignupSettingsProperties

名前 説明 値
enabled ユーザーが開発者ポータルにサインアップできるようにします。 [bool]
termsOfService サービス条件コントラクトのプロパティ。 TermsOfServiceProperties

TermsOfServiceProperties

名前 説明 値
consentRequired 利用規約への同意をユーザーに求めます。 [bool]
enabled サインアップ プロセス中に利用規約を表示します。 [bool]
text サービス条件のテキスト。 string

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

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

  • リソース グループ

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

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

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

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

リソース形式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/portalsettings@2023-05-01-preview"
  name = "signup"
  parent_id = "string"
  body = jsonencode({
    properties = {
      enabled = bool
      termsOfService = {
        consentRequired = bool
        enabled = bool
        text = "string"
      }
    }
  })
}

プロパティ値

service/portalsettings-signup

名前 説明 値
type リソースの種類 "Microsoft.ApiManagement/service/portalsettings@2023-05-01-preview"
name リソース名 "サインアップ"
parent_id このリソースの親であるリソースの ID。 種類のリソースの ID: サービス
properties サインアップ設定のコントラクト プロパティ。 PortalSignupSettingsProperties

PortalSignupSettingsProperties

名前 説明 値
enabled ユーザーが開発者ポータルにサインアップできるようにします。 [bool]
termsOfService サービス条件コントラクトのプロパティ。 TermsOfServiceProperties

TermsOfServiceProperties

名前 説明 値
consentRequired 利用規約への同意をユーザーに求めます。 [bool]
enabled サインアップ プロセス中に利用規約を表示します。 [bool]
text サービス条件のテキスト。 string