Share via

Namespaces interface

  • Reference
Package:
@azure/arm-relay

Interface representing a Namespaces.

Methods

beginCreateOrUpdate(string, string, RelayNamespace, NamespacesCreateOrUpdateOptionalParams)

Create Azure Relay namespace.
beginCreateOrUpdateAndWait(string, string, RelayNamespace, NamespacesCreateOrUpdateOptionalParams)

Create Azure Relay namespace.
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 specified namespace name availability.
createOrUpdateAuthorizationRule(string, string, string, AuthorizationRule, NamespacesCreateOrUpdateAuthorizationRuleOptionalParams)

Creates or updates 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)

Authorization rule for a namespace by name.
list(NamespacesListOptionalParams)

Lists all the available namespaces within the subscription regardless of the resourceGroups.
listAuthorizationRules(string, string, NamespacesListAuthorizationRulesOptionalParams)

Authorization rules for a namespace.
listByResourceGroup(string, NamespacesListByResourceGroupOptionalParams)

Lists all the available namespaces within the ResourceGroup.
listKeys(string, string, string, NamespacesListKeysOptionalParams)

Primary and secondary connection strings to the namespace.
regenerateKeys(string, string, string, RegenerateAccessKeyParameters, NamespacesRegenerateKeysOptionalParams)

Regenerates the primary or secondary connection strings to the namespace.
update(string, string, RelayUpdateParameters, NamespacesUpdateOptionalParams)

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

Method Details

beginCreateOrUpdate(string, string, RelayNamespace, NamespacesCreateOrUpdateOptionalParams)

Create Azure Relay namespace.

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

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

namespaceName

string

The namespace name

parameters
RelayNamespace

Parameters supplied to create a namespace resource.

options
NamespacesCreateOrUpdateOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateAndWait(string, string, RelayNamespace, NamespacesCreateOrUpdateOptionalParams)

Create Azure Relay namespace.

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

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

namespaceName

string

The namespace name

parameters
RelayNamespace

Parameters supplied to create a namespace resource.

options
NamespacesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<RelayNamespace>

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 specified namespace name availability.

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

Parameters

parameters
CheckNameAvailability

Parameters to check availability of the specified namespace name.

options
NamespacesCheckNameAvailabilityOptionalParams

The options parameters.

Returns

Promise<CheckNameAvailabilityResult>

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

Creates or updates an authorization rule 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 authorization rule parameters.

options
NamespacesCreateOrUpdateAuthorizationRuleOptionalParams

The options parameters.

Returns

Promise<AuthorizationRule>

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)

Returns the description for the specified namespace.

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

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

namespaceName

string

The namespace name

options
NamespacesGetOptionalParams

The options parameters.

Returns

Promise<RelayNamespace>

getAuthorizationRule(string, string, string, NamespacesGetAuthorizationRuleOptionalParams)

Authorization rule for a namespace by 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>

list(NamespacesListOptionalParams)

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

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

Parameters

options
NamespacesListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<RelayNamespace, RelayNamespace[], PageSettings>

listAuthorizationRules(string, string, NamespacesListAuthorizationRulesOptionalParams)

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 all the available namespaces within the ResourceGroup.

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

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

options
NamespacesListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<RelayNamespace, RelayNamespace[], PageSettings>

listKeys(string, string, string, NamespacesListKeysOptionalParams)

Primary and secondary connection strings to 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 to 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 authorization rule.

options
NamespacesRegenerateKeysOptionalParams

The options parameters.

Returns

Promise<AccessKeys>

update(string, string, RelayUpdateParameters, 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: RelayUpdateParameters, options?: NamespacesUpdateOptionalParams): Promise<RelayNamespace>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

namespaceName

string

The namespace name

parameters
RelayUpdateParameters

Parameters for updating a namespace resource.

options
NamespacesUpdateOptionalParams

The options parameters.

Returns

Promise<RelayNamespace>