NamespacesOperations interface

Package:

@azure/arm-eventhub

Interface representing a Namespaces operations.

Properties

beginCreateOrUpdate
beginCreateOrUpdateAndWait
beginDelete
beginDeleteAndWait
beginFailover
beginFailoverAndWait
checkNameAvailability	Check the give Namespace name availability.
createOrUpdate	Creates or updates a namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.
createOrUpdateAuthorizationRule	Creates or updates an AuthorizationRule for a Namespace.
createOrUpdateNetworkRuleSet	Create or update NetworkRuleSet for a Namespace.
delete	Deletes an existing namespace. This operation also removes all associated resources under the namespace.
deleteAuthorizationRule	Deletes an AuthorizationRule for a Namespace.
failover	GeoDR Failover
get	Gets the description of the specified namespace.
getAuthorizationRule	Gets an AuthorizationRule for a Namespace by rule name.
getNetworkRuleSet	Gets NetworkRuleSet for a Namespace.
list	Lists all the available Namespaces within a subscription, irrespective of the resource groups.
listAuthorizationRules	Gets a list of authorization rules for a Namespace.
listByResourceGroup	Lists the available Namespaces within a resource group.
listKeys	Gets the primary and secondary connection strings for the Namespace.
listNetworkRuleSet	Gets NetworkRuleSet for a Namespace.
regenerateKeys	Regenerates the primary or secondary connection strings for the specified Namespace.
update	Creates or updates a namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.

Property Details

beginCreateOrUpdate

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdate: (resourceGroupName: string, namespaceName: string, parameters: EHNamespace, options?: NamespacesCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<EHNamespace>, EHNamespace>>

Property Value

(resourceGroupName: string, namespaceName: string, parameters: EHNamespace, options?: NamespacesCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<EHNamespace>, EHNamespace>>

beginCreateOrUpdateAndWait

Warning

This API is now deprecated.

use createOrUpdate instead

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

Property Value

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

beginDelete

Warning

This API is now deprecated.

use delete instead

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

Property Value

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

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

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

Property Value

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

beginFailover

Warning

This API is now deprecated.

use failover instead

beginFailover: (resourceGroupName: string, namespaceName: string, parameters: FailOver, options?: NamespacesFailoverOptionalParams) => Promise<SimplePollerLike<OperationState<FailOver>, FailOver>>

Property Value

(resourceGroupName: string, namespaceName: string, parameters: FailOver, options?: NamespacesFailoverOptionalParams) => Promise<SimplePollerLike<OperationState<FailOver>, FailOver>>

beginFailoverAndWait

Warning

This API is now deprecated.

use failover instead

beginFailoverAndWait: (resourceGroupName: string, namespaceName: string, parameters: FailOver, options?: NamespacesFailoverOptionalParams) => Promise<FailOver>

Property Value

(resourceGroupName: string, namespaceName: string, parameters: FailOver, options?: NamespacesFailoverOptionalParams) => Promise<FailOver>

checkNameAvailability

Check the give Namespace name availability.

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

Property Value

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

createOrUpdate

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

createOrUpdate: (resourceGroupName: string, namespaceName: string, parameters: EHNamespace, options?: NamespacesCreateOrUpdateOptionalParams) => PollerLike<OperationState<EHNamespace>, EHNamespace>

Property Value

(resourceGroupName: string, namespaceName: string, parameters: EHNamespace, options?: NamespacesCreateOrUpdateOptionalParams) => PollerLike<OperationState<EHNamespace>, EHNamespace>

createOrUpdateAuthorizationRule

Creates or updates an AuthorizationRule for a Namespace.

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

Property Value

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

createOrUpdateNetworkRuleSet

Create or update NetworkRuleSet for a Namespace.

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

Property Value

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

delete

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

delete: (resourceGroupName: string, namespaceName: string, options?: NamespacesDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, namespaceName: string, options?: NamespacesDeleteOptionalParams) => PollerLike<OperationState<void>, void>

deleteAuthorizationRule

Deletes an AuthorizationRule for a Namespace.

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

Property Value

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

failover

GeoDR Failover

failover: (resourceGroupName: string, namespaceName: string, parameters: FailOver, options?: NamespacesFailoverOptionalParams) => PollerLike<OperationState<FailOver>, FailOver>

Property Value

(resourceGroupName: string, namespaceName: string, parameters: FailOver, options?: NamespacesFailoverOptionalParams) => PollerLike<OperationState<FailOver>, FailOver>

get

Gets the description of the specified namespace.

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

Property Value

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

getAuthorizationRule

Gets an AuthorizationRule for a Namespace by rule name.

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

Property Value

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

getNetworkRuleSet

Gets NetworkRuleSet for a Namespace.

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

Property Value

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

list

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

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

Property Value

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

listAuthorizationRules

Gets a list of authorization rules for a Namespace.

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

Property Value

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

listByResourceGroup

Lists the available Namespaces within a resource group.

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

Property Value

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

listKeys

Gets the primary and secondary connection strings for the Namespace.

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

Property Value

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

listNetworkRuleSet

Gets NetworkRuleSet for a Namespace.

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

Property Value

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

regenerateKeys

Regenerates the primary or secondary connection strings for the specified Namespace.

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

Property Value

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

update

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

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

Property Value

(resourceGroupName: string, namespaceName: string, parameters: EHNamespace, options?: NamespacesUpdateOptionalParams) => Promise<undefined | EHNamespace>