Namespaces interface

Package:

@azure/arm-eventgrid

Interface representing a Namespaces.

Methods

beginCreateOrUpdate(string, string, Namespace, NamespacesCreateOrUpdateOptionalParams)	Asynchronously creates or updates a new namespace with the specified parameters.
beginCreateOrUpdateAndWait(string, string, Namespace, NamespacesCreateOrUpdateOptionalParams)	Asynchronously creates or updates a new namespace with the specified parameters.
beginDelete(string, string, NamespacesDeleteOptionalParams)	Delete existing namespace.
beginDeleteAndWait(string, string, NamespacesDeleteOptionalParams)	Delete existing namespace.
beginRegenerateKey(string, string, NamespaceRegenerateKeyRequest, NamespacesRegenerateKeyOptionalParams)	Regenerate a shared access key for a namespace.
beginRegenerateKeyAndWait(string, string, NamespaceRegenerateKeyRequest, NamespacesRegenerateKeyOptionalParams)	Regenerate a shared access key for a namespace.
beginUpdate(string, string, NamespaceUpdateParameters, NamespacesUpdateOptionalParams)	Asynchronously updates a namespace with the specified parameters.
beginUpdateAndWait(string, string, NamespaceUpdateParameters, NamespacesUpdateOptionalParams)	Asynchronously updates a namespace with the specified parameters.
beginValidateCustomDomainOwnership(string, string, NamespacesValidateCustomDomainOwnershipOptionalParams)	Performs ownership validation via checking TXT records for all custom domains in a namespace.
beginValidateCustomDomainOwnershipAndWait(string, string, NamespacesValidateCustomDomainOwnershipOptionalParams)	Performs ownership validation via checking TXT records for all custom domains in a namespace.
get(string, string, NamespacesGetOptionalParams)	Get properties of a namespace.
listByResourceGroup(string, NamespacesListByResourceGroupOptionalParams)	List all the namespaces under a resource group.
listBySubscription(NamespacesListBySubscriptionOptionalParams)	List all the namespaces under an Azure subscription.
listSharedAccessKeys(string, string, NamespacesListSharedAccessKeysOptionalParams)	List the two keys used to publish to a namespace.

Method Details

beginCreateOrUpdate(string, string, Namespace, NamespacesCreateOrUpdateOptionalParams)

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

