Microsoft.ApiManagement service/portalsettings 2024-06-01-preview
- Latest
- 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 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.
Resource format
To create a Microsoft.ApiManagement/service/portalsettings resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.ApiManagement/service/portalsettings@2024-06-01-preview' = {
name: 'string'
// For remaining properties, see microsoft.apimanagement/service/portalsettings objects
}
microsoft.apimanagement/service/portalsettings objects
Set the name property to specify the type of object.
For signin, use:
{
name: 'signin'
properties: {
enabled: bool
}
}
For signup, use:
{
name: 'signup'
properties: {
enabled: bool
termsOfService: {
consentRequired: bool
enabled: bool
text: 'string'
}
}
}
For delegation, use:
{
name: 'delegation'
properties: {
subscriptions: {
enabled: bool
}
url: 'string'
userRegistration: {
enabled: bool
}
validationKey: 'string'
}
}
Property values
microsoft.apimanagement/service/portalsettings
| Name | Description | Value |
|---|---|---|
| name | Set to 'signin' for type Microsoft.ApiManagement/service/portalsettings. Set to 'signup' for type Microsoft.ApiManagement/service/portalsettings. Set to 'delegation' for type Microsoft.ApiManagement/service/portalsettings. | 'delegation' 'signin' 'signup' (required) |
Microsoft.ApiManagement/service/portalsettings
| Name | Description | Value |
|---|---|---|
| name | The resource name | 'signin' (required) |
| 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-in settings contract properties. | PortalSigninSettingProperties |
Microsoft.ApiManagement/service/portalsettings
| Name | Description | Value |
|---|---|---|
| name | The resource name | 'signup' (required) |
| 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 |
Microsoft.ApiManagement/service/portalsettings
| Name | Description | Value |
|---|---|---|
| name | The resource name | 'delegation' (required) |
| 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 | Delegation settings contract properties. | PortalDelegationSettingsProperties |
PortalDelegationSettingsProperties
| Name | Description | Value |
|---|---|---|
| subscriptions | Subscriptions delegation settings. | SubscriptionsDelegationSettingsProperties |
| url | A delegation Url. | string |
| userRegistration | User registration delegation settings. | RegistrationDelegationSettingsProperties |
| validationKey | A base64-encoded validation key to validate, that a request is coming from Azure API Management. | string Constraints: Sensitive value. Pass in as a secure parameter. |
PortalSigninSettingProperties
| Name | Description | Value |
|---|---|---|
| enabled | Redirect Anonymous users to the Sign-In page. | bool |
PortalSignupSettingsProperties
| Name | Description | Value |
|---|---|---|
| enabled | Allow users to sign up on a developer portal. | bool |
| termsOfService | Terms of service contract properties. | TermsOfServiceProperties |
RegistrationDelegationSettingsProperties
| Name | Description | Value |
|---|---|---|
| enabled | Enable or disable delegation for user registration. | bool |
SubscriptionsDelegationSettingsProperties
| Name | Description | Value |
|---|---|---|
| enabled | Enable or disable delegation for subscriptions. | bool |
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.
Resource format
To create a Microsoft.ApiManagement/service/portalsettings resource, add the following JSON to your template.
{
"name": "string"
// For remaining properties, see microsoft.apimanagement/service/portalsettings objects
}
microsoft.apimanagement/service/portalsettings objects
Set the name property to specify the type of object.
For signin, use:
{
"name": "signin",
"properties": {
"enabled": "bool"
}
}
For signup, use:
{
"name": "signup",
"properties": {
"enabled": "bool",
"termsOfService": {
"consentRequired": "bool",
"enabled": "bool",
"text": "string"
}
}
}
For delegation, use:
{
"name": "delegation",
"properties": {
"subscriptions": {
"enabled": "bool"
},
"url": "string",
"userRegistration": {
"enabled": "bool"
},
"validationKey": "string"
}
}
Property values
microsoft.apimanagement/service/portalsettings
| Name | Description | Value |
|---|---|---|
| name | Set to 'signin' for type Microsoft.ApiManagement/service/portalsettings. Set to 'signup' for type Microsoft.ApiManagement/service/portalsettings. Set to 'delegation' for type Microsoft.ApiManagement/service/portalsettings. | 'delegation' 'signin' 'signup' (required) |
Microsoft.ApiManagement/service/portalsettings
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2024-06-01-preview' |
| name | The resource name | 'signin' (required) |
| properties | Sign-in settings contract properties. | PortalSigninSettingProperties |
| type | The resource type | 'Microsoft.ApiManagement/service/portalsettings' |
Microsoft.ApiManagement/service/portalsettings
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2024-06-01-preview' |
| name | The resource name | 'signup' (required) |
| properties | Sign-up settings contract properties. | PortalSignupSettingsProperties |
| type | The resource type | 'Microsoft.ApiManagement/service/portalsettings' |
Microsoft.ApiManagement/service/portalsettings
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2024-06-01-preview' |
| name | The resource name | 'delegation' (required) |
| properties | Delegation settings contract properties. | PortalDelegationSettingsProperties |
| type | The resource type | 'Microsoft.ApiManagement/service/portalsettings' |
PortalDelegationSettingsProperties
| Name | Description | Value |
|---|---|---|
| subscriptions | Subscriptions delegation settings. | SubscriptionsDelegationSettingsProperties |
| url | A delegation Url. | string |
| userRegistration | User registration delegation settings. | RegistrationDelegationSettingsProperties |
| validationKey | A base64-encoded validation key to validate, that a request is coming from Azure API Management. | string Constraints: Sensitive value. Pass in as a secure parameter. |
PortalSigninSettingProperties
| Name | Description | Value |
|---|---|---|
| enabled | Redirect Anonymous users to the Sign-In page. | bool |
PortalSignupSettingsProperties
| Name | Description | Value |
|---|---|---|
| enabled | Allow users to sign up on a developer portal. | bool |
| termsOfService | Terms of service contract properties. | TermsOfServiceProperties |
RegistrationDelegationSettingsProperties
| Name | Description | Value |
|---|---|---|
| enabled | Enable or disable delegation for user registration. | bool |
SubscriptionsDelegationSettingsProperties
| Name | Description | Value |
|---|---|---|
| enabled | Enable or disable delegation for subscriptions. | bool |
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.
Resource format
To create a Microsoft.ApiManagement/service/portalsettings resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
name = "string"
// For remaining properties, see microsoft.apimanagement/service/portalsettings objects
}
microsoft.apimanagement/service/portalsettings objects
Set the name property to specify the type of object.
For signin, use:
{
name = "signin"
properties = {
enabled = bool
}
}
For signup, use:
{
name = "signup"
properties = {
enabled = bool
termsOfService = {
consentRequired = bool
enabled = bool
text = "string"
}
}
}
For delegation, use:
{
name = "delegation"
properties = {
subscriptions = {
enabled = bool
}
url = "string"
userRegistration = {
enabled = bool
}
validationKey = "string"
}
}
Property values
microsoft.apimanagement/service/portalsettings
| Name | Description | Value |
|---|---|---|
| name | Set to 'signin' for type Microsoft.ApiManagement/service/portalsettings. Set to 'signup' for type Microsoft.ApiManagement/service/portalsettings. Set to 'delegation' for type Microsoft.ApiManagement/service/portalsettings. | 'delegation' 'signin' 'signup' (required) |
Microsoft.ApiManagement/service/portalsettings
| Name | Description | Value |
|---|---|---|
| name | The resource name | 'signin' (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: service |
| properties | Sign-in settings contract properties. | PortalSigninSettingProperties |
| type | The resource type | "Microsoft.ApiManagement/service/portalsettings@2024-06-01-preview" |
Microsoft.ApiManagement/service/portalsettings
| Name | Description | Value |
|---|---|---|
| name | The resource name | 'signup' (required) |
| 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 |
| type | The resource type | "Microsoft.ApiManagement/service/portalsettings@2024-06-01-preview" |
Microsoft.ApiManagement/service/portalsettings
| Name | Description | Value |
|---|---|---|
| name | The resource name | 'delegation' (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: service |
| properties | Delegation settings contract properties. | PortalDelegationSettingsProperties |
| type | The resource type | "Microsoft.ApiManagement/service/portalsettings@2024-06-01-preview" |
PortalDelegationSettingsProperties
| Name | Description | Value |
|---|---|---|
| subscriptions | Subscriptions delegation settings. | SubscriptionsDelegationSettingsProperties |
| url | A delegation Url. | string |
| userRegistration | User registration delegation settings. | RegistrationDelegationSettingsProperties |
| validationKey | A base64-encoded validation key to validate, that a request is coming from Azure API Management. | string Constraints: Sensitive value. Pass in as a secure parameter. |
PortalSigninSettingProperties
| Name | Description | Value |
|---|---|---|
| enabled | Redirect Anonymous users to the Sign-In page. | bool |
PortalSignupSettingsProperties
| Name | Description | Value |
|---|---|---|
| enabled | Allow users to sign up on a developer portal. | bool |
| termsOfService | Terms of service contract properties. | TermsOfServiceProperties |
RegistrationDelegationSettingsProperties
| Name | Description | Value |
|---|---|---|
| enabled | Enable or disable delegation for user registration. | bool |
SubscriptionsDelegationSettingsProperties
| Name | Description | Value |
|---|---|---|
| enabled | Enable or disable delegation for subscriptions. | bool |
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 |