Namespaces interface

Interface representing a Namespaces.

Methods

beginCreateOrUpdate(string, string, SBNamespace, NamespacesCreateOrUpdateOptionalParams)

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

beginCreateOrUpdateAndWait(string, string, SBNamespace, NamespacesCreateOrUpdateOptionalParams)

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

beginDelete(string, string, NamespacesDeleteOptionalParams)

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

beginDeleteAndWait(string, string, NamespacesDeleteOptionalParams)

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

checkNameAvailability(CheckNameAvailability, NamespacesCheckNameAvailabilityOptionalParams)

Check the give namespace name availability.

createOrUpdateAuthorizationRule(string, string, string, SBAuthorizationRule, NamespacesCreateOrUpdateAuthorizationRuleOptionalParams)

Creates or updates an authorization rule for a namespace.

createOrUpdateNetworkRuleSet(string, string, NetworkRuleSet, NamespacesCreateOrUpdateNetworkRuleSetOptionalParams)

Create or update NetworkRuleSet for a Namespace.

deleteAuthorizationRule(string, string, string, NamespacesDeleteAuthorizationRuleOptionalParams)

Deletes a namespace authorization rule.

get(string, string, NamespacesGetOptionalParams)

Gets a description for the specified namespace.

getAuthorizationRule(string, string, string, NamespacesGetAuthorizationRuleOptionalParams)

Gets an authorization rule for a namespace by rule name.

getNetworkRuleSet(string, string, NamespacesGetNetworkRuleSetOptionalParams)

Gets NetworkRuleSet for a Namespace.

list(NamespacesListOptionalParams)

Gets all the available namespaces within the subscription, irrespective of the resource groups.

listAuthorizationRules(string, string, NamespacesListAuthorizationRulesOptionalParams)

Gets the authorization rules for a namespace.

listByResourceGroup(string, NamespacesListByResourceGroupOptionalParams)

Gets the available namespaces within a resource group.

listKeys(string, string, string, NamespacesListKeysOptionalParams)

Gets the primary and secondary connection strings for the namespace.

listNetworkRuleSets(string, string, NamespacesListNetworkRuleSetsOptionalParams)

Gets list of NetworkRuleSet for a Namespace.

regenerateKeys(string, string, string, RegenerateAccessKeyParameters, NamespacesRegenerateKeysOptionalParams)

Regenerates the primary or secondary connection strings for the namespace.

update(string, string, SBNamespaceUpdateParameters, NamespacesUpdateOptionalParams)

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

Method Details

beginCreateOrUpdate(string, string, SBNamespace, NamespacesCreateOrUpdateOptionalParams)

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

function beginCreateOrUpdate(resourceGroupName: string, namespaceName: string, parameters: SBNamespace, options?: NamespacesCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<SBNamespace>, SBNamespace>>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

namespaceName

string

The namespace name.

parameters
SBNamespace

Parameters supplied to create a namespace resource.

options
NamespacesCreateOrUpdateOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateAndWait(string, string, SBNamespace, NamespacesCreateOrUpdateOptionalParams)

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

function beginCreateOrUpdateAndWait(resourceGroupName: string, namespaceName: string, parameters: SBNamespace, options?: NamespacesCreateOrUpdateOptionalParams): Promise<SBNamespace>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

namespaceName

string

The namespace name.

parameters
SBNamespace

Parameters supplied to create a namespace resource.

options
NamespacesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<SBNamespace>

beginDelete(string, string, NamespacesDeleteOptionalParams)

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

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

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

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 resources under the namespace.

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

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

namespaceName

string

The namespace name

options
NamespacesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

checkNameAvailability(CheckNameAvailability, NamespacesCheckNameAvailabilityOptionalParams)

Check the give namespace name availability.

function checkNameAvailability(parameters: CheckNameAvailability, options?: NamespacesCheckNameAvailabilityOptionalParams): Promise<CheckNameAvailabilityResult>

Parameters

parameters
CheckNameAvailability

Parameters to check availability of the given namespace name

options
NamespacesCheckNameAvailabilityOptionalParams

The options parameters.

Returns

createOrUpdateAuthorizationRule(string, string, string, SBAuthorizationRule, NamespacesCreateOrUpdateAuthorizationRuleOptionalParams)

Creates or updates an authorization rule for a namespace.

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

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

namespaceName

string

The namespace name

authorizationRuleName

string

The authorization rule name.

parameters
SBAuthorizationRule

The shared access authorization rule.

Returns

createOrUpdateNetworkRuleSet(string, string, NetworkRuleSet, NamespacesCreateOrUpdateNetworkRuleSetOptionalParams)

Create or update NetworkRuleSet for a Namespace.

function createOrUpdateNetworkRuleSet(resourceGroupName: string, namespaceName: string, parameters: NetworkRuleSet, options?: NamespacesCreateOrUpdateNetworkRuleSetOptionalParams): Promise<NetworkRuleSet>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

namespaceName

string

The namespace name

parameters
NetworkRuleSet

The Namespace IpFilterRule.

Returns

Promise<NetworkRuleSet>

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

Name of the Resource group within the Azure subscription.

namespaceName

string

The namespace name

authorizationRuleName

string

The authorization rule name.

options
NamespacesDeleteAuthorizationRuleOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, NamespacesGetOptionalParams)

