CustomDomains interface

Package:

@azure/arm-cdn

Interface representing a CustomDomains.

Methods

beginCreate(string, string, string, string, CustomDomainParameters, CustomDomainsCreateOptionalParams)	Creates a new custom domain within an endpoint.
beginCreateAndWait(string, string, string, string, CustomDomainParameters, CustomDomainsCreateOptionalParams)	Creates a new custom domain within an endpoint.
beginDelete(string, string, string, string, CustomDomainsDeleteOptionalParams)	Deletes an existing custom domain within an endpoint.
beginDeleteAndWait(string, string, string, string, CustomDomainsDeleteOptionalParams)	Deletes an existing custom domain within an endpoint.
beginDisableCustomHttps(string, string, string, string, CustomDomainsDisableCustomHttpsOptionalParams)	Disable https delivery of the custom domain.
beginDisableCustomHttpsAndWait(string, string, string, string, CustomDomainsDisableCustomHttpsOptionalParams)	Disable https delivery of the custom domain.
beginEnableCustomHttps(string, string, string, string, CustomDomainsEnableCustomHttpsOptionalParams)	Enable https delivery of the custom domain.
beginEnableCustomHttpsAndWait(string, string, string, string, CustomDomainsEnableCustomHttpsOptionalParams)	Enable https delivery of the custom domain.
get(string, string, string, string, CustomDomainsGetOptionalParams)	Gets an existing custom domain within an endpoint.
listByEndpoint(string, string, string, CustomDomainsListByEndpointOptionalParams)	Lists all of the existing custom domains within an endpoint.

Method Details

beginCreate(string, string, string, string, CustomDomainParameters, CustomDomainsCreateOptionalParams)

Creates a new custom domain within an endpoint.

function beginCreate(resourceGroupName: string, profileName: string, endpointName: string, customDomainName: string, customDomainProperties: CustomDomainParameters, options?: CustomDomainsCreateOptionalParams): Promise<SimplePollerLike<OperationState<CustomDomain>, CustomDomain>>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

profileName

string

Name of the CDN profile which is unique within the resource group.

endpointName

string

Name of the endpoint under the profile which is unique globally.

customDomainName

string

Name of the custom domain within an endpoint.

customDomainProperties

CustomDomainParameters

Properties required to create a new custom domain.

options

CustomDomainsCreateOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<CustomDomain>, CustomDomain>>

beginCreateAndWait(string, string, string, string, CustomDomainParameters, CustomDomainsCreateOptionalParams)

Creates a new custom domain within an endpoint.

function beginCreateAndWait(resourceGroupName: string, profileName: string, endpointName: string, customDomainName: string, customDomainProperties: CustomDomainParameters, options?: CustomDomainsCreateOptionalParams): Promise<CustomDomain>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

profileName

string

Name of the CDN profile which is unique within the resource group.

endpointName

string

Name of the endpoint under the profile which is unique globally.

customDomainName

string

Name of the custom domain within an endpoint.

customDomainProperties

CustomDomainParameters

Properties required to create a new custom domain.

options

CustomDomainsCreateOptionalParams

The options parameters.

Returns

Promise<CustomDomain>

beginDelete(string, string, string, string, CustomDomainsDeleteOptionalParams)

Deletes an existing custom domain within an endpoint.

function beginDelete(resourceGroupName: string, profileName: string, endpointName: string, customDomainName: string, options?: CustomDomainsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

profileName

string

Name of the CDN profile which is unique within the resource group.

endpointName

string

Name of the endpoint under the profile which is unique globally.

customDomainName

string

Name of the custom domain within an endpoint.

options

CustomDomainsDeleteOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, string, string, CustomDomainsDeleteOptionalParams)

Deletes an existing custom domain within an endpoint.

