Microsoft.ApiManagement service/portalsettings 2021-08-01
- 最新の を
する - 2024-06-01-preview
- 2024-05-01
- 2023-09-01-preview
- 2023-05-01-preview
- 2023-03-01-preview
- 2022-09-01-preview
- 2022-08-01
- 2022-04-01-preview
- 2021-12-01-preview
- 2021-08-01
- 2021-04-01-preview
- 2021-01-01-preview
- 2020-12-01
- 2020-06-01-preview
- 2019-12-01
- 2019-12-01-preview
- 2019-01-01
- 2018-06-01-preview
- 2018-01-01
- 2017-03-01
Bicep リソース定義
service/portalsettings リソースの種類は、次をターゲットとする操作と共にデプロイできます。
- リソース グループの - リソース グループのデプロイ コマンド 参照
各 API バージョンで変更されたプロパティの一覧については、変更ログの
リソースの形式
Microsoft.ApiManagement/service/portalsettings リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.ApiManagement/service/portalsettings@2021-08-01' = {
name: 'string'
// For remaining properties, see microsoft.apimanagement/service/portalsettings objects
}
microsoft.apimanagement/service/portalsettings オブジェクト
名 プロパティを設定して、オブジェクトの種類を指定します。
サインイン の場合は、次を使用します。
{
name: 'signin'
properties: {
enabled: bool
}
}
サインアップの場合は、次を使用します。
{
name: 'signup'
properties: {
enabled: bool
termsOfService: {
consentRequired: bool
enabled: bool
text: 'string'
}
}
}
委任の場合は、次を使用します。
{
name: 'delegation'
properties: {
subscriptions: {
enabled: bool
}
url: 'string'
userRegistration: {
enabled: bool
}
validationKey: 'string'
}
}
プロパティ値
microsoft.apimanagement/service/portalsettings
| 名前 | 形容 | 価値 |
|---|---|---|
| 名前 | Microsoft.ApiManagement/service/portalsettings |
'delegation' 'signin' 'signup' (必須) |
Microsoft.ApiManagement/service/portalsettings
| 名前 | 形容 | 価値 |
|---|---|---|
| 名前 | リソース名 | 'signin' (必須) |
| 親 | Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。 詳細については、「親リソースの外部 |
種類のリソースのシンボリック名: サービス |
| プロパティ | サインイン設定のコントラクト プロパティ。 | PortalSigninSettingProperties |
Microsoft.ApiManagement/service/portalsettings
| 名前 | 形容 | 価値 |
|---|---|---|
| 名前 | リソース名 | 'signup' (必須) |
| 親 | Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。 詳細については、「親リソースの外部 |
種類のリソースのシンボリック名: サービス |
| プロパティ | サインアップ設定のコントラクト プロパティ。 | PortalSignupSettingsProperties |
Microsoft.ApiManagement/service/portalsettings
| 名前 | 形容 | 価値 |
|---|---|---|
| 名前 | リソース名 | 'delegation' (必須) |
| 親 | Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。 詳細については、「親リソースの外部 |
種類のリソースのシンボリック名: サービス |
| プロパティ | 委任設定のコントラクト プロパティ。 | PortalDelegationSettingsProperties |
PortalDelegationSettingsProperties
| 名前 | 形容 | 価値 |
|---|---|---|
| サブスクリプション | サブスクリプション委任の設定。 | SubscriptionsDelegationSettingsProperties |
| url | 委任 URL。 | 糸 |
| userRegistration | ユーザー登録委任の設定。 | RegistrationDelegationSettingsProperties |
| validationKey | 要求が Azure API Management から送信されていることを検証するための base64 でエンコードされた検証キー。 | 糸 制約： 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
PortalSigninSettingProperties
| 名前 | 形容 | 価値 |
|---|---|---|
| 有効 | 匿名ユーザーを Sign-In ページにリダイレクトします。 | bool |
PortalSignupSettingsProperties
| 名前 | 形容 | 価値 |
|---|---|---|
| 有効 | ユーザーが開発者ポータルにサインアップできるようにします。 | bool |
| termsOfService | サービス条件コントラクトのプロパティ。 | TermsOfServiceProperties の |
RegistrationDelegationSettingsProperties
| 名前 | 形容 | 価値 |
|---|---|---|
| 有効 | ユーザー登録の委任を有効または無効にします。 | bool |
SubscriptionsDelegationSettingsProperties
| 名前 | 形容 | 価値 |
|---|---|---|
| 有効 | サブスクリプションの委任を有効または無効にします。 | bool |
TermsOfServiceProperties
| 名前 | 形容 | 価値 |
|---|---|---|
| consentRequired | サービス利用規約への同意をユーザーに求めます。 | bool |
| 有効 | サインアップ プロセス中にサービス条件を表示します。 | bool |
| テキスト | サービス条件のテキスト。 | 糸 |
ARM テンプレート リソース定義
service/portalsettings リソースの種類は、次をターゲットとする操作と共にデプロイできます。
- リソース グループの - リソース グループのデプロイ コマンド 参照
各 API バージョンで変更されたプロパティの一覧については、変更ログの
リソースの形式
Microsoft.ApiManagement/service/portalsettings リソースを作成するには、次の JSON をテンプレートに追加します。
{
"name": "string"
// For remaining properties, see microsoft.apimanagement/service/portalsettings objects
}
microsoft.apimanagement/service/portalsettings オブジェクト
名 プロパティを設定して、オブジェクトの種類を指定します。
サインイン の場合は、次を使用します。
{
"name": "signin",
"properties": {
"enabled": "bool"
}
}
サインアップの場合は、次を使用します。
{
"name": "signup",
"properties": {
"enabled": "bool",
"termsOfService": {
"consentRequired": "bool",
"enabled": "bool",
"text": "string"
}
}
}
委任の場合は、次を使用します。
{
"name": "delegation",
"properties": {
"subscriptions": {
"enabled": "bool"
},
"url": "string",
"userRegistration": {
"enabled": "bool"
},
"validationKey": "string"
}
}
プロパティ値
microsoft.apimanagement/service/portalsettings
| 名前 | 形容 | 価値 |
|---|---|---|
| 名前 | Microsoft.ApiManagement/service/portalsettings |
'delegation' 'signin' 'signup' (必須) |
Microsoft.ApiManagement/service/portalsettings
| 名前 | 形容 | 価値 |
|---|---|---|
| apiVersion | API のバージョン | '2021-08-01' |
| 名前 | リソース名 | 'signin' (必須) |
| プロパティ | サインイン設定のコントラクト プロパティ。 | PortalSigninSettingProperties |
| 種類 | リソースの種類 | 'Microsoft.ApiManagement/service/portalsettings' |
Microsoft.ApiManagement/service/portalsettings
| 名前 | 形容 | 価値 |
|---|---|---|
| apiVersion | API のバージョン | '2021-08-01' |
| 名前 | リソース名 | 'signup' (必須) |
| プロパティ | サインアップ設定のコントラクト プロパティ。 | PortalSignupSettingsProperties |
| 種類 | リソースの種類 | 'Microsoft.ApiManagement/service/portalsettings' |
Microsoft.ApiManagement/service/portalsettings
| 名前 | 形容 | 価値 |
|---|---|---|
| apiVersion | API のバージョン | '2021-08-01' |
| 名前 | リソース名 | 'delegation' (必須) |
| プロパティ | 委任設定のコントラクト プロパティ。 | PortalDelegationSettingsProperties |
| 種類 | リソースの種類 | 'Microsoft.ApiManagement/service/portalsettings' |
PortalDelegationSettingsProperties
| 名前 | 形容 | 価値 |
|---|---|---|
| サブスクリプション | サブスクリプション委任の設定。 | SubscriptionsDelegationSettingsProperties |
| url | 委任 URL。 | 糸 |
| userRegistration | ユーザー登録委任の設定。 | RegistrationDelegationSettingsProperties |
| validationKey | 要求が Azure API Management から送信されていることを検証するための base64 でエンコードされた検証キー。 | 糸 制約： 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
PortalSigninSettingProperties
| 名前 | 形容 | 価値 |
|---|---|---|
| 有効 | 匿名ユーザーを Sign-In ページにリダイレクトします。 | bool |
PortalSignupSettingsProperties
| 名前 | 形容 | 価値 |
|---|---|---|
| 有効 | ユーザーが開発者ポータルにサインアップできるようにします。 | bool |
| termsOfService | サービス条件コントラクトのプロパティ。 | TermsOfServiceProperties の |
RegistrationDelegationSettingsProperties
| 名前 | 形容 | 価値 |
|---|---|---|
| 有効 | ユーザー登録の委任を有効または無効にします。 | bool |
SubscriptionsDelegationSettingsProperties
| 名前 | 形容 | 価値 |
|---|---|---|
| 有効 | サブスクリプションの委任を有効または無効にします。 | bool |
TermsOfServiceProperties
| 名前 | 形容 | 価値 |
|---|---|---|
| consentRequired | サービス利用規約への同意をユーザーに求めます。 | bool |
| 有効 | サインアップ プロセス中にサービス条件を表示します。 | bool |
| テキスト | サービス条件のテキスト。 | 糸 |
Terraform (AzAPI プロバイダー) リソース定義
service/portalsettings リソースの種類は、次をターゲットとする操作と共にデプロイできます。
- リソース グループの
各 API バージョンで変更されたプロパティの一覧については、変更ログの
リソースの形式
Microsoft.ApiManagement/service/portalsettings リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
name = "string"
// For remaining properties, see microsoft.apimanagement/service/portalsettings objects
}
microsoft.apimanagement/service/portalsettings オブジェクト
名 プロパティを設定して、オブジェクトの種類を指定します。
サインイン の場合は、次を使用します。
{
name = "signin"
properties = {
enabled = bool
}
}
サインアップの場合は、次を使用します。
{
name = "signup"
properties = {
enabled = bool
termsOfService = {
consentRequired = bool
enabled = bool
text = "string"
}
}
}
委任の場合は、次を使用します。
{
name = "delegation"
properties = {
subscriptions = {
enabled = bool
}
url = "string"
userRegistration = {
enabled = bool
}
validationKey = "string"
}
}
プロパティ値
microsoft.apimanagement/service/portalsettings
| 名前 | 形容 | 価値 |
|---|---|---|
| 名前 | Microsoft.ApiManagement/service/portalsettings |
'delegation' 'signin' 'signup' (必須) |
Microsoft.ApiManagement/service/portalsettings
| 名前 | 形容 | 価値 |
|---|---|---|
| 名前 | リソース名 | 'signin' (必須) |
| parent_id | このリソースの親であるリソースの ID。 | 種類のリソースの ID: サービス |
| プロパティ | サインイン設定のコントラクト プロパティ。 | PortalSigninSettingProperties |
| 種類 | リソースの種類 | "Microsoft.ApiManagement/service/portalsettings@2021-08-01" |
Microsoft.ApiManagement/service/portalsettings
| 名前 | 形容 | 価値 |
|---|---|---|
| 名前 | リソース名 | 'signup' (必須) |
| parent_id | このリソースの親であるリソースの ID。 | 種類のリソースの ID: サービス |
| プロパティ | サインアップ設定のコントラクト プロパティ。 | PortalSignupSettingsProperties |
| 種類 | リソースの種類 | "Microsoft.ApiManagement/service/portalsettings@2021-08-01" |
Microsoft.ApiManagement/service/portalsettings
| 名前 | 形容 | 価値 |
|---|---|---|
| 名前 | リソース名 | 'delegation' (必須) |
| parent_id | このリソースの親であるリソースの ID。 | 種類のリソースの ID: サービス |
| プロパティ | 委任設定のコントラクト プロパティ。 | PortalDelegationSettingsProperties |
| 種類 | リソースの種類 | "Microsoft.ApiManagement/service/portalsettings@2021-08-01" |
PortalDelegationSettingsProperties
| 名前 | 形容 | 価値 |
|---|---|---|
| サブスクリプション | サブスクリプション委任の設定。 | SubscriptionsDelegationSettingsProperties |
| url | 委任 URL。 | 糸 |
| userRegistration | ユーザー登録委任の設定。 | RegistrationDelegationSettingsProperties |
| validationKey | 要求が Azure API Management から送信されていることを検証するための base64 でエンコードされた検証キー。 | 糸 制約： 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
PortalSigninSettingProperties
| 名前 | 形容 | 価値 |
|---|---|---|
| 有効 | 匿名ユーザーを Sign-In ページにリダイレクトします。 | bool |
PortalSignupSettingsProperties
| 名前 | 形容 | 価値 |
|---|---|---|
| 有効 | ユーザーが開発者ポータルにサインアップできるようにします。 | bool |
| termsOfService | サービス条件コントラクトのプロパティ。 | TermsOfServiceProperties の |
RegistrationDelegationSettingsProperties
| 名前 | 形容 | 価値 |
|---|---|---|
| 有効 | ユーザー登録の委任を有効または無効にします。 | bool |
SubscriptionsDelegationSettingsProperties
| 名前 | 形容 | 価値 |
|---|---|---|
| 有効 | サブスクリプションの委任を有効または無効にします。 | bool |
TermsOfServiceProperties
| 名前 | 形容 | 価値 |
|---|---|---|
| consentRequired | サービス利用規約への同意をユーザーに求めます。 | bool |
| 有効 | サインアップ プロセス中にサービス条件を表示します。 | bool |
| テキスト | サービス条件のテキスト。 | 糸 |