Gets a description for the specified namespace.

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

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

namespaceName

string

The namespace name

options
NamespacesGetOptionalParams

The options parameters.

Returns

Promise<SBNamespace>

getAuthorizationRule(string, string, string, NamespacesGetAuthorizationRuleOptionalParams)

Gets an authorization rule for a namespace by rule name.

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

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

namespaceName

string

The namespace name

authorizationRuleName

string

The authorization rule name.

options
NamespacesGetAuthorizationRuleOptionalParams

The options parameters.

Returns

getNetworkRuleSet(string, string, NamespacesGetNetworkRuleSetOptionalParams)

Gets NetworkRuleSet for a Namespace.

function getNetworkRuleSet(resourceGroupName: string, namespaceName: string, options?: NamespacesGetNetworkRuleSetOptionalParams): Promise<NetworkRuleSet>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

namespaceName

string

The namespace name

options
NamespacesGetNetworkRuleSetOptionalParams

The options parameters.

Returns

Promise<NetworkRuleSet>

list(NamespacesListOptionalParams)

Gets all the available namespaces within the subscription, irrespective of the resource groups.

function list(options?: NamespacesListOptionalParams): PagedAsyncIterableIterator<SBNamespace, SBNamespace[], PageSettings>

Parameters

options
NamespacesListOptionalParams

The options parameters.

Returns

listAuthorizationRules(string, string, NamespacesListAuthorizationRulesOptionalParams)

Gets the authorization rules for a namespace.

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

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

namespaceName

string

The namespace name

options
NamespacesListAuthorizationRulesOptionalParams

The options parameters.

Returns

listByResourceGroup(string, NamespacesListByResourceGroupOptionalParams)

Gets the available namespaces within a resource group.

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

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

options
NamespacesListByResourceGroupOptionalParams

The options parameters.

Returns

listKeys(string, string, string, NamespacesListKeysOptionalParams)

Gets the primary and secondary connection strings for the namespace.

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

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

namespaceName

string

The namespace name

authorizationRuleName

string

The authorization rule name.

options
NamespacesListKeysOptionalParams

The options parameters.

Returns

Promise<AccessKeys>

listNetworkRuleSets(string, string, NamespacesListNetworkRuleSetsOptionalParams)

Gets list of NetworkRuleSet for a Namespace.

function listNetworkRuleSets(resourceGroupName: string, namespaceName: string, options?: NamespacesListNetworkRuleSetsOptionalParams): PagedAsyncIterableIterator<NetworkRuleSet, NetworkRuleSet[], PageSettings>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

namespaceName

string

The namespace name

options
NamespacesListNetworkRuleSetsOptionalParams

The options parameters.

Returns

regenerateKeys(string, string, string, RegenerateAccessKeyParameters, NamespacesRegenerateKeysOptionalParams)

Regenerates the primary or secondary connection strings for the namespace.

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

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

namespaceName

string

The namespace name

authorizationRuleName

string

The authorization rule name.

parameters
RegenerateAccessKeyParameters

Parameters supplied to regenerate the authorization rule.

options
NamespacesRegenerateKeysOptionalParams

The options parameters.

Returns

Promise<AccessKeys>

update(string, string, SBNamespaceUpdateParameters, NamespacesUpdateOptionalParams)

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

function update(resourceGroupName: string, namespaceName: string, parameters: SBNamespaceUpdateParameters, options?: NamespacesUpdateOptionalParams): Promise<SBNamespace>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

namespaceName

string

The namespace name

parameters
SBNamespaceUpdateParameters

Parameters supplied to update a namespace resource.

options
NamespacesUpdateOptionalParams

The options parameters.

Returns

Promise<SBNamespace>