Domains | @azure/arm-eventgrid

Interface representing a Domains.

Hierarchy

Domains

Implemented by

DomainsImpl

Index

Methods

beginCreateOrUpdate

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

- Defined in operationsInterfaces/domains.ts:66
Asynchronously creates or updates a new domain with the specified parameters.

Parameters
- resourceGroupName: string
  
  The name of the resource group within the user's subscription.
- domainName: string
  
  Name of the domain.
- domainInfo: Domain
  
  Domain information.
- Optional options: DomainsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<DomainsCreateOrUpdateResponse>, DomainsCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

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

- Defined in operationsInterfaces/domains.ts:84
Asynchronously creates or updates a new domain with the specified parameters.

Parameters
- resourceGroupName: string
  
  The name of the resource group within the user's subscription.
- domainName: string
  
  Name of the domain.
- domainInfo: Domain
  
  Domain information.
- Optional options: DomainsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<DomainsCreateOrUpdateResponse>

beginDelete

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

- Defined in operationsInterfaces/domains.ts:96
Delete existing domain.

Parameters
- resourceGroupName: string
  
  The name of the resource group within the user's subscription.
- domainName: string
  
  Name of the domain.
- Optional options: DomainsDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

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

- Defined in operationsInterfaces/domains.ts:107
Delete existing domain.

Parameters
- resourceGroupName: string
  
  The name of the resource group within the user's subscription.
- domainName: string
  
  Name of the domain.
- Optional options: DomainsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

beginUpdate

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

- Defined in operationsInterfaces/domains.ts:119
Asynchronously updates a domain with the specified parameters.

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.
- Optional options: DomainsUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginUpdateAndWait

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

- Defined in operationsInterfaces/domains.ts:132
Asynchronously updates a domain with the specified parameters.

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.
- Optional options: DomainsUpdateOptionalParams
  
  The options parameters.
Returns Promise<void>

get

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

- Defined in operationsInterfaces/domains.ts:54
Get properties of a domain.

Parameters
- resourceGroupName: string
  
  The name of the resource group within the user's subscription.
- domainName: string
  
  Name of the domain.
- Optional options: DomainsGetOptionalParams
  
  The options parameters.
Returns Promise<DomainsGetResponse>

listByResourceGroup

listByResourceGroup(resourceGroupName: string, options?: DomainsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Domain>

- Defined in operationsInterfaces/domains.ts:44
List all the domains under a resource group.

Parameters
- resourceGroupName: string
  
  The name of the resource group within the user's subscription.
- Optional options: DomainsListByResourceGroupOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Domain>

listBySubscription

listBySubscription(options?: DomainsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<Domain>

- Defined in operationsInterfaces/domains.ts:36
List all the domains under an Azure subscription.

Parameters
- Optional options: DomainsListBySubscriptionOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Domain>

listSharedAccessKeys

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

- Defined in operationsInterfaces/domains.ts:144
List the two keys used to publish to a domain.

Parameters
- resourceGroupName: string
  
  The name of the resource group within the user's subscription.
- domainName: string
  
  Name of the domain.
- Optional options: DomainsListSharedAccessKeysOptionalParams
  
  The options parameters.
Returns Promise<DomainsListSharedAccessKeysResponse>

regenerateKey

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

- Defined in operationsInterfaces/domains.ts:156
Regenerate a shared access key for a domain.

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.
- Optional options: DomainsRegenerateKeyOptionalParams
  
  The options parameters.
Returns Promise<DomainsRegenerateKeyResponse>

Hierarchy

Implemented by

Index

Methods

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

domainName: string

domainInfo: Domain

Optional options: DomainsCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<DomainsCreateOrUpdateResponse>, DomainsCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

domainName: string

domainInfo: Domain

Optional options: DomainsCreateOrUpdateOptionalParams

Returns Promise<DomainsCreateOrUpdateResponse>

beginDelete

Parameters

resourceGroupName: string

domainName: string

Optional options: DomainsDeleteOptionalParams

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

beginDeleteAndWait

Parameters

resourceGroupName: string

domainName: string

Optional options: DomainsDeleteOptionalParams

Returns Promise<void>

beginUpdate

Parameters

resourceGroupName: string

domainName: string

domainUpdateParameters: DomainUpdateParameters

Optional options: DomainsUpdateOptionalParams

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

beginUpdateAndWait

Parameters

resourceGroupName: string

domainName: string

domainUpdateParameters: DomainUpdateParameters

Optional options: DomainsUpdateOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

domainName: string

Optional options: DomainsGetOptionalParams

Returns Promise<DomainsGetResponse>

listByResourceGroup

Parameters

resourceGroupName: string

Optional options: DomainsListByResourceGroupOptionalParams

Returns PagedAsyncIterableIterator<Domain>

listBySubscription

Parameters

Optional options: DomainsListBySubscriptionOptionalParams

Returns PagedAsyncIterableIterator<Domain>

listSharedAccessKeys

Parameters

resourceGroupName: string

domainName: string

Optional options: DomainsListSharedAccessKeysOptionalParams

Returns Promise<DomainsListSharedAccessKeysResponse>

regenerateKey

Parameters

resourceGroupName: string

domainName: string

regenerateKeyRequest: DomainRegenerateKeyRequest

Optional options: DomainsRegenerateKeyOptionalParams

Returns Promise<DomainsRegenerateKeyResponse>