Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
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: 'delegation'.
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: 'delegation'
parent: resourceSymbolicName
properties: {
subscriptions: {
enabled: bool
}
url: 'string'
userRegistration: {
enabled: bool
}
validationKey: 'string'
}
}
Property values
service/portalsettings-delegation
| Name | Description | Value |
|---|---|---|
| name | The resource name See how to set names and types for child resources in Bicep. |
'delegation' |
| 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. |
SubscriptionsDelegationSettingsProperties
| Name | Description | Value |
|---|---|---|
| enabled | Enable or disable delegation for subscriptions. | bool |
RegistrationDelegationSettingsProperties
| Name | Description | Value |
|---|---|---|
| enabled | Enable or disable delegation for user registration. | bool |
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: 'delegation'.
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": "delegation",
"properties": {
"subscriptions": {
"enabled": "bool"
},
"url": "string",
"userRegistration": {
"enabled": "bool"
},
"validationKey": "string"
}
}
Property values
service/portalsettings-delegation
| 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. |
'delegation' |
| 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. |
SubscriptionsDelegationSettingsProperties
| Name | Description | Value |
|---|---|---|
| enabled | Enable or disable delegation for subscriptions. | bool |
RegistrationDelegationSettingsProperties
| Name | Description | Value |
|---|---|---|
| enabled | Enable or disable delegation for user registration. | bool |
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: 'delegation'.
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 = "delegation"
parent_id = "string"
body = jsonencode({
properties = {
subscriptions = {
enabled = bool
}
url = "string"
userRegistration = {
enabled = bool
}
validationKey = "string"
}
})
}
Property values
service/portalsettings-delegation
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.ApiManagement/service/portalsettings@2023-09-01-preview" |
| name | The resource name | "delegation" |
| 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 |
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. |
SubscriptionsDelegationSettingsProperties
| Name | Description | Value |
|---|---|---|
| enabled | Enable or disable delegation for subscriptions. | bool |
RegistrationDelegationSettingsProperties
| Name | Description | Value |
|---|---|---|
| enabled | Enable or disable delegation for user registration. | bool |