DomainsOperations interface

Package:

@azure/arm-eventgrid

Interface representing a Domains operations.

Properties

beginCreateOrUpdate
beginCreateOrUpdateAndWait
beginDelete
beginDeleteAndWait
beginUpdate
beginUpdateAndWait
createOrUpdate	Asynchronously creates or updates a new domain with the specified parameters.
delete
get	Get properties of a domain.
listByResourceGroup	List all the domains under a resource group.
listBySubscription	List all the domains under an Azure subscription.
listSharedAccessKeys	List the two keys used to publish to a domain.
regenerateKey	Regenerate a shared access key for a domain.
update	Asynchronously updates a domain with the specified parameters.

Property Details

beginCreateOrUpdate

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdate: (resourceGroupName: string, domainName: string, domainInfo: Domain, options?: DomainsCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<Domain>, Domain>>

Property Value

(resourceGroupName: string, domainName: string, domainInfo: Domain, options?: DomainsCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<Domain>, Domain>>

beginCreateOrUpdateAndWait

Warning

This API is now deprecated.

use createOrUpdate instead

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

Property Value

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

beginDelete

Warning

This API is now deprecated.

use delete instead

beginDelete: (resourceGroupName: string, domainName: string, options?: DomainsDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, domainName: string, options?: DomainsDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

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

Property Value

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

beginUpdate

Warning

This API is now deprecated.

use update instead

beginUpdate: (resourceGroupName: string, domainName: string, domainUpdateParameters: DomainUpdateParameters, options?: DomainsUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<Domain>, Domain>>

Property Value

(resourceGroupName: string, domainName: string, domainUpdateParameters: DomainUpdateParameters, options?: DomainsUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<Domain>, Domain>>

beginUpdateAndWait

Warning

This API is now deprecated.

use update instead

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

Property Value

(resourceGroupName: string, domainName: string, domainUpdateParameters: DomainUpdateParameters, options?: DomainsUpdateOptionalParams) => Promise<Domain>

createOrUpdate

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

createOrUpdate: (resourceGroupName: string, domainName: string, domainInfo: Domain, options?: DomainsCreateOrUpdateOptionalParams) => PollerLike<OperationState<Domain>, Domain>

Property Value

(resourceGroupName: string, domainName: string, domainInfo: Domain, options?: DomainsCreateOrUpdateOptionalParams) => PollerLike<OperationState<Domain>, Domain>

delete

delete: (resourceGroupName: string, domainName: string, options?: DomainsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, domainName: string, options?: DomainsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

get

Get properties of a domain.

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

Property Value

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

listByResourceGroup

List all the domains under a resource group.

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

Property Value

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

listBySubscription

List all the domains under an Azure subscription.

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

Property Value

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

listSharedAccessKeys

List the two keys used to publish to a domain.

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

Property Value

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

regenerateKey

Regenerate a shared access key for a domain.

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

Property Value

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

update

Asynchronously updates a domain with the specified parameters.

update: (resourceGroupName: string, domainName: string, domainUpdateParameters: DomainUpdateParameters, options?: DomainsUpdateOptionalParams) => PollerLike<OperationState<Domain>, Domain>

Property Value

(resourceGroupName: string, domainName: string, domainUpdateParameters: DomainUpdateParameters, options?: DomainsUpdateOptionalParams) => PollerLike<OperationState<Domain>, Domain>