PortalSettingsContract interface

Package:

@azure/arm-apimanagement

Portal Settings for the Developer Portal.

Extends

ProxyResource

Properties

enabled	Redirect Anonymous users to the Sign-In page.
subscriptions	Subscriptions delegation settings.
termsOfService	Terms of service contract properties.
url	A delegation Url.
userRegistration	User registration delegation settings.
validationKey	A base64-encoded validation key to validate, that a request is coming from Azure API Management.

Inherited Properties

id	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.
name	The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

enabled

Redirect Anonymous users to the Sign-In page.

enabled?: boolean

Property Value

boolean

subscriptions

Subscriptions delegation settings.

subscriptions?: SubscriptionsDelegationSettingsProperties

Property Value

SubscriptionsDelegationSettingsProperties

termsOfService

Terms of service contract properties.

termsOfService?: TermsOfServiceProperties

Property Value

TermsOfServiceProperties

url

A delegation Url.

url?: string

Property Value

string

userRegistration

User registration delegation settings.

userRegistration?: RegistrationDelegationSettingsProperties

Property Value

RegistrationDelegationSettingsProperties

validationKey

A base64-encoded validation key to validate, that a request is coming from Azure API Management.

validationKey?: string

Property Value

string

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From ProxyResource.id

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From ProxyResource.name

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From ProxyResource.type