Microsoft.ApiManagement service/portalsettings 'signup' 2017-03-01

The service/portalsettings resource type can be deployed to: Resource groups.

To learn about resource group deployments, see Bicep or ARM template.

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:

Template format

To create a Microsoft.ApiManagement/service/portalsettings resource, add the following Bicep or JSON to your template.

resource symbolicname 'Microsoft.ApiManagement/service/portalsettings@2017-03-01' = {
  name: 'signup'
  properties: {
    enabled: bool
    termsOfService: {
      consentRequired: bool
      enabled: bool
      text: 'string'
    }
  }
}

Property values

service/portalsettings-signup

Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.
'Microsoft.ApiManagement/service/portalsettings'
apiVersion The resource api version

For Bicep, set this value in the resource declaration.
'2017-03-01'
name The resource name

See how to set names and types for child resources in Bicep or 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. bool
enabled Display terms of service during a sign-up process. bool
text A terms of service text. string