WebPubSubCustomDomains interface

Package:

@azure/arm-webpubsub

Interface representing a WebPubSubCustomDomains.

Methods

beginCreateOrUpdate(string, string, string, CustomDomain, WebPubSubCustomDomainsCreateOrUpdateOptionalParams)	Create or update a custom domain.
beginCreateOrUpdateAndWait(string, string, string, CustomDomain, WebPubSubCustomDomainsCreateOrUpdateOptionalParams)	Create or update a custom domain.
beginDelete(string, string, string, WebPubSubCustomDomainsDeleteOptionalParams)	Delete a custom domain.
beginDeleteAndWait(string, string, string, WebPubSubCustomDomainsDeleteOptionalParams)	Delete a custom domain.
get(string, string, string, WebPubSubCustomDomainsGetOptionalParams)	Get a custom domain.
list(string, string, WebPubSubCustomDomainsListOptionalParams)	List all custom domains.

Method Details

beginCreateOrUpdate(string, string, string, CustomDomain, WebPubSubCustomDomainsCreateOrUpdateOptionalParams)

Create or update a custom domain.

function beginCreateOrUpdate(resourceGroupName: string, resourceName: string, name: string, parameters: CustomDomain, options?: WebPubSubCustomDomainsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<CustomDomain>, CustomDomain>>

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.

resourceName

string

The name of the resource.

name

string

Custom domain name.

parameters

CustomDomain

A custom domain

options

WebPubSubCustomDomainsCreateOrUpdateOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateAndWait(string, string, string, CustomDomain, WebPubSubCustomDomainsCreateOrUpdateOptionalParams)

Create or update a custom domain.

function beginCreateOrUpdateAndWait(resourceGroupName: string, resourceName: string, name: string, parameters: CustomDomain, options?: WebPubSubCustomDomainsCreateOrUpdateOptionalParams): Promise<CustomDomain>

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.

resourceName

string

The name of the resource.

name

string

Custom domain name.

parameters

CustomDomain

A custom domain

options

WebPubSubCustomDomainsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<CustomDomain>

beginDelete(string, string, string, WebPubSubCustomDomainsDeleteOptionalParams)

Delete a custom domain.

function beginDelete(resourceGroupName: string, resourceName: string, name: string, options?: WebPubSubCustomDomainsDeleteOptionalParams): 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.

resourceName

string

The name of the resource.

name

string

Custom domain name.

options

WebPubSubCustomDomainsDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, string, WebPubSubCustomDomainsDeleteOptionalParams)

Delete a custom domain.

function beginDeleteAndWait(resourceGroupName: string, resourceName: string, name: string, options?: WebPubSubCustomDomainsDeleteOptionalParams): 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.

resourceName

string

The name of the resource.

name

string

Custom domain name.

options

WebPubSubCustomDomainsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, WebPubSubCustomDomainsGetOptionalParams)

Get a custom domain.

function get(resourceGroupName: string, resourceName: string, name: string, options?: WebPubSubCustomDomainsGetOptionalParams): Promise<CustomDomain>

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.

resourceName

string

The name of the resource.

name

string

Custom domain name.

options

WebPubSubCustomDomainsGetOptionalParams

The options parameters.

Returns

Promise<CustomDomain>

list(string, string, WebPubSubCustomDomainsListOptionalParams)

List all custom domains.

function list(resourceGroupName: string, resourceName: string, options?: WebPubSubCustomDomainsListOptionalParams): PagedAsyncIterableIterator<CustomDomain, CustomDomain[], 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.

resourceName

string

The name of the resource.

options

WebPubSubCustomDomainsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<CustomDomain, CustomDomain[], PageSettings>