The service/portalsettings resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
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:
To create a Microsoft.ApiManagement/service/portalsettings resource, add the following JSON to your template.
{
"type": "Microsoft.ApiManagement/service/portalsettings",
"apiVersion": "2023-05-01-preview",
"name": "signup",
"properties": {
"enabled": "bool",
"termsOfService": {
"consentRequired": "bool",
"enabled": "bool",
"text": "string"
}
}
}
Name | Description | Value |
---|---|---|
type | The resource type | 'Microsoft.ApiManagement/service/portalsettings' |
apiVersion | The resource api version | '2023-05-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 |
Name | Description | Value |
---|---|---|
enabled | Allow users to sign up on a developer portal. | bool |
termsOfService | Terms of service contract properties. | 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 |