次の方法で共有

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

Bicep リソース定義

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

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

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

リソースの形式

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

resource symbolicname 'Microsoft.ApiManagement/service/portalconfigs@2023-09-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    cors: {
      allowedOrigins: [
        'string'
      ]
    }
    csp: {
      allowedSources: [
        'string'
      ]
      mode: 'string'
      reportUri: [
        'string'
      ]
    }
    delegation: {
      delegateRegistration: bool
      delegateSubscription: bool
      delegationUrl: 'string'
      validationKey: 'string'
    }
    enableBasicAuth: bool
    signin: {
      require: bool
    }
    signup: {
      termsOfService: {
        requireConsent: bool
        text: 'string'
      }
    }
  }
}

プロパティ値

Microsoft.ApiManagement/service/portalconfigs

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

制約：
最小長 = 1
最大長 = 80 (必須)
親 Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。

詳細については、「親リソースの外部 子リソース」を参照してください。		 種類のリソースのシンボリック名: サービス
プロパティ 開発者ポータル構成コントラクトのプロパティ。 PortalConfigProperties

PortalConfigCorsProperties

名前 形容 価値
allowedOrigins 許可される配信元 (例: https://trusted.com)。 string[]

PortalConfigCspProperties

名前 形容 価値
allowedSources 許可されるソース (例: *.trusted.com、trusted.com、https://)。 string[]
モード 開発者ポータルのコンテンツ セキュリティ ポリシー (CSP) のモード。 'disabled'
'enabled'
'reportOnly'
reportUri ブラウザーが CSP 違反を報告するために使用する URL。 string[]

PortalConfigDelegationProperties

名前 形容 価値
delegateRegistration ユーザー登録の委任を有効または無効にします。 ブール (bool)
delegateSubscription 製品サブスクリプションの委任を有効または無効にします。 ブール (bool)
delegationUrl 委任エンドポイントの URL。 糸
validationKey 要求が Azure API Management サービスから送信されるようにするための base64 でエンコードされた検証キー。 糸

制約：
機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。

PortalConfigProperties

名前 形容 価値
クロスオリジンリソース共有 (CORS) 開発者ポータルのクロスオリジン リソース共有 (CORS) 設定。 PortalConfigCorsProperties
csp 開発者ポータルのコンテンツ セキュリティ ポリシー (CSP) の設定。 portalConfigCspProperties の
代表 開発者ポータルの委任設定。 portalConfigDelegationProperties の
enableBasicAuth 基本認証方法を有効または無効にします。 ブール (bool)
signin PortalConfigPropertiesSignin
サインアップ portalConfigPropertiesSignup の

PortalConfigPropertiesSignin

名前 形容 価値
要する 匿名ユーザーをサインイン ページにリダイレクトします。 ブール (bool)

PortalConfigPropertiesSignup

名前 形容 価値
termsOfService サービス条件の設定。 PortalConfigTermsOfServiceProperties

PortalConfigTermsOfServiceProperties

名前 形容 価値
requireConsent サービス利用規約への同意をユーザーに求めます。 ブール (bool)
テキスト サービス条件のテキスト。 糸

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

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

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

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

リソースの形式

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

{
  "type": "Microsoft.ApiManagement/service/portalconfigs",
  "apiVersion": "2023-09-01-preview",
  "name": "string",
  "properties": {
    "cors": {
      "allowedOrigins": [ "string" ]
    },
    "csp": {
      "allowedSources": [ "string" ],
      "mode": "string",
      "reportUri": [ "string" ]
    },
    "delegation": {
      "delegateRegistration": "bool",
      "delegateSubscription": "bool",
      "delegationUrl": "string",
      "validationKey": "string"
    },
    "enableBasicAuth": "bool",
    "signin": {
      "require": "bool"
    },
    "signup": {
      "termsOfService": {
        "requireConsent": "bool",
        "text": "string"
      }
    }
  }
}

プロパティ値

Microsoft.ApiManagement/service/portalconfigs

名前 形容 価値
apiVersion API のバージョン '2023-09-01-preview'
名前 リソース名 糸

制約：
最小長 = 1
最大長 = 80 (必須)
プロパティ 開発者ポータル構成コントラクトのプロパティ。 PortalConfigProperties
種類 リソースの種類 'Microsoft.ApiManagement/service/portalconfigs'

PortalConfigCorsProperties

名前 形容 価値
allowedOrigins 許可される配信元 (例: https://trusted.com)。 string[]

PortalConfigCspProperties

名前 形容 価値
allowedSources 許可されるソース (例: *.trusted.com、trusted.com、https://)。 string[]
モード 開発者ポータルのコンテンツ セキュリティ ポリシー (CSP) のモード。 'disabled'
'enabled'
'reportOnly'
reportUri ブラウザーが CSP 違反を報告するために使用する URL。 string[]

PortalConfigDelegationProperties

名前 形容 価値
delegateRegistration ユーザー登録の委任を有効または無効にします。 ブール (bool)
delegateSubscription 製品サブスクリプションの委任を有効または無効にします。 ブール (bool)
delegationUrl 委任エンドポイントの URL。 糸
validationKey 要求が Azure API Management サービスから送信されるようにするための base64 でエンコードされた検証キー。 糸

制約：
機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。

PortalConfigProperties

名前 形容 価値
クロスオリジンリソース共有 (CORS) 開発者ポータルのクロスオリジン リソース共有 (CORS) 設定。 PortalConfigCorsProperties
csp 開発者ポータルのコンテンツ セキュリティ ポリシー (CSP) の設定。 portalConfigCspProperties の
代表 開発者ポータルの委任設定。 portalConfigDelegationProperties の
enableBasicAuth 基本認証方法を有効または無効にします。 ブール (bool)
signin PortalConfigPropertiesSignin
サインアップ portalConfigPropertiesSignup の

PortalConfigPropertiesSignin

名前 形容 価値
要する 匿名ユーザーをサインイン ページにリダイレクトします。 ブール (bool)

PortalConfigPropertiesSignup

名前 形容 価値
termsOfService サービス条件の設定。 PortalConfigTermsOfServiceProperties

PortalConfigTermsOfServiceProperties

名前 形容 価値
requireConsent サービス利用規約への同意をユーザーに求めます。 ブール (bool)
テキスト サービス条件のテキスト。 糸

使用例

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

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

  • リソース グループの

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

リソースの形式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/portalconfigs@2023-09-01-preview"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      cors = {
        allowedOrigins = [
          "string"
        ]
      }
      csp = {
        allowedSources = [
          "string"
        ]
        mode = "string"
        reportUri = [
          "string"
        ]
      }
      delegation = {
        delegateRegistration = bool
        delegateSubscription = bool
        delegationUrl = "string"
        validationKey = "string"
      }
      enableBasicAuth = bool
      signin = {
        require = bool
      }
      signup = {
        termsOfService = {
          requireConsent = bool
          text = "string"
        }
      }
    }
  }
}

