Microsoft.ApiManagement service/portalsettings 'signup' 2023-09-01-preview
Bicep resource definition
The service/portalsettings resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Options for name property
The service/portalsettings resource accepts different properties based on the value of the name property.
This article shows the properties that are available when you set name: 'signup'.
For other options, see:
Resource format
To create a Microsoft.ApiManagement/service/portalsettings resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.ApiManagement/service/portalsettings@2023-09-01-preview' = {
name: 'signup'
parent: resourceSymbolicName
properties: {
enabled: bool
termsOfService: {
consentRequired: bool
enabled: bool
text: 'string'
}
}
}
Property values
service/portalsettings-signup
| Name | Description | Value |
|---|---|---|
| name | The resource name See how to set names and types for child resources in Bicep. |
'signup' |
| parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: service |
| properties | Sign-up settings contract properties. | PortalSignupSettingsProperties |
PortalSignupSettingsProperties
| Name | Description | Value |
|---|---|---|
| enabled | Allow users to sign up on a developer portal. | bool |
| termsOfService | Terms of service contract properties. | TermsOfServiceProperties |
TermsOfServiceProperties
| Name | Description | Value |
|---|---|---|
| consentRequired | Ask user for consent to the terms of service. | bool |
| enabled | Display terms of service during a sign-up process. | bool |
| text | A terms of service text. | string |
ARM template resource definition
The service/portalsettings resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Options for name property
The service/portalsettings resource accepts different properties based on the value of the name property.
This article shows the properties that are available when you set name: 'signup'.
For other options, see:
Resource format
To create a Microsoft.ApiManagement/service/portalsettings resource, add the following JSON to your template.
{
"type": "Microsoft.ApiManagement/service/portalsettings",
"apiVersion": "2023-09-01-preview",
"name": "signup",
"properties": {
"enabled": "bool",
"termsOfService": {
"consentRequired": "bool",
"enabled": "bool",
"text": "string"
}
}
}
Property values
service/portalsettings-signup
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.ApiManagement/service/portalsettings' |
| apiVersion | The resource api version | '2023-09-01-preview' |
| name | The resource name See how to set names and types for child resources in JSON ARM templates. |
'signup' |
| properties | Sign-up settings contract properties. | PortalSignupSettingsProperties |
PortalSignupSettingsProperties
| Name | Description | Value |
|---|---|---|
| enabled | Allow users to sign up on a developer portal. | bool |
| termsOfService | Terms of service contract properties. | TermsOfServiceProperties |
TermsOfServiceProperties
| Name | Description | Value |
|---|---|---|
| consentRequired | Ask user for consent to the terms of service. | bool |
| enabled | Display terms of service during a sign-up process. | bool |
| text | A terms of service text. | string |
Terraform (AzAPI provider) resource definition
The service/portalsettings resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Options for name property
The service/portalsettings resource accepts different properties based on the value of the name property.
This article shows the properties that are available when you set name: 'signup'.
For other options, see:
Resource format
To create a Microsoft.ApiManagement/service/portalsettings resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/portalsettings@2023-09-01-preview"
name = "signup"
parent_id = "string"
body = jsonencode({
properties = {
enabled = bool
termsOfService = {
consentRequired = bool
enabled = bool
text = "string"
}
}
})
}
Property values
service/portalsettings-signup
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.ApiManagement/service/portalsettings@2023-09-01-preview" |
| name | The resource name | "signup" |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: service |
| properties | Sign-up settings contract properties. | PortalSignupSettingsProperties |
PortalSignupSettingsProperties
| Name | Description | Value |
|---|---|---|
| enabled | Allow users to sign up on a developer portal. | bool |
| termsOfService | Terms of service contract properties. | TermsOfServiceProperties |
TermsOfServiceProperties
| Name | Description | Value |
|---|---|---|
| consentRequired | Ask user for consent to the terms of service. | bool |
| enabled | Display terms of service during a sign-up process. | bool |
| text | A terms of service text. | string |