Namespaces interface

Package:

@azure/arm-notificationhubs

Interface representing a Namespaces.

Methods

beginDelete(string, string, NamespacesDeleteOptionalParams)	Deletes an existing namespace. This operation also removes all associated notificationHubs under the namespace.
beginDeleteAndWait(string, string, NamespacesDeleteOptionalParams)	Deletes an existing namespace. This operation also removes all associated notificationHubs under the namespace.
checkAvailability(CheckAvailabilityParameters, NamespacesCheckAvailabilityOptionalParams)	Checks the availability of the given service namespace across all Azure subscriptions. This is useful because the domain name is created based on the service namespace name.
createOrUpdate(string, string, NamespaceCreateOrUpdateParameters, NamespacesCreateOrUpdateOptionalParams)	Creates/Updates a service namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.
createOrUpdateAuthorizationRule(string, string, string, SharedAccessAuthorizationRuleCreateOrUpdateParameters, NamespacesCreateOrUpdateAuthorizationRuleOptionalParams)	Creates an authorization rule for a namespace
deleteAuthorizationRule(string, string, string, NamespacesDeleteAuthorizationRuleOptionalParams)	Deletes a namespace authorization rule
get(string, string, NamespacesGetOptionalParams)	Returns the description for the specified namespace.
getAuthorizationRule(string, string, string, NamespacesGetAuthorizationRuleOptionalParams)	Gets an authorization rule for a namespace by name.
list(string, NamespacesListOptionalParams)	Lists the available namespaces within a resourceGroup.
listAll(NamespacesListAllOptionalParams)	Lists all the available namespaces within the subscription irrespective of the resourceGroups.
listAuthorizationRules(string, string, NamespacesListAuthorizationRulesOptionalParams)	Gets the authorization rules for a namespace.
listKeys(string, string, string, NamespacesListKeysOptionalParams)	Gets the Primary and Secondary ConnectionStrings to the namespace
patch(string, string, NamespacePatchParameters, NamespacesPatchOptionalParams)	Patches the existing namespace
regenerateKeys(string, string, string, PolicykeyResource, NamespacesRegenerateKeysOptionalParams)	Regenerates the Primary/Secondary Keys to the Namespace Authorization Rule

Method Details

beginDelete(string, string, NamespacesDeleteOptionalParams)

Deletes an existing namespace. This operation also removes all associated notificationHubs under the namespace.

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

Parameters

resourceGroupName

string

The name of the resource group.

namespaceName

string

The namespace name.

options

NamespacesDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, NamespacesDeleteOptionalParams)

Deletes an existing namespace. This operation also removes all associated notificationHubs under the namespace.

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

Parameters

resourceGroupName

string

The name of the resource group.

namespaceName

string

The namespace name.

options

NamespacesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

checkAvailability(CheckAvailabilityParameters, NamespacesCheckAvailabilityOptionalParams)

Checks the availability of the given service namespace across all Azure subscriptions. This is useful because the domain name is created based on the service namespace name.

function checkAvailability(parameters: CheckAvailabilityParameters, options?: NamespacesCheckAvailabilityOptionalParams): Promise<CheckAvailabilityResult>

Parameters

parameters

CheckAvailabilityParameters

The namespace name.

options

NamespacesCheckAvailabilityOptionalParams

The options parameters.

Returns

Promise<CheckAvailabilityResult>

createOrUpdate(string, string, NamespaceCreateOrUpdateParameters, NamespacesCreateOrUpdateOptionalParams)

Creates/Updates a service namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.

function createOrUpdate(resourceGroupName: string, namespaceName: string, parameters: NamespaceCreateOrUpdateParameters, options?: NamespacesCreateOrUpdateOptionalParams): Promise<NamespaceResource>

Parameters

resourceGroupName

string

The name of the resource group.

namespaceName

string

The namespace name.

parameters

NamespaceCreateOrUpdateParameters

Parameters supplied to create a Namespace Resource.

options

NamespacesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<NamespaceResource>

createOrUpdateAuthorizationRule(string, string, string, SharedAccessAuthorizationRuleCreateOrUpdateParameters, NamespacesCreateOrUpdateAuthorizationRuleOptionalParams)

Creates an authorization rule for a namespace

function createOrUpdateAuthorizationRule(resourceGroupName: string, namespaceName: string, authorizationRuleName: string, parameters: SharedAccessAuthorizationRuleCreateOrUpdateParameters, options?: NamespacesCreateOrUpdateAuthorizationRuleOptionalParams): Promise<SharedAccessAuthorizationRuleResource>

Parameters

resourceGroupName

string

The name of the resource group.

namespaceName

string

The namespace name.

authorizationRuleName

string

Authorization Rule Name.

parameters

SharedAccessAuthorizationRuleCreateOrUpdateParameters

The shared access authorization rule.

options

NamespacesCreateOrUpdateAuthorizationRuleOptionalParams

