Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Namespaces

Package version

Class representing a Namespaces.

Hierarchy

  • Namespaces

Index

Constructors

Methods

Constructors

constructor

Methods

beginCreateOrUpdate

  • beginCreateOrUpdate(resourceGroupName: string, namespaceName: string, parameters: RelayNamespace, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

  • Create Azure Relay namespace.

    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.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

beginDeleteMethod

  • beginDeleteMethod(resourceGroupName: string, namespaceName: string, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

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

    Parameters

    • resourceGroupName: string

      Name of the Resource group within the Azure subscription.

    • namespaceName: string

      The namespace name

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

checkNameAvailabilityMethod

createOrUpdate

  • createOrUpdate(resourceGroupName: string, namespaceName: string, parameters: RelayNamespace, options?: msRest.RequestOptionsBase): Promise<Models.NamespacesCreateOrUpdateResponse>

  • Create Azure Relay namespace.

    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.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.NamespacesCreateOrUpdateResponse>

    Promise<Models.NamespacesCreateOrUpdateResponse>

createOrUpdateAuthorizationRule

  • createOrUpdateAuthorizationRule(resourceGroupName: string, namespaceName: string, authorizationRuleName: string, parameters: AuthorizationRule, options?: msRest.RequestOptionsBase): Promise<Models.NamespacesCreateOrUpdateAuthorizationRuleResponse>
  • createOrUpdateAuthorizationRule(resourceGroupName: string, namespaceName: string, authorizationRuleName: string, parameters: AuthorizationRule, callback: msRest.ServiceCallback<AuthorizationRule>): void
  • createOrUpdateAuthorizationRule(resourceGroupName: string, namespaceName: string, authorizationRuleName: string, parameters: AuthorizationRule, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<AuthorizationRule>): void

  • Creates or updates an authorization rule for a namespace.

    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.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.NamespacesCreateOrUpdateAuthorizationRuleResponse>

    Promise<Models.NamespacesCreateOrUpdateAuthorizationRuleResponse>

  • 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.

    • callback: msRest.ServiceCallback<AuthorizationRule>

      The callback

    Returns void

  • 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: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<AuthorizationRule>

      The callback

    Returns void

deleteAuthorizationRule

  • deleteAuthorizationRule(resourceGroupName: string, namespaceName: string, authorizationRuleName: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>
  • deleteAuthorizationRule(resourceGroupName: string, namespaceName: string, authorizationRuleName: string, callback: msRest.ServiceCallback<void>): void
  • deleteAuthorizationRule(resourceGroupName: string, namespaceName: string, authorizationRuleName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<void>): void

  • Deletes a namespace authorization rule.

    Parameters

    • resourceGroupName: string

      Name of the Resource group within the Azure subscription.

    • namespaceName: string

      The namespace name

    • authorizationRuleName: string

      The authorization rule name.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRest.RestResponse>

    Promise<msRest.RestResponse>

  • Parameters

    • resourceGroupName: string

      Name of the Resource group within the Azure subscription.

    • namespaceName: string

      The namespace name

    • authorizationRuleName: string

      The authorization rule name.

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns 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: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns void

deleteMethod

  • deleteMethod(resourceGroupName: string, namespaceName: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>

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

    Parameters

    • resourceGroupName: string

      Name of the Resource group within the Azure subscription.

    • namespaceName: string

      The namespace name

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRest.RestResponse>

    Promise<msRest.RestResponse>

get

  • get(resourceGroupName: string, namespaceName: string, options?: msRest.RequestOptionsBase): Promise<Models.NamespacesGetResponse>
  • get(resourceGroupName: string, namespaceName: string, callback: msRest.ServiceCallback<RelayNamespace>): void
  • get(resourceGroupName: string, namespaceName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<RelayNamespace>): void

  • Returns the description for the specified namespace.

    Parameters

    • resourceGroupName: string

      Name of the Resource group within the Azure subscription.

    • namespaceName: string

      The namespace name

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.NamespacesGetResponse>

    Promise<Models.NamespacesGetResponse>

  • Parameters

    • resourceGroupName: string

      Name of the Resource group within the Azure subscription.

    • namespaceName: string

      The namespace name

    • callback: msRest.ServiceCallback<RelayNamespace>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      Name of the Resource group within the Azure subscription.

    • namespaceName: string

      The namespace name

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<RelayNamespace>

      The callback

    Returns void

getAuthorizationRule

  • getAuthorizationRule(resourceGroupName: string, namespaceName: string, authorizationRuleName: string, options?: msRest.RequestOptionsBase): Promise<Models.NamespacesGetAuthorizationRuleResponse>
  • getAuthorizationRule(resourceGroupName: string, namespaceName: string, authorizationRuleName: string, callback: msRest.ServiceCallback<AuthorizationRule>): void
  • getAuthorizationRule(resourceGroupName: string, namespaceName: string, authorizationRuleName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<AuthorizationRule>): void

  • Authorization rule for a namespace by name.

    Parameters

    • resourceGroupName: string

      Name of the Resource group within the Azure subscription.

    • namespaceName: string

      The namespace name

    • authorizationRuleName: string

      The authorization rule name.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.NamespacesGetAuthorizationRuleResponse>

    Promise<Models.NamespacesGetAuthorizationRuleResponse>

  • Parameters

    • resourceGroupName: string

      Name of the Resource group within the Azure subscription.

    • namespaceName: string

      The namespace name

    • authorizationRuleName: string

      The authorization rule name.

    • callback: msRest.ServiceCallback<AuthorizationRule>

      The callback

    Returns 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: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<AuthorizationRule>

      The callback

    Returns void

list

  • list(options?: msRest.RequestOptionsBase): Promise<Models.NamespacesListResponse>
  • list(callback: msRest.ServiceCallback<RelayNamespaceListResult>): void
  • list(options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<RelayNamespaceListResult>): void

listAuthorizationRules

  • listAuthorizationRules(resourceGroupName: string, namespaceName: string, options?: msRest.RequestOptionsBase): Promise<Models.NamespacesListAuthorizationRulesResponse>
  • listAuthorizationRules(resourceGroupName: string, namespaceName: string, callback: msRest.ServiceCallback<AuthorizationRuleListResult>): void
  • listAuthorizationRules(resourceGroupName: string, namespaceName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<AuthorizationRuleListResult>): void

  • Authorization rules for a namespace.

    Parameters

    • resourceGroupName: string

      Name of the Resource group within the Azure subscription.

    • namespaceName: string

      The namespace name

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.NamespacesListAuthorizationRulesResponse>

    Promise<Models.NamespacesListAuthorizationRulesResponse>

  • Parameters

    • resourceGroupName: string

      Name of the Resource group within the Azure subscription.

    • namespaceName: string

      The namespace name

    • callback: msRest.ServiceCallback<AuthorizationRuleListResult>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      Name of the Resource group within the Azure subscription.

    • namespaceName: string

      The namespace name

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<AuthorizationRuleListResult>

      The callback

    Returns void

listAuthorizationRulesNext

  • listAuthorizationRulesNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.NamespacesListAuthorizationRulesNextResponse>
  • listAuthorizationRulesNext(nextPageLink: string, callback: msRest.ServiceCallback<AuthorizationRuleListResult>): void
  • listAuthorizationRulesNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<AuthorizationRuleListResult>): void

  • Authorization rules for a namespace.

    Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.NamespacesListAuthorizationRulesNextResponse>

    Promise<Models.NamespacesListAuthorizationRulesNextResponse>

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • callback: msRest.ServiceCallback<AuthorizationRuleListResult>

      The callback

    Returns void

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<AuthorizationRuleListResult>

      The callback

    Returns void

listByResourceGroup

  • listByResourceGroup(resourceGroupName: string, options?: msRest.RequestOptionsBase): Promise<Models.NamespacesListByResourceGroupResponse>
  • listByResourceGroup(resourceGroupName: string, callback: msRest.ServiceCallback<RelayNamespaceListResult>): void
  • listByResourceGroup(resourceGroupName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<RelayNamespaceListResult>): void

  • Lists all the available namespaces within the ResourceGroup.

    Parameters

    • resourceGroupName: string

      Name of the Resource group within the Azure subscription.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.NamespacesListByResourceGroupResponse>

    Promise<Models.NamespacesListByResourceGroupResponse>

  • Parameters

    • resourceGroupName: string

      Name of the Resource group within the Azure subscription.

    • callback: msRest.ServiceCallback<RelayNamespaceListResult>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      Name of the Resource group within the Azure subscription.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<RelayNamespaceListResult>

      The callback

    Returns void

listByResourceGroupNext

  • listByResourceGroupNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.NamespacesListByResourceGroupNextResponse>
  • listByResourceGroupNext(nextPageLink: string, callback: msRest.ServiceCallback<RelayNamespaceListResult>): void
  • listByResourceGroupNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<RelayNamespaceListResult>): void

  • Lists all the available namespaces within the ResourceGroup.

    Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.NamespacesListByResourceGroupNextResponse>

    Promise<Models.NamespacesListByResourceGroupNextResponse>

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • callback: msRest.ServiceCallback<RelayNamespaceListResult>

      The callback

    Returns void

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<RelayNamespaceListResult>

      The callback

    Returns void

listKeys

  • listKeys(resourceGroupName: string, namespaceName: string, authorizationRuleName: string, options?: msRest.RequestOptionsBase): Promise<Models.NamespacesListKeysResponse>
  • listKeys(resourceGroupName: string, namespaceName: string, authorizationRuleName: string, callback: msRest.ServiceCallback<AccessKeys>): void
  • listKeys(resourceGroupName: string, namespaceName: string, authorizationRuleName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<AccessKeys>): void

  • Primary and secondary connection strings to the namespace.

    Parameters

    • resourceGroupName: string

      Name of the Resource group within the Azure subscription.

    • namespaceName: string

      The namespace name

    • authorizationRuleName: string

      The authorization rule name.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.NamespacesListKeysResponse>

    Promise<Models.NamespacesListKeysResponse>

  • Parameters

    • resourceGroupName: string

      Name of the Resource group within the Azure subscription.

    • namespaceName: string

      The namespace name

    • authorizationRuleName: string

      The authorization rule name.

    • callback: msRest.ServiceCallback<AccessKeys>

      The callback

    Returns 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: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<AccessKeys>

      The callback

    Returns void

listNext

  • listNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.NamespacesListNextResponse>
  • listNext(nextPageLink: string, callback: msRest.ServiceCallback<RelayNamespaceListResult>): void
  • listNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<RelayNamespaceListResult>): void

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

    Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.NamespacesListNextResponse>

    Promise<Models.NamespacesListNextResponse>

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • callback: msRest.ServiceCallback<RelayNamespaceListResult>

      The callback

    Returns void

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<RelayNamespaceListResult>

      The callback

    Returns void

regenerateKeys

  • regenerateKeys(resourceGroupName: string, namespaceName: string, authorizationRuleName: string, parameters: RegenerateAccessKeyParameters, options?: msRest.RequestOptionsBase): Promise<Models.NamespacesRegenerateKeysResponse>
  • regenerateKeys(resourceGroupName: string, namespaceName: string, authorizationRuleName: string, parameters: RegenerateAccessKeyParameters, callback: msRest.ServiceCallback<AccessKeys>): void
  • regenerateKeys(resourceGroupName: string, namespaceName: string, authorizationRuleName: string, parameters: RegenerateAccessKeyParameters, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<AccessKeys>): void

  • Regenerates the primary or secondary connection strings to the namespace.

    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.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.NamespacesRegenerateKeysResponse>

    Promise<Models.NamespacesRegenerateKeysResponse>

  • 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.

    • callback: msRest.ServiceCallback<AccessKeys>

      The callback

    Returns void

  • 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: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<AccessKeys>

      The callback

    Returns void

update

  • update(resourceGroupName: string, namespaceName: string, parameters: RelayUpdateParameters, options?: msRest.RequestOptionsBase): Promise<Models.NamespacesUpdateResponse>
  • update(resourceGroupName: string, namespaceName: string, parameters: RelayUpdateParameters, callback: msRest.ServiceCallback<RelayNamespace>): void
  • update(resourceGroupName: string, namespaceName: string, parameters: RelayUpdateParameters, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<RelayNamespace>): void

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

    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.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.NamespacesUpdateResponse>

    Promise<Models.NamespacesUpdateResponse>

  • 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.

    • callback: msRest.ServiceCallback<RelayNamespace>

      The callback

    Returns void

  • 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: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<RelayNamespace>

      The callback

    Returns void

Generated using TypeDoc