Package version:

Interface WebPubSubCustomDomains

Interface representing a WebPubSubCustomDomains.

Hierarchy

WebPubSubCustomDomains

Index

Methods

beginCreateOrUpdate beginCreateOrUpdateAndWait beginDelete beginDeleteAndWait get list

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, resourceName: string, name: string, parameters: CustomDomain, options?: WebPubSubCustomDomainsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<CustomDomain>, CustomDomain>>
Create or update a custom domain.
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
- Optional options: WebPubSubCustomDomainsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<CustomDomain>, CustomDomain>>
- Defined in operationsInterfaces/webPubSubCustomDomains.ts:59

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName: string, resourceName: string, name: string, parameters: CustomDomain, options?: WebPubSubCustomDomainsCreateOrUpdateOptionalParams): Promise<CustomDomain>
Create or update a custom domain.
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
- Optional options: WebPubSubCustomDomainsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<CustomDomain>
- Defined in operationsInterfaces/webPubSubCustomDomains.ts:80

beginDelete

beginDelete(resourceGroupName: string, resourceName: string, name: string, options?: WebPubSubCustomDomainsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>
Delete a custom domain.
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.
- Optional options: WebPubSubCustomDomainsDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>
- Defined in operationsInterfaces/webPubSubCustomDomains.ts:95

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName: string, resourceName: string, name: string, options?: WebPubSubCustomDomainsDeleteOptionalParams): Promise<void>
Delete a custom domain.
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.
- Optional options: WebPubSubCustomDomainsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/webPubSubCustomDomains.ts:109

get

get(resourceGroupName: string, resourceName: string, name: string, options?: WebPubSubCustomDomainsGetOptionalParams): Promise<CustomDomain>
Get a custom domain.
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.
- Optional options: WebPubSubCustomDomainsGetOptionalParams
  
  The options parameters.
Returns Promise<CustomDomain>
- Defined in operationsInterfaces/webPubSubCustomDomains.ts:44

list

list(resourceGroupName: string, resourceName: string, options?: WebPubSubCustomDomainsListOptionalParams): PagedAsyncIterableIterator<CustomDomain>
List all custom domains.
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.
- Optional options: WebPubSubCustomDomainsListOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<CustomDomain>
- Defined in operationsInterfaces/webPubSubCustomDomains.ts:31

Interface WebPubSubCustomDomains

Hierarchy

Index

Methods

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

resourceName: string

name: string

parameters: CustomDomain

Optional options: WebPubSubCustomDomainsCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<CustomDomain>, CustomDomain>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

resourceName: string

name: string

parameters: CustomDomain

Optional options: WebPubSubCustomDomainsCreateOrUpdateOptionalParams

Returns Promise<CustomDomain>

beginDelete

Parameters

resourceGroupName: string

resourceName: string

name: string

Optional options: WebPubSubCustomDomainsDeleteOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

Parameters

resourceGroupName: string

resourceName: string

name: string

Optional options: WebPubSubCustomDomainsDeleteOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

resourceName: string

name: string

Optional options: WebPubSubCustomDomainsGetOptionalParams

Returns Promise<CustomDomain>

list

Parameters

resourceGroupName: string

resourceName: string

Optional options: WebPubSubCustomDomainsListOptionalParams

Returns PagedAsyncIterableIterator<CustomDomain>

Settings

Member Visibility

Theme

`Optional` options: WebPubSubCustomDomainsCreateOrUpdateOptionalParams

`Optional` options: WebPubSubCustomDomainsCreateOrUpdateOptionalParams

`Optional` options: WebPubSubCustomDomainsDeleteOptionalParams

`Optional` options: WebPubSubCustomDomainsDeleteOptionalParams

`Optional` options: WebPubSubCustomDomainsGetOptionalParams

`Optional` options: WebPubSubCustomDomainsListOptionalParams