ARM template resource definition
The service/portalconfigs resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
To create a Microsoft.ApiManagement/service/portalconfigs resource, add the following JSON to your template.
{
"type": "Microsoft.ApiManagement/service/portalconfigs",
"apiVersion": "2023-05-01-preview",
"name": "string",
"properties": {
"cors": {
"allowedOrigins": [ "string" ]
},
"csp": {
"allowedSources": [ "string" ],
"mode": "string",
"reportUri": [ "string" ]
},
"delegation": {
"delegateRegistration": "bool",
"delegateSubscription": "bool",
"delegationUrl": "string",
"validationKey": "string"
},
"enableBasicAuth": "bool",
"signin": {
"require": "bool"
},
"signup": {
"termsOfService": {
"requireConsent": "bool",
"text": "string"
}
}
}
}
Property values
service/portalconfigs
Name |
Description |
Value |
type |
The resource type |
'Microsoft.ApiManagement/service/portalconfigs' |
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. |
string (required) |
properties |
The developer portal configuration contract properties. |
PortalConfigProperties |
PortalConfigProperties
PortalConfigCorsProperties
Name |
Description |
Value |
allowedOrigins |
Allowed origins, e.g. https://trusted.com . |
string[] |
PortalConfigCspProperties
Name |
Description |
Value |
allowedSources |
Allowed sources, e.g. *.trusted.com , trusted.com , https:// . |
string[] |
mode |
The mode of the developer portal Content Security Policy (CSP). |
'disabled' 'enabled' 'reportOnly' |
reportUri |
The URLs used by the browser to report CSP violations. |
string[] |
PortalConfigDelegationProperties
Name |
Description |
Value |
delegateRegistration |
Enable or disable delegation for user registration. |
bool |
delegateSubscription |
Enable or disable delegation for product subscriptions. |
bool |
delegationUrl |
A delegation endpoint URL. |
string |
validationKey |
A base64-encoded validation key to ensure requests originate from Azure API Management service. |
string |
PortalConfigPropertiesSignin
Name |
Description |
Value |
require |
Redirect anonymous users to the sign-in page. |
bool |
PortalConfigPropertiesSignup
PortalConfigTermsOfServiceProperties
Name |
Description |
Value |
requireConsent |
Ask user for consent to the terms of service. |
bool |
text |
A terms of service text. |
string |