NamespacesOperations interface

Package:

@azure/arm-relay

Interface representing a Namespaces operations.

Properties

beginCreateOrUpdate
beginCreateOrUpdateAndWait
beginDelete
beginDeleteAndWait
checkNameAvailability	Check the specified namespace name availability.
createOrUpdate	Create Azure Relay namespace.
createOrUpdateAuthorizationRule	Creates or updates an authorization rule 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 a namespace authorization rule.
get	Returns the description for the specified namespace.
getAuthorizationRule	Authorization rule for a namespace by name.
getNetworkRuleSet	Gets NetworkRuleSet for a Namespace.
list	Lists all the available namespaces within the subscription regardless of the resourceGroups.
listAuthorizationRules	Authorization rules for a namespace.
listByResourceGroup	Lists all the available namespaces within the ResourceGroup.
listKeys	Primary and secondary connection strings to the namespace.
regenerateKeys	Regenerates the primary or secondary connection strings to the 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: RelayNamespace, options?: NamespacesCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<RelayNamespace>, RelayNamespace>>

Property Value

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

beginCreateOrUpdateAndWait

Warning

This API is now deprecated.

use createOrUpdate instead

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

Property Value

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

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>

checkNameAvailability

Check the specified namespace name availability.

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

Property Value

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

createOrUpdate

Create Azure Relay namespace.

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

Property Value

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

createOrUpdateAuthorizationRule

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

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

Property Value

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

get

Returns the description for the specified namespace.

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

Property Value

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

getAuthorizationRule

Authorization rule for a namespace by 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 the subscription regardless of the resourceGroups.

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

Property Value

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

listAuthorizationRules

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

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

Property Value

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

listKeys

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

regenerateKeys

Regenerates the primary or secondary connection strings to the 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: RelayUpdateParameters, options?: NamespacesUpdateOptionalParams) => Promise<RelayNamespace>

Property Value

(resourceGroupName: string, namespaceName: string, parameters: RelayUpdateParameters, options?: NamespacesUpdateOptionalParams) => Promise<RelayNamespace>