Portal Config - Create Or Update

Service:

API Management

API Version:

2024-05-01

Create or update the developer portal configuration.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalconfigs/{portalConfigId}?api-version=2024-05-01

URI Parameters

Name	In	Required	Type	Description
portalConfigId	path	True	string minLength: 1 maxLength: 80	Portal configuration identifier.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	The name of the API Management service.
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Header

Name	Required	Type	Description
If-Match	True	string	ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

Request Body

Name	Type	Description
properties.cors	PortalConfigCorsProperties	The developer portal Cross-Origin Resource Sharing (CORS) settings.
properties.csp	PortalConfigCspProperties	The developer portal Content Security Policy (CSP) settings.
properties.delegation	PortalConfigDelegationProperties	The developer portal delegation settings.
properties.enableBasicAuth	boolean	Enable or disable Basic authentication method.
properties.signin	Signin
properties.signup	Signup

Responses

Name	Type	Description
200 OK	PortalConfigContract	Operation completed successfully.
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

ApiManagementCreatePortalConfig

Sample request

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalconfigs/default?api-version=2024-05-01


{
  "properties": {
    "enableBasicAuth": true,
    "signin": {
      "require": false
    },
    "signup": {
      "termsOfService": {
        "text": "I agree to the service terms and conditions.",
        "requireConsent": false
      }
    },
    "delegation": {
      "delegateRegistration": false,
      "delegateSubscription": false,
      "delegationUrl": null,
      "validationKey": null
    },
    "csp": {
      "mode": "reportOnly",
      "reportUri": [
        "https://report.contoso.com"
      ],
      "allowedSources": [
        "*.contoso.com"
      ]
    },
    "cors": {
      "allowedOrigins": [
        "https://contoso.com"
      ]
    }
  }
}

Sample response

Status code:

200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalconfigs/default",
  "type": "Microsoft.ApiManagement/service/portalconfigs",
  "name": "default",
  "properties": {
    "enableBasicAuth": true,
    "signin": {
      "require": false
    },
    "signup": {
      "termsOfService": {
        "text": "I agree to the service terms and conditions.",
        "requireConsent": false
      }
    },
    "delegation": {
      "delegateRegistration": false,
      "delegateSubscription": false,
      "delegationUrl": null,
      "validationKey": null
    },
    "csp": {
      "mode": "reportOnly",
      "reportUri": [
        "https://report.contoso.com"
      ],
      "allowedSources": [
        "*.contoso.com"
      ]
    },
    "cors": {
      "allowedOrigins": [
        "https://contoso.com"
      ]
    }
  }
}

Definitions

Name	Description
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
PortalConfigContract	The developer portal configuration contract.
PortalConfigCorsProperties	The developer portal Cross-Origin Resource Sharing (CORS) settings.
PortalConfigCspProperties	The developer portal Content Security Policy (CSP) settings.
PortalConfigDelegationProperties
PortalConfigTermsOfServiceProperties	Terms of service contract properties.
PortalSettingsCspMode	The mode of the developer portal Content Security Policy (CSP).
Signin
Signup

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

PortalConfigContract

Object

The developer portal configuration contract.

Name	Type	Default value	Description
id	string		Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string		The name of the resource
properties.cors	PortalConfigCorsProperties		The developer portal Cross-Origin Resource Sharing (CORS) settings.
properties.csp	PortalConfigCspProperties		The developer portal Content Security Policy (CSP) settings.
properties.delegation	PortalConfigDelegationProperties		The developer portal delegation settings.
properties.enableBasicAuth	boolean	True	Enable or disable Basic authentication method.
properties.signin	Signin
properties.signup	Signup
type	string		The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

PortalConfigCorsProperties

Object

The developer portal Cross-Origin Resource Sharing (CORS) settings.

Name	Type	Description
allowedOrigins	string[]	Allowed origins, e.g. https://trusted.com.

PortalConfigCspProperties

Object

The developer portal Content Security Policy (CSP) settings.

Name	Type	Default value	Description
allowedSources	string[]		Allowed sources, e.g. *.trusted.com, trusted.com, https://.
mode	PortalSettingsCspMode	disabled	The mode of the developer portal Content Security Policy (CSP).
reportUri	string[]		The URLs used by the browser to report CSP violations.

PortalConfigDelegationProperties

Object

Name	Type	Default value	Description
delegateRegistration	boolean	False	Enable or disable delegation for user registration.
delegateSubscription	boolean	False	Enable or disable delegation for product subscriptions.
delegationUrl	string		A delegation endpoint URL.
validationKey	string		A base64-encoded validation key to ensure requests originate from Azure API Management service.

PortalConfigTermsOfServiceProperties

Object

Terms of service contract properties.

Name	Type	Default value	Description
requireConsent	boolean	False	Ask user for consent to the terms of service.
text	string		A terms of service text.

PortalSettingsCspMode

Enumeration

The mode of the developer portal Content Security Policy (CSP).

Value	Description
enabled	The browser will block requests not matching allowed origins.
disabled	The browser will not apply the origin restrictions.
reportOnly	The browser will report requests not matching allowed origins without blocking them.

Signin

Object

Name	Type	Default value	Description
require	boolean	False	Redirect anonymous users to the sign-in page.

Signup

Object

Name	Type	Description
termsOfService	PortalConfigTermsOfServiceProperties	Terms of service settings.