function beginCreateOrUpdate(resourceGroupName: string, namespaceName: string, namespaceInfo: Namespace, options?: NamespacesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Namespace>, Namespace>>

Parameters

resourceGroupName

string

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

namespaceName

string

Name of the namespace.

namespaceInfo

Namespace

Namespace information.

options

NamespacesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<Namespace>, Namespace>>

beginCreateOrUpdateAndWait(string, string, Namespace, NamespacesCreateOrUpdateOptionalParams)

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

function beginCreateOrUpdateAndWait(resourceGroupName: string, namespaceName: string, namespaceInfo: Namespace, options?: NamespacesCreateOrUpdateOptionalParams): Promise<Namespace>

Parameters

resourceGroupName

string

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

namespaceName

string

Name of the namespace.

namespaceInfo

Namespace

Namespace information.

options

NamespacesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<Namespace>

beginDelete(string, string, NamespacesDeleteOptionalParams)

Delete existing namespace.

function beginDelete(resourceGroupName: string, namespaceName: string, options?: NamespacesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

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

namespaceName

string

Name of the namespace.

options

NamespacesDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, NamespacesDeleteOptionalParams)

Delete existing namespace.

function beginDeleteAndWait(resourceGroupName: string, namespaceName: string, options?: NamespacesDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

namespaceName

string

Name of the namespace.

options

NamespacesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginRegenerateKey(string, string, NamespaceRegenerateKeyRequest, NamespacesRegenerateKeyOptionalParams)

Regenerate a shared access key for a namespace.

function beginRegenerateKey(resourceGroupName: string, namespaceName: string, regenerateKeyRequest: NamespaceRegenerateKeyRequest, options?: NamespacesRegenerateKeyOptionalParams): Promise<SimplePollerLike<OperationState<NamespaceSharedAccessKeys>, NamespaceSharedAccessKeys>>

Parameters

resourceGroupName

string

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

namespaceName

string

Name of the Namespace.

regenerateKeyRequest

NamespaceRegenerateKeyRequest

Request body to regenerate key.

options

NamespacesRegenerateKeyOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<NamespaceSharedAccessKeys>, NamespaceSharedAccessKeys>>

beginRegenerateKeyAndWait(string, string, NamespaceRegenerateKeyRequest, NamespacesRegenerateKeyOptionalParams)

Regenerate a shared access key for a namespace.

function beginRegenerateKeyAndWait(resourceGroupName: string, namespaceName: string, regenerateKeyRequest: NamespaceRegenerateKeyRequest, options?: NamespacesRegenerateKeyOptionalParams): Promise<NamespaceSharedAccessKeys>

Parameters

resourceGroupName

string

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

namespaceName

string

Name of the Namespace.

regenerateKeyRequest

NamespaceRegenerateKeyRequest

Request body to regenerate key.

options

NamespacesRegenerateKeyOptionalParams

The options parameters.

Returns

Promise<NamespaceSharedAccessKeys>

beginUpdate(string, string, NamespaceUpdateParameters, NamespacesUpdateOptionalParams)

Asynchronously updates a namespace with the specified parameters.

function beginUpdate(resourceGroupName: string, namespaceName: string, namespaceUpdateParameters: NamespaceUpdateParameters, options?: NamespacesUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Namespace>, Namespace>>

Parameters

resourceGroupName

string

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

namespaceName

string

Name of the namespace.

namespaceUpdateParameters

NamespaceUpdateParameters

Namespace update information.

options

NamespacesUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<Namespace>, Namespace>>

beginUpdateAndWait(string, string, NamespaceUpdateParameters, NamespacesUpdateOptionalParams)

Asynchronously updates a namespace with the specified parameters.

function beginUpdateAndWait(resourceGroupName: string, namespaceName: string, namespaceUpdateParameters: NamespaceUpdateParameters, options?: NamespacesUpdateOptionalParams): Promise<Namespace>

Parameters

resourceGroupName

string

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

namespaceName

string

Name of the namespace.

namespaceUpdateParameters

NamespaceUpdateParameters

Namespace update information.

options

NamespacesUpdateOptionalParams

The options parameters.

Returns

Promise<Namespace>

beginValidateCustomDomainOwnership(string, string, NamespacesValidateCustomDomainOwnershipOptionalParams)

Performs ownership validation via checking TXT records for all custom domains in a namespace.

function beginValidateCustomDomainOwnership(resourceGroupName: string, namespaceName: string, options?: NamespacesValidateCustomDomainOwnershipOptionalParams): Promise<SimplePollerLike<OperationState<CustomDomainOwnershipValidationResult>, CustomDomainOwnershipValidationResult>>

Parameters

resourceGroupName

string

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

namespaceName

string

Name of the Namespace.

options

NamespacesValidateCustomDomainOwnershipOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<CustomDomainOwnershipValidationResult>, CustomDomainOwnershipValidationResult>>

beginValidateCustomDomainOwnershipAndWait(string, string, NamespacesValidateCustomDomainOwnershipOptionalParams)

Performs ownership validation via checking TXT records for all custom domains in a namespace.

function beginValidateCustomDomainOwnershipAndWait(resourceGroupName: string, namespaceName: string, options?: NamespacesValidateCustomDomainOwnershipOptionalParams): Promise<CustomDomainOwnershipValidationResult>

Parameters

resourceGroupName

string

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

namespaceName

string

Name of the Namespace.

options

NamespacesValidateCustomDomainOwnershipOptionalParams

The options parameters.

Returns

Promise<CustomDomainOwnershipValidationResult>

get(string, string, NamespacesGetOptionalParams)

Get properties of a namespace.

function get(resourceGroupName: string, namespaceName: string, options?: NamespacesGetOptionalParams): Promise<Namespace>

Parameters

resourceGroupName

string

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

namespaceName

string

Name of the namespace.

options

NamespacesGetOptionalParams

The options parameters.

Returns

Promise<Namespace>

listByResourceGroup(string, NamespacesListByResourceGroupOptionalParams)

List all the namespaces under a resource group.

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

Parameters

resourceGroupName

string

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

options

NamespacesListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Namespace, Namespace[], PageSettings>

listBySubscription(NamespacesListBySubscriptionOptionalParams)

List all the namespaces under an Azure subscription.

function listBySubscription(options?: NamespacesListBySubscriptionOptionalParams): PagedAsyncIterableIterator<Namespace, Namespace[], PageSettings>

Parameters

options

NamespacesListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Namespace, Namespace[], PageSettings>

listSharedAccessKeys(string, string, NamespacesListSharedAccessKeysOptionalParams)

List the two keys used to publish to a namespace.

function listSharedAccessKeys(resourceGroupName: string, namespaceName: string, options?: NamespacesListSharedAccessKeysOptionalParams): Promise<NamespaceSharedAccessKeys>

Parameters

resourceGroupName

string

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

namespaceName

string

Name of the namespace.

options

NamespacesListSharedAccessKeysOptionalParams

The options parameters.

Returns

Promise<NamespaceSharedAccessKeys>