Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Namespaces

Package version

Class representing a Namespaces.

Hierarchy

  • Namespaces

Index

Constructors

constructor

Methods

beginDeleteMethod

  • beginDeleteMethod(resourceGroupName: string, namespaceName: string, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>
  • Deletes an existing namespace. This operation also removes all associated notificationHubs under the namespace.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • namespaceName: string

      The namespace name.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

checkAvailability

createOrUpdate

  • Creates/Updates a service namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • namespaceName: string

      The namespace name.

    • parameters: NamespaceCreateOrUpdateParameters

      Parameters supplied to create a Namespace Resource.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.NamespacesCreateOrUpdateResponse>

    Promise<Models.NamespacesCreateOrUpdateResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • namespaceName: string

      The namespace name.

    • parameters: NamespaceCreateOrUpdateParameters

      Parameters supplied to create a Namespace Resource.

    • callback: msRest.ServiceCallback<NamespaceResource>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • namespaceName: string

      The namespace name.

    • parameters: NamespaceCreateOrUpdateParameters

      Parameters supplied to create a Namespace Resource.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<NamespaceResource>

      The callback

    Returns void

createOrUpdateAuthorizationRule

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

      The name of the resource group.

    • namespaceName: string

      The namespace name.

    • authorizationRuleName: string

      Authorization Rule Name.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRest.RestResponse>

    Promise<msRest.RestResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • namespaceName: string

      The namespace name.

    • authorizationRuleName: string

      Authorization Rule Name.

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • namespaceName: string

      The namespace name.

    • authorizationRuleName: string

      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 notificationHubs under the namespace.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • 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<NamespaceResource>): void
  • get(resourceGroupName: string, namespaceName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<NamespaceResource>): void
  • Returns the description for the specified namespace.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • namespaceName: string

      The namespace name.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.NamespacesGetResponse>

    Promise<Models.NamespacesGetResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • namespaceName: string

      The namespace name.

    • callback: msRest.ServiceCallback<NamespaceResource>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • namespaceName: string

      The namespace name.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<NamespaceResource>

      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<SharedAccessAuthorizationRuleResource>): void
  • getAuthorizationRule(resourceGroupName: string, namespaceName: string, authorizationRuleName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<SharedAccessAuthorizationRuleResource>): void
  • Gets an authorization rule for a namespace by name.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • namespaceName: string

      The namespace name

    • authorizationRuleName: string

      Authorization rule name.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.NamespacesGetAuthorizationRuleResponse>

    Promise<Models.NamespacesGetAuthorizationRuleResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • namespaceName: string

      The namespace name

    • authorizationRuleName: string

      Authorization rule name.

    • callback: msRest.ServiceCallback<SharedAccessAuthorizationRuleResource>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • namespaceName: string

      The namespace name

    • authorizationRuleName: string

      Authorization rule name.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<SharedAccessAuthorizationRuleResource>

      The callback

    Returns void

list

  • list(resourceGroupName: string, options?: msRest.RequestOptionsBase): Promise<Models.NamespacesListResponse>
  • list(resourceGroupName: string, callback: msRest.ServiceCallback<NamespaceListResult>): void
  • list(resourceGroupName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<NamespaceListResult>): void
  • Lists the available namespaces within a resourceGroup.

    Parameters

    • resourceGroupName: string

      The name of the resource group. If resourceGroupName value is null the method lists all the namespaces within subscription

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.NamespacesListResponse>

    Promise<Models.NamespacesListResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group. If resourceGroupName value is null the method lists all the namespaces within subscription

    • callback: msRest.ServiceCallback<NamespaceListResult>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group. If resourceGroupName value is null the method lists all the namespaces within subscription

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<NamespaceListResult>

      The callback

    Returns void

listAll

  • listAll(options?: msRest.RequestOptionsBase): Promise<Models.NamespacesListAllResponse>
  • listAll(callback: msRest.ServiceCallback<NamespaceListResult>): void
  • listAll(options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<NamespaceListResult>): void

listAllNext

  • listAllNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.NamespacesListAllNextResponse>
  • listAllNext(nextPageLink: string, callback: msRest.ServiceCallback<NamespaceListResult>): void
  • listAllNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<NamespaceListResult>): void
  • Lists all the available namespaces within the subscription irrespective of the resourceGroups.

    Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.NamespacesListAllNextResponse>

    Promise<Models.NamespacesListAllNextResponse>

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • callback: msRest.ServiceCallback<NamespaceListResult>

      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<NamespaceListResult>

      The callback

    Returns void

