Namespaces interface
Interface representing a Namespaces.
Methods
| begin |
Creates or updates a namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent. |
| begin |
Creates or updates a namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent. |
| begin |
Deletes an existing namespace. This operation also removes all associated resources under the namespace. |
| begin |
Deletes an existing namespace. This operation also removes all associated resources under the namespace. |
| check |
Check the give Namespace name availability. |
| create |
Creates or updates an AuthorizationRule for a Namespace. |
| delete |
Deletes an AuthorizationRule for a Namespace. |
| get(string, string, Namespaces |
Gets the description of the specified namespace. |
| get |
Gets an AuthorizationRule for a Namespace by rule name. |
| list(Namespaces |
Lists all the available Namespaces within a subscription, irrespective of the resource groups. |
| list |
Gets a list of authorization rules for a Namespace. |
| list |
Lists the available Namespaces within a resource group. |
| list |
Gets the primary and secondary connection strings for the Namespace. |
| regenerate |
Regenerates the primary or secondary connection strings for the specified Namespace. |
| update(string, string, EHNamespace, Namespaces |
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.
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.
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
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.
The options parameters.
Returns
Promise<AuthorizationRule>
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.
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.
The options parameters.
Returns
Promise<AuthorizationRule>
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
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
The options parameters.
Returns
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.
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>
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.
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>