function beginDeleteAndWait(resourceGroupName: string, profileName: string, endpointName: string, customDomainName: string, options?: CustomDomainsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

profileName

string

Name of the CDN profile which is unique within the resource group.

endpointName

string

Name of the endpoint under the profile which is unique globally.

customDomainName

string

Name of the custom domain within an endpoint.

options

CustomDomainsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginDisableCustomHttps(string, string, string, string, CustomDomainsDisableCustomHttpsOptionalParams)

Disable https delivery of the custom domain.

function beginDisableCustomHttps(resourceGroupName: string, profileName: string, endpointName: string, customDomainName: string, options?: CustomDomainsDisableCustomHttpsOptionalParams): Promise<SimplePollerLike<OperationState<CustomDomain>, CustomDomain>>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

profileName

string

Name of the CDN profile which is unique within the resource group.

endpointName

string

Name of the endpoint under the profile which is unique globally.

customDomainName

string

Name of the custom domain within an endpoint.

options

CustomDomainsDisableCustomHttpsOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<CustomDomain>, CustomDomain>>

beginDisableCustomHttpsAndWait(string, string, string, string, CustomDomainsDisableCustomHttpsOptionalParams)

Disable https delivery of the custom domain.

function beginDisableCustomHttpsAndWait(resourceGroupName: string, profileName: string, endpointName: string, customDomainName: string, options?: CustomDomainsDisableCustomHttpsOptionalParams): Promise<CustomDomain>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

profileName

string

Name of the CDN profile which is unique within the resource group.

endpointName

string

Name of the endpoint under the profile which is unique globally.

customDomainName

string

Name of the custom domain within an endpoint.

options

CustomDomainsDisableCustomHttpsOptionalParams

The options parameters.

Returns

Promise<CustomDomain>

beginEnableCustomHttps(string, string, string, string, CustomDomainsEnableCustomHttpsOptionalParams)

Enable https delivery of the custom domain.

function beginEnableCustomHttps(resourceGroupName: string, profileName: string, endpointName: string, customDomainName: string, options?: CustomDomainsEnableCustomHttpsOptionalParams): Promise<SimplePollerLike<OperationState<CustomDomain>, CustomDomain>>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

profileName

string

Name of the CDN profile which is unique within the resource group.

endpointName

string

Name of the endpoint under the profile which is unique globally.

customDomainName

string

Name of the custom domain within an endpoint.

options

CustomDomainsEnableCustomHttpsOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<CustomDomain>, CustomDomain>>

beginEnableCustomHttpsAndWait(string, string, string, string, CustomDomainsEnableCustomHttpsOptionalParams)

Enable https delivery of the custom domain.

function beginEnableCustomHttpsAndWait(resourceGroupName: string, profileName: string, endpointName: string, customDomainName: string, options?: CustomDomainsEnableCustomHttpsOptionalParams): Promise<CustomDomain>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

profileName

string

Name of the CDN profile which is unique within the resource group.

endpointName

string

Name of the endpoint under the profile which is unique globally.

customDomainName

string

Name of the custom domain within an endpoint.

options

CustomDomainsEnableCustomHttpsOptionalParams

The options parameters.

Returns

Promise<CustomDomain>

get(string, string, string, string, CustomDomainsGetOptionalParams)

Gets an existing custom domain within an endpoint.

function get(resourceGroupName: string, profileName: string, endpointName: string, customDomainName: string, options?: CustomDomainsGetOptionalParams): Promise<CustomDomain>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

profileName

string

Name of the CDN profile which is unique within the resource group.

endpointName

string

Name of the endpoint under the profile which is unique globally.

customDomainName

string

Name of the custom domain within an endpoint.

options

CustomDomainsGetOptionalParams

The options parameters.

Returns

Promise<CustomDomain>

listByEndpoint(string, string, string, CustomDomainsListByEndpointOptionalParams)

Lists all of the existing custom domains within an endpoint.

function listByEndpoint(resourceGroupName: string, profileName: string, endpointName: string, options?: CustomDomainsListByEndpointOptionalParams): PagedAsyncIterableIterator<CustomDomain, CustomDomain[], PageSettings>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

profileName

string

Name of the CDN profile which is unique within the resource group.

endpointName

string

Name of the endpoint under the profile which is unique globally.

options

CustomDomainsListByEndpointOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<CustomDomain, CustomDomain[], PageSettings>