Namespaces interface

Package:

@azure/arm-eventhub

Interface representing a Namespaces.

Methods

beginCreateOrUpdate(string, string, EHNamespace, NamespacesCreateOrUpdateOptionalParams)	Creates or updates a namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.
beginCreateOrUpdateAndWait(string, string, EHNamespace, NamespacesCreateOrUpdateOptionalParams)	Creates or updates a 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(CheckNameAvailabilityParameter, NamespacesCheckNameAvailabilityOptionalParams)	Check the give Namespace name availability.
createOrUpdateAuthorizationRule(string, string, string, AuthorizationRule, NamespacesCreateOrUpdateAuthorizationRuleOptionalParams)	Creates or updates an AuthorizationRule for a Namespace.
createOrUpdateNetworkRuleSet(string, string, NetworkRuleSet, NamespacesCreateOrUpdateNetworkRuleSetOptionalParams)	Create or update NetworkRuleSet for a Namespace.
deleteAuthorizationRule(string, string, string, NamespacesDeleteAuthorizationRuleOptionalParams)	Deletes an AuthorizationRule for a Namespace.
get(string, string, NamespacesGetOptionalParams)	Gets the description of the specified namespace.
getAuthorizationRule(string, string, string, NamespacesGetAuthorizationRuleOptionalParams)	Gets an AuthorizationRule for a Namespace by rule name.
getNetworkRuleSet(string, string, NamespacesGetNetworkRuleSetOptionalParams)	Gets NetworkRuleSet for a Namespace.
list(NamespacesListOptionalParams)	Lists all the available Namespaces within a subscription, irrespective of the resource groups.
listAuthorizationRules(string, string, NamespacesListAuthorizationRulesOptionalParams)	Gets a list of authorization rules for a Namespace.
listByResourceGroup(string, NamespacesListByResourceGroupOptionalParams)	Lists the available Namespaces within a resource group.
listKeys(string, string, string, NamespacesListKeysOptionalParams)	Gets the primary and secondary connection strings for the Namespace.
listNetworkRuleSet(string, string, NamespacesListNetworkRuleSetOptionalParams)	Gets NetworkRuleSet for a Namespace.
regenerateKeys(string, string, string, RegenerateAccessKeyParameters, NamespacesRegenerateKeysOptionalParams)	Regenerates the primary or secondary connection strings for the specified Namespace.
update(string, string, EHNamespace, NamespacesUpdateOptionalParams)	Creates or updates a namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.

Method Details

beginCreateOrUpdate(string, string, EHNamespace, NamespacesCreateOrUpdateOptionalParams)

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

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

Parameters

resourceGroupName

string

Name of the resource group within the azure subscription.

namespaceName

string

The Namespace name

parameters

EHNamespace

Parameters for creating a namespace resource.

options

NamespacesCreateOrUpdateOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateAndWait(string, string, EHNamespace, NamespacesCreateOrUpdateOptionalParams)

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

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

Parameters

resourceGroupName

string

Name of the resource group within the azure subscription.

namespaceName

string

The Namespace name

parameters

EHNamespace

Parameters for creating a namespace resource.

options

NamespacesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<EHNamespace>

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(CheckNameAvailabilityParameter, NamespacesCheckNameAvailabilityOptionalParams)

Check the give Namespace name availability.

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

Parameters

parameters

CheckNameAvailabilityParameter

Parameters to check availability of the given Namespace name

options

NamespacesCheckNameAvailabilityOptionalParams

The options parameters.

Returns

Promise<CheckNameAvailabilityResult>

createOrUpdateAuthorizationRule(string, string, string, AuthorizationRule, NamespacesCreateOrUpdateAuthorizationRuleOptionalParams)

Creates or updates an AuthorizationRule for a Namespace.

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

Parameters

resourceGroupName

string

Name of the resource group within the azure subscription.

namespaceName

string

The Namespace name

authorizationRuleName

string

The authorization rule name.

parameters

AuthorizationRule

The shared access AuthorizationRule.

options

NamespacesCreateOrUpdateAuthorizationRuleOptionalParams

The options parameters.

Returns

Promise<AuthorizationRule>

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.

options

NamespacesCreateOrUpdateNetworkRuleSetOptionalParams

The options parameters.

Returns

Promise<NetworkRuleSet>

deleteAuthorizationRule(string, string, string, NamespacesDeleteAuthorizationRuleOptionalParams)

Deletes an AuthorizationRule for a Namespace.

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 the description of the specified namespace.

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

Parameters

resourceGroupName

string

Name of the resource group within the azure subscription.

namespaceName

string

The Namespace name

options

NamespacesGetOptionalParams

The options parameters.

Returns

Promise<EHNamespace>

getAuthorizationRule(string, string, string, NamespacesGetAuthorizationRuleOptionalParams)

Gets an AuthorizationRule for a Namespace by rule name.

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

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

Promise<AuthorizationRule>

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)

Lists all the available Namespaces within a subscription, irrespective of the resource groups.

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

Parameters

options

NamespacesListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<EHNamespace, EHNamespace[], PageSettings>

listAuthorizationRules(string, string, NamespacesListAuthorizationRulesOptionalParams)

Gets a list of authorization rules for a Namespace.

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

Parameters

resourceGroupName

string

Name of the resource group within the azure subscription.

namespaceName

string

The Namespace name

options

NamespacesListAuthorizationRulesOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<AuthorizationRule, AuthorizationRule[], PageSettings>

listByResourceGroup(string, NamespacesListByResourceGroupOptionalParams)

Lists the available Namespaces within a resource group.

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

Parameters

resourceGroupName

string

Name of the resource group within the azure subscription.

options

NamespacesListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<EHNamespace, EHNamespace[], PageSettings>

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>

listNetworkRuleSet(string, string, NamespacesListNetworkRuleSetOptionalParams)

Gets NetworkRuleSet for a Namespace.

function listNetworkRuleSet(resourceGroupName: string, namespaceName: string, options?: NamespacesListNetworkRuleSetOptionalParams): Promise<NetworkRuleSetListResult>

Parameters

resourceGroupName

string

Name of the resource group within the azure subscription.

namespaceName

string

The Namespace name

options

NamespacesListNetworkRuleSetOptionalParams

The options parameters.

Returns

Promise<NetworkRuleSetListResult>

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

Regenerates the primary or secondary connection strings for the specified 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 required to regenerate the connection string.

options

NamespacesRegenerateKeysOptionalParams

The options parameters.

Returns

Promise<AccessKeys>

update(string, string, EHNamespace, NamespacesUpdateOptionalParams)

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

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

Parameters

resourceGroupName

string

Name of the resource group within the azure subscription.

namespaceName

string

The Namespace name

parameters

EHNamespace

Parameters for updating a namespace resource.

options

NamespacesUpdateOptionalParams

The options parameters.

Returns

Promise<EHNamespace>