Share via

CustomDomains interface

  • Reference
Package:
@azure/arm-appplatform

Interface representing a CustomDomains.

Methods

beginCreateOrUpdate(string, string, string, string, CustomDomainResource, CustomDomainsCreateOrUpdateOptionalParams)

Create or update custom domain of one lifecycle application.
beginCreateOrUpdateAndWait(string, string, string, string, CustomDomainResource, CustomDomainsCreateOrUpdateOptionalParams)

Create or update custom domain of one lifecycle application.
beginDelete(string, string, string, string, CustomDomainsDeleteOptionalParams)

Delete the custom domain of one lifecycle application.
beginDeleteAndWait(string, string, string, string, CustomDomainsDeleteOptionalParams)

Delete the custom domain of one lifecycle application.
beginUpdate(string, string, string, string, CustomDomainResource, CustomDomainsUpdateOptionalParams)

Update custom domain of one lifecycle application.
beginUpdateAndWait(string, string, string, string, CustomDomainResource, CustomDomainsUpdateOptionalParams)

Update custom domain of one lifecycle application.
get(string, string, string, string, CustomDomainsGetOptionalParams)

Get the custom domain of one lifecycle application.
list(string, string, string, CustomDomainsListOptionalParams)

List the custom domains of one lifecycle application.

Method Details

beginCreateOrUpdate(string, string, string, string, CustomDomainResource, CustomDomainsCreateOrUpdateOptionalParams)

Create or update custom domain of one lifecycle application.

function beginCreateOrUpdate(resourceGroupName: string, serviceName: string, appName: string, domainName: string, domainResource: CustomDomainResource, options?: CustomDomainsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<CustomDomainResource>, CustomDomainResource>>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serviceName

string

The name of the Service resource.

appName

string

The name of the App resource.

domainName

string

The name of the custom domain resource.

domainResource
CustomDomainResource

Parameters for the create or update operation

options
CustomDomainsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<CustomDomainResource>, CustomDomainResource>>

beginCreateOrUpdateAndWait(string, string, string, string, CustomDomainResource, CustomDomainsCreateOrUpdateOptionalParams)

Create or update custom domain of one lifecycle application.

function beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, appName: string, domainName: string, domainResource: CustomDomainResource, options?: CustomDomainsCreateOrUpdateOptionalParams): Promise<CustomDomainResource>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serviceName

string

The name of the Service resource.

appName

string

The name of the App resource.

domainName

string

The name of the custom domain resource.

domainResource
CustomDomainResource

Parameters for the create or update operation

options
CustomDomainsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<CustomDomainResource>

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

Delete the custom domain of one lifecycle application.

function beginDelete(resourceGroupName: string, serviceName: string, appName: string, domainName: string, options?: CustomDomainsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serviceName

string

The name of the Service resource.

appName

string

The name of the App resource.

domainName

string

The name of the custom domain resource.

options
CustomDomainsDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

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

Delete the custom domain of one lifecycle application.

function beginDeleteAndWait(resourceGroupName: string, serviceName: string, appName: string, domainName: string, options?: CustomDomainsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serviceName

string

The name of the Service resource.

appName

string

The name of the App resource.

domainName

string

The name of the custom domain resource.

options
CustomDomainsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, string, string, CustomDomainResource, CustomDomainsUpdateOptionalParams)

Update custom domain of one lifecycle application.

function beginUpdate(resourceGroupName: string, serviceName: string, appName: string, domainName: string, domainResource: CustomDomainResource, options?: CustomDomainsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<CustomDomainResource>, CustomDomainResource>>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serviceName

string

The name of the Service resource.

appName

string

The name of the App resource.

domainName

string

The name of the custom domain resource.

domainResource
CustomDomainResource

Parameters for the create or update operation

options
CustomDomainsUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<CustomDomainResource>, CustomDomainResource>>

beginUpdateAndWait(string, string, string, string, CustomDomainResource, CustomDomainsUpdateOptionalParams)

Update custom domain of one lifecycle application.

function beginUpdateAndWait(resourceGroupName: string, serviceName: string, appName: string, domainName: string, domainResource: CustomDomainResource, options?: CustomDomainsUpdateOptionalParams): Promise<CustomDomainResource>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serviceName

string

The name of the Service resource.

appName

string

The name of the App resource.

domainName

string

The name of the custom domain resource.

domainResource
CustomDomainResource

Parameters for the create or update operation

options
CustomDomainsUpdateOptionalParams

The options parameters.

Returns

Promise<CustomDomainResource>

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

Get the custom domain of one lifecycle application.

function get(resourceGroupName: string, serviceName: string, appName: string, domainName: string, options?: CustomDomainsGetOptionalParams): Promise<CustomDomainResource>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serviceName

string

The name of the Service resource.

appName

string

The name of the App resource.

domainName

string

The name of the custom domain resource.

options
CustomDomainsGetOptionalParams

The options parameters.

Returns

Promise<CustomDomainResource>

list(string, string, string, CustomDomainsListOptionalParams)

List the custom domains of one lifecycle application.

function list(resourceGroupName: string, serviceName: string, appName: string, options?: CustomDomainsListOptionalParams): PagedAsyncIterableIterator<CustomDomainResource, CustomDomainResource[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serviceName

string

The name of the Service resource.

appName

string

The name of the App resource.

options
CustomDomainsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<CustomDomainResource, CustomDomainResource[], PageSettings>