WebPubSubCustomDomains interface
Interface representing a WebPubSubCustomDomains.
Methods
| begin |
Create or update a custom domain. |
| begin |
Create or update a custom domain. |
| begin |
Delete a custom domain. |
| begin |
Delete a custom domain. |
| get(string, string, string, Web |
Get a custom domain. |
| list(string, string, Web |
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. The name is case insensitive.
- resourceName
-
string
The name of the resource.
- name
-
string
Custom domain name.
- parameters
- CustomDomain
A custom domain
The options parameters.
Returns
Promise<@azure/core-lro.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. The name is case insensitive.
- resourceName
-
string
The name of the resource.
- name
-
string
Custom domain name.
- parameters
- CustomDomain
A custom domain
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. The name is case insensitive.
- resourceName
-
string
The name of the resource.
- name
-
string
Custom domain name.
The options parameters.
Returns
Promise<@azure/core-lro.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. The name is case insensitive.
- resourceName
-
string
The name of the resource.
- name
-
string
Custom domain name.
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. The name is case insensitive.
- resourceName
-
string
The name of the resource.
- name
-
string
Custom domain name.
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. The name is case insensitive.
- resourceName
-
string
The name of the resource.
The options parameters.