The options parameters.

Returns

Promise<SharedAccessAuthorizationRuleResource>

deleteAuthorizationRule(string, string, string, NamespacesDeleteAuthorizationRuleOptionalParams)

Deletes a namespace authorization rule

function deleteAuthorizationRule(resourceGroupName: string, namespaceName: string, authorizationRuleName: string, options?: NamespacesDeleteAuthorizationRuleOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

namespaceName

string

The namespace name.

authorizationRuleName

string

Authorization Rule Name.

options

NamespacesDeleteAuthorizationRuleOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, NamespacesGetOptionalParams)

Returns the description for the specified namespace.

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

Parameters

resourceGroupName

string

The name of the resource group.

namespaceName

string

The namespace name.

options

NamespacesGetOptionalParams

The options parameters.

Returns

Promise<NamespaceResource>

getAuthorizationRule(string, string, string, NamespacesGetAuthorizationRuleOptionalParams)

Gets an authorization rule for a namespace by name.

function getAuthorizationRule(resourceGroupName: string, namespaceName: string, authorizationRuleName: string, options?: NamespacesGetAuthorizationRuleOptionalParams): Promise<SharedAccessAuthorizationRuleResource>

Parameters

resourceGroupName

string

The name of the resource group.

namespaceName

string

The namespace name

authorizationRuleName

string

Authorization rule name.

options

NamespacesGetAuthorizationRuleOptionalParams

The options parameters.

Returns

Promise<SharedAccessAuthorizationRuleResource>

list(string, NamespacesListOptionalParams)

Lists the available namespaces within a resourceGroup.

function list(resourceGroupName: string, options?: NamespacesListOptionalParams): PagedAsyncIterableIterator<NamespaceResource, NamespaceResource[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. If resourceGroupName value is null the method lists all the namespaces within subscription

options

NamespacesListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<NamespaceResource, NamespaceResource[], PageSettings>

listAll(NamespacesListAllOptionalParams)

Lists all the available namespaces within the subscription irrespective of the resourceGroups.

function listAll(options?: NamespacesListAllOptionalParams): PagedAsyncIterableIterator<NamespaceResource, NamespaceResource[], PageSettings>

Parameters

options

NamespacesListAllOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<NamespaceResource, NamespaceResource[], PageSettings>

listAuthorizationRules(string, string, NamespacesListAuthorizationRulesOptionalParams)

Gets the authorization rules for a namespace.

function listAuthorizationRules(resourceGroupName: string, namespaceName: string, options?: NamespacesListAuthorizationRulesOptionalParams): PagedAsyncIterableIterator<SharedAccessAuthorizationRuleResource, SharedAccessAuthorizationRuleResource[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group.

namespaceName

string

The namespace name

options

NamespacesListAuthorizationRulesOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<SharedAccessAuthorizationRuleResource, SharedAccessAuthorizationRuleResource[], PageSettings>

listKeys(string, string, string, NamespacesListKeysOptionalParams)

Gets the Primary and Secondary ConnectionStrings to the namespace

function listKeys(resourceGroupName: string, namespaceName: string, authorizationRuleName: string, options?: NamespacesListKeysOptionalParams): Promise<ResourceListKeys>

Parameters

resourceGroupName

string

The name of the resource group.

namespaceName

string

The namespace name.

authorizationRuleName

string

The connection string of the namespace for the specified authorizationRule.

options

NamespacesListKeysOptionalParams

The options parameters.

Returns

Promise<ResourceListKeys>

patch(string, string, NamespacePatchParameters, NamespacesPatchOptionalParams)

Patches the existing namespace

function patch(resourceGroupName: string, namespaceName: string, parameters: NamespacePatchParameters, options?: NamespacesPatchOptionalParams): Promise<NamespaceResource>

Parameters

resourceGroupName

string

The name of the resource group.

namespaceName

string

The namespace name.

parameters

NamespacePatchParameters

Parameters supplied to patch a Namespace Resource.

options

NamespacesPatchOptionalParams

The options parameters.

Returns

Promise<NamespaceResource>

regenerateKeys(string, string, string, PolicykeyResource, NamespacesRegenerateKeysOptionalParams)

Regenerates the Primary/Secondary Keys to the Namespace Authorization Rule

function regenerateKeys(resourceGroupName: string, namespaceName: string, authorizationRuleName: string, parameters: PolicykeyResource, options?: NamespacesRegenerateKeysOptionalParams): Promise<ResourceListKeys>

Parameters

resourceGroupName

string

The name of the resource group.

namespaceName

string

The namespace name.

authorizationRuleName

string

The connection string of the namespace for the specified authorizationRule.

parameters

PolicykeyResource

Parameters supplied to regenerate the Namespace Authorization Rule Key.

options

NamespacesRegenerateKeysOptionalParams

The options parameters.

Returns

Promise<ResourceListKeys>