プロパティ値

Microsoft.ApiManagement/service/portalconfigs

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

制約：
最小長 = 1
最大長 = 80 (必須)
parent_id このリソースの親であるリソースの ID。 種類のリソースの ID: サービス
プロパティ 開発者ポータル構成コントラクトのプロパティ。 PortalConfigProperties
種類 リソースの種類 "Microsoft.ApiManagement/service/portalconfigs@2023-09-01-preview"

PortalConfigCorsProperties

名前 形容 価値
allowedOrigins 許可される配信元 (例: https://trusted.com)。 string[]

PortalConfigCspProperties

名前 形容 価値
allowedSources 許可されるソース (例: *.trusted.com、trusted.com、https://)。 string[]
モード 開発者ポータルのコンテンツ セキュリティ ポリシー (CSP) のモード。 'disabled'
'enabled'
'reportOnly'
reportUri ブラウザーが CSP 違反を報告するために使用する URL。 string[]

PortalConfigDelegationProperties

名前 形容 価値
delegateRegistration ユーザー登録の委任を有効または無効にします。 ブール (bool)
delegateSubscription 製品サブスクリプションの委任を有効または無効にします。 ブール (bool)
delegationUrl 委任エンドポイントの URL。 糸
validationKey 要求が Azure API Management サービスから送信されるようにするための base64 でエンコードされた検証キー。 糸

制約：
機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。

PortalConfigProperties

名前 形容 価値
クロスオリジンリソース共有 (CORS) 開発者ポータルのクロスオリジン リソース共有 (CORS) 設定。 PortalConfigCorsProperties
csp 開発者ポータルのコンテンツ セキュリティ ポリシー (CSP) の設定。 portalConfigCspProperties の
代表 開発者ポータルの委任設定。 portalConfigDelegationProperties の
enableBasicAuth 基本認証方法を有効または無効にします。 ブール (bool)
signin PortalConfigPropertiesSignin
サインアップ portalConfigPropertiesSignup の

PortalConfigPropertiesSignin

名前 形容 価値
要する 匿名ユーザーをサインイン ページにリダイレクトします。 ブール (bool)

PortalConfigPropertiesSignup

名前 形容 価値
termsOfService サービス条件の設定。 PortalConfigTermsOfServiceProperties

PortalConfigTermsOfServiceProperties

名前 形容 価値
requireConsent サービス利用規約への同意をユーザーに求めます。 ブール (bool)
テキスト サービス条件のテキスト。 糸