listAuthorizationRules

  • listAuthorizationRules(resourceGroupName: string, namespaceName: string, options?: msRest.RequestOptionsBase): Promise<Models.NamespacesListAuthorizationRulesResponse>
  • listAuthorizationRules(resourceGroupName: string, namespaceName: string, callback: msRest.ServiceCallback<SharedAccessAuthorizationRuleListResult>): void
  • listAuthorizationRules(resourceGroupName: string, namespaceName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<SharedAccessAuthorizationRuleListResult>): void
  • Gets the authorization rules for a namespace.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • namespaceName: string

      The namespace name

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.NamespacesListAuthorizationRulesResponse>

    Promise<Models.NamespacesListAuthorizationRulesResponse>

  • Parameters

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • namespaceName: string

      The namespace name

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<SharedAccessAuthorizationRuleListResult>

      The callback

    Returns void

listAuthorizationRulesNext

  • listAuthorizationRulesNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.NamespacesListAuthorizationRulesNextResponse>
  • listAuthorizationRulesNext(nextPageLink: string, callback: msRest.ServiceCallback<SharedAccessAuthorizationRuleListResult>): void
  • listAuthorizationRulesNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<SharedAccessAuthorizationRuleListResult>): void
  • Gets the 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

    Returns void

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<SharedAccessAuthorizationRuleListResult>

      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<SharedAccessAuthorizationRuleListResult>): void
  • listKeys(resourceGroupName: string, namespaceName: string, authorizationRuleName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<SharedAccessAuthorizationRuleListResult>): void
  • Gets the Primary and Secondary ConnectionStrings to the namespace

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • namespaceName: string

      The namespace name.

    • authorizationRuleName: string

      The connection string of the namespace for the specified authorizationRule.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.NamespacesListKeysResponse>

    Promise<Models.NamespacesListKeysResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • namespaceName: string

      The namespace name.

    • authorizationRuleName: string

      The connection string of the namespace for the specified authorizationRule.

    • callback: msRest.ServiceCallback<SharedAccessAuthorizationRuleListResult>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • namespaceName: string

      The namespace name.

    • authorizationRuleName: string

      The connection string of the namespace for the specified authorizationRule.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<SharedAccessAuthorizationRuleListResult>

      The callback

    Returns void

listNext

  • listNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.NamespacesListNextResponse>
  • listNext(nextPageLink: string, callback: msRest.ServiceCallback<NamespaceListResult>): void
  • listNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<NamespaceListResult>): void
  • Lists the available namespaces within a resourceGroup.

    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<NamespaceListResult>

      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<NamespaceListResult>

      The callback

    Returns void

patch

  • Patches the existing namespace

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • namespaceName: string

      The namespace name.

    • parameters: NamespacePatchParameters

      Parameters supplied to patch a Namespace Resource.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.NamespacesPatchResponse>

    Promise<Models.NamespacesPatchResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • namespaceName: string

      The namespace name.

    • parameters: NamespacePatchParameters

      Parameters supplied to patch a Namespace Resource.

    • callback: msRest.ServiceCallback<NamespaceResource>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • namespaceName: string

      The namespace name.

    • parameters: NamespacePatchParameters

      Parameters supplied to patch a Namespace Resource.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<NamespaceResource>

      The callback

    Returns void

regenerateKeys

  • regenerateKeys(resourceGroupName: string, namespaceName: string, authorizationRuleName: string, parameters: PolicykeyResource, options?: msRest.RequestOptionsBase): Promise<Models.NamespacesRegenerateKeysResponse>
  • regenerateKeys(resourceGroupName: string, namespaceName: string, authorizationRuleName: string, parameters: PolicykeyResource, callback: msRest.ServiceCallback<ResourceListKeys>): void
  • regenerateKeys(resourceGroupName: string, namespaceName: string, authorizationRuleName: string, parameters: PolicykeyResource, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<ResourceListKeys>): void
  • Regenerates the Primary/Secondary Keys to the Namespace Authorization Rule

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • namespaceName: string

      The namespace name.

    • authorizationRuleName: string

      The connection string of the namespace for the specified authorizationRule.

    • parameters: PolicykeyResource

      Parameters supplied to regenerate the Namespace Authorization Rule Key.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.NamespacesRegenerateKeysResponse>

    Promise<Models.NamespacesRegenerateKeysResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • namespaceName: string

      The namespace name.

    • authorizationRuleName: string

      The connection string of the namespace for the specified authorizationRule.

    • parameters: PolicykeyResource

      Parameters supplied to regenerate the Namespace Authorization Rule Key.

    • callback: msRest.ServiceCallback<ResourceListKeys>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • namespaceName: string

      The namespace name.

    • authorizationRuleName: string

      The connection string of the namespace for the specified authorizationRule.

    • parameters: PolicykeyResource

      Parameters supplied to regenerate the Namespace Authorization Rule Key.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<ResourceListKeys>

      The callback

    Returns void

Generated using TypeDoc