Share via

Microsoft.ApiManagement service/portalconfigs 2024-05-01

Bicep 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.

Resource format

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

resource symbolicname 'Microsoft.ApiManagement/service/portalconfigs@2024-05-01' = {
  parent: resourceSymbolicName
  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

Microsoft.ApiManagement/service/portalconfigs

Name Description Value
name The resource name string

Constraints:
Min length = 1
Max length = 80 (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 The developer portal configuration contract properties. 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

Constraints:
Sensitive value. Pass in as a secure parameter.

PortalConfigProperties

Name Description Value
cors The developer portal Cross-Origin Resource Sharing (CORS) settings. PortalConfigCorsProperties
csp The developer portal Content Security Policy (CSP) settings. PortalConfigCspProperties
delegation The developer portal delegation settings. PortalConfigDelegationProperties
enableBasicAuth Enable or disable Basic authentication method. bool
signin PortalConfigPropertiesSignin
signup PortalConfigPropertiesSignup

PortalConfigPropertiesSignin

Name Description Value
require Redirect anonymous users to the sign-in page. bool

PortalConfigPropertiesSignup

Name Description Value
termsOfService Terms of service settings. PortalConfigTermsOfServiceProperties

PortalConfigTermsOfServiceProperties

Name Description Value
requireConsent Ask user for consent to the terms of service. bool
text A terms of service text. string

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.

Resource format

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

{
  "type": "Microsoft.ApiManagement/service/portalconfigs",
  "apiVersion": "2024-05-01",
  "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

Microsoft.ApiManagement/service/portalconfigs

Name Description Value
apiVersion The api version '2024-05-01'
name The resource name string

Constraints:
Min length = 1
Max length = 80 (required)
properties The developer portal configuration contract properties. PortalConfigProperties
type The resource type 'Microsoft.ApiManagement/service/portalconfigs'

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

Constraints:
Sensitive value. Pass in as a secure parameter.

PortalConfigProperties

Name Description Value
cors The developer portal Cross-Origin Resource Sharing (CORS) settings. PortalConfigCorsProperties
csp The developer portal Content Security Policy (CSP) settings. PortalConfigCspProperties
delegation The developer portal delegation settings. PortalConfigDelegationProperties
enableBasicAuth Enable or disable Basic authentication method. bool
signin PortalConfigPropertiesSignin
signup PortalConfigPropertiesSignup

PortalConfigPropertiesSignin

Name Description Value
require Redirect anonymous users to the sign-in page. bool

PortalConfigPropertiesSignup

Name Description Value
termsOfService Terms of service settings. PortalConfigTermsOfServiceProperties

PortalConfigTermsOfServiceProperties

Name Description Value
requireConsent Ask user for consent to the terms of service. bool
text A terms of service text. string

Usage Examples

Terraform (AzAPI provider) resource definition

The service/portalconfigs 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/portalconfigs resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/portalconfigs@2024-05-01"
  name = "string"
  parent_id = "string"
  body = {
    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

Microsoft.ApiManagement/service/portalconfigs

Name Description Value
name The resource name string

Constraints:
Min length = 1
Max length = 80 (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: service
properties The developer portal configuration contract properties. PortalConfigProperties
type The resource type "Microsoft.ApiManagement/service/portalconfigs@2024-05-01"

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

Constraints:
Sensitive value. Pass in as a secure parameter.

PortalConfigProperties

Name Description Value
cors The developer portal Cross-Origin Resource Sharing (CORS) settings. PortalConfigCorsProperties
csp The developer portal Content Security Policy (CSP) settings. PortalConfigCspProperties
delegation The developer portal delegation settings. PortalConfigDelegationProperties
enableBasicAuth Enable or disable Basic authentication method. bool
signin PortalConfigPropertiesSignin
signup PortalConfigPropertiesSignup

PortalConfigPropertiesSignin

Name Description Value
require Redirect anonymous users to the sign-in page. bool

PortalConfigPropertiesSignup

Name Description Value
termsOfService Terms of service settings. PortalConfigTermsOfServiceProperties

PortalConfigTermsOfServiceProperties

Name Description Value
requireConsent Ask user for consent to the terms of service. bool
text A terms of service text. string