Domains interface

Package:

@azure/arm-eventgrid

Interface representing a Domains.

Methods

beginCreateOrUpdate(string, string, Domain, DomainsCreateOrUpdateOptionalParams)	Asynchronously creates or updates a new domain with the specified parameters.
beginCreateOrUpdateAndWait(string, string, Domain, DomainsCreateOrUpdateOptionalParams)	Asynchronously creates or updates a new domain with the specified parameters.
beginDelete(string, string, DomainsDeleteOptionalParams)	Delete existing domain.
beginDeleteAndWait(string, string, DomainsDeleteOptionalParams)	Delete existing domain.
beginUpdate(string, string, DomainUpdateParameters, DomainsUpdateOptionalParams)	Asynchronously updates a domain with the specified parameters.
beginUpdateAndWait(string, string, DomainUpdateParameters, DomainsUpdateOptionalParams)	Asynchronously updates a domain with the specified parameters.
get(string, string, DomainsGetOptionalParams)	Get properties of a domain.
listByResourceGroup(string, DomainsListByResourceGroupOptionalParams)	List all the domains under a resource group.
listBySubscription(DomainsListBySubscriptionOptionalParams)	List all the domains under an Azure subscription.
listSharedAccessKeys(string, string, DomainsListSharedAccessKeysOptionalParams)	List the two keys used to publish to a domain.
regenerateKey(string, string, DomainRegenerateKeyRequest, DomainsRegenerateKeyOptionalParams)	Regenerate a shared access key for a domain.

Method Details

beginCreateOrUpdate(string, string, Domain, DomainsCreateOrUpdateOptionalParams)

Asynchronously creates or updates a new domain with the specified parameters.

function beginCreateOrUpdate(resourceGroupName: string, domainName: string, domainInfo: Domain, options?: DomainsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<Domain>, Domain>>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription.

domainName

string

Name of the domain.

domainInfo

Domain

Domain information.

options

DomainsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<Domain>, Domain>>

beginCreateOrUpdateAndWait(string, string, Domain, DomainsCreateOrUpdateOptionalParams)

Asynchronously creates or updates a new domain with the specified parameters.

function beginCreateOrUpdateAndWait(resourceGroupName: string, domainName: string, domainInfo: Domain, options?: DomainsCreateOrUpdateOptionalParams): Promise<Domain>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription.

domainName

string

Name of the domain.

domainInfo

Domain

Domain information.

options

DomainsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<Domain>

beginDelete(string, string, DomainsDeleteOptionalParams)

Delete existing domain.

function beginDelete(resourceGroupName: string, domainName: string, options?: DomainsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription.

domainName

string

Name of the domain.

options

DomainsDeleteOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginDeleteAndWait(string, string, DomainsDeleteOptionalParams)

Delete existing domain.

function beginDeleteAndWait(resourceGroupName: string, domainName: string, options?: DomainsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription.

domainName

string

Name of the domain.

options

DomainsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, DomainUpdateParameters, DomainsUpdateOptionalParams)

Asynchronously updates a domain with the specified parameters.

function beginUpdate(resourceGroupName: string, domainName: string, domainUpdateParameters: DomainUpdateParameters, options?: DomainsUpdateOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription.

domainName

string

Name of the domain.

domainUpdateParameters

DomainUpdateParameters

Domain update information.

options

DomainsUpdateOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginUpdateAndWait(string, string, DomainUpdateParameters, DomainsUpdateOptionalParams)

Asynchronously updates a domain with the specified parameters.

function beginUpdateAndWait(resourceGroupName: string, domainName: string, domainUpdateParameters: DomainUpdateParameters, options?: DomainsUpdateOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription.

domainName

string

Name of the domain.

domainUpdateParameters

DomainUpdateParameters

Domain update information.

options

DomainsUpdateOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, DomainsGetOptionalParams)

Get properties of a domain.

function get(resourceGroupName: string, domainName: string, options?: DomainsGetOptionalParams): Promise<Domain>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription.

domainName

string

Name of the domain.

options

DomainsGetOptionalParams

The options parameters.

Returns

Promise<Domain>

listByResourceGroup(string, DomainsListByResourceGroupOptionalParams)

List all the domains under a resource group.

function listByResourceGroup(resourceGroupName: string, options?: DomainsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Domain, Domain[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription.

options

DomainsListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Domain, Domain[], PageSettings>

listBySubscription(DomainsListBySubscriptionOptionalParams)

List all the domains under an Azure subscription.

function listBySubscription(options?: DomainsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<Domain, Domain[], PageSettings>

Parameters

options

DomainsListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Domain, Domain[], PageSettings>

listSharedAccessKeys(string, string, DomainsListSharedAccessKeysOptionalParams)

List the two keys used to publish to a domain.

function listSharedAccessKeys(resourceGroupName: string, domainName: string, options?: DomainsListSharedAccessKeysOptionalParams): Promise<DomainSharedAccessKeys>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription.

domainName

string

Name of the domain.

options

DomainsListSharedAccessKeysOptionalParams

The options parameters.

Returns

Promise<DomainSharedAccessKeys>

regenerateKey(string, string, DomainRegenerateKeyRequest, DomainsRegenerateKeyOptionalParams)

Regenerate a shared access key for a domain.

function regenerateKey(resourceGroupName: string, domainName: string, regenerateKeyRequest: DomainRegenerateKeyRequest, options?: DomainsRegenerateKeyOptionalParams): Promise<DomainSharedAccessKeys>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription.

domainName

string

Name of the domain.

regenerateKeyRequest

DomainRegenerateKeyRequest

Request body to regenerate key.

options

DomainsRegenerateKeyOptionalParams

The options parameters.

Returns

Promise<DomainSharedAccessKeys>