Namespaces interface

Pacote:

@azure/arm-notificationhubs

Interface que representa um Namespaces.

Métodos

beginDelete(string, string, NamespacesDeleteOptionalParams)	Exclui um namespace existente. Esta operação também remove todos os notificationHubs associados no namespace.
beginDeleteAndWait(string, string, NamespacesDeleteOptionalParams)	Exclui um namespace existente. Esta operação também remove todos os notificationHubs associados no namespace.
checkAvailability(CheckAvailabilityParameters, NamespacesCheckAvailabilityOptionalParams)	Verifica a disponibilidade do namespace de serviço fornecido em todas as assinaturas do Azure. Isso é útil porque o nome de domínio é criado com base no nome do namespace do serviço.
createOrUpdate(string, string, NamespaceCreateOrUpdateParameters, NamespacesCreateOrUpdateOptionalParams)	Cria/atualiza um namespace de serviço. Uma vez criado, o manifesto de recursos desse namespace é imutável. Esta operação é idempotente.
createOrUpdateAuthorizationRule(string, string, string, SharedAccessAuthorizationRuleCreateOrUpdateParameters, NamespacesCreateOrUpdateAuthorizationRuleOptionalParams)	Cria uma regra de autorização para um namespace
deleteAuthorizationRule(string, string, string, NamespacesDeleteAuthorizationRuleOptionalParams)	Exclui uma regra de autorização de namespace
get(string, string, NamespacesGetOptionalParams)	Retorna a descrição para o namespace especificado.
getAuthorizationRule(string, string, string, NamespacesGetAuthorizationRuleOptionalParams)	Obtém uma regra de autorização para um namespace por nome.
list(string, NamespacesListOptionalParams)	Lista os namespaces disponíveis em um resourceGroup.
listAll(NamespacesListAllOptionalParams)	Lista todos os namespaces disponíveis na assinatura, independentemente dos resourceGroups.
listAuthorizationRules(string, string, NamespacesListAuthorizationRulesOptionalParams)	Obtém as regras de autorização para um namespace.
listKeys(string, string, string, NamespacesListKeysOptionalParams)	Obtém as ConnectionStrings primária e secundária para o namespace
patch(string, string, NamespacePatchParameters, NamespacesPatchOptionalParams)	Corrige o namespace existente
regenerateKeys(string, string, string, PolicykeyResource, NamespacesRegenerateKeysOptionalParams)	Regenera as chaves primárias/secundárias para a regra de autorização de namespace

Detalhes de Método

beginDelete(string, string, NamespacesDeleteOptionalParams)

Exclui um namespace existente. Esta operação também remove todos os notificationHubs associados no namespace.

function beginDelete(resourceGroupName: string, namespaceName: string, options?: NamespacesDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos.

namespaceName

string

O nome do namespace.

options

NamespacesDeleteOptionalParams

Os parâmetros de opções.

Devoluções

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

beginDeleteAndWait(string, string, NamespacesDeleteOptionalParams)

Exclui um namespace existente. Esta operação também remove todos os notificationHubs associados no namespace.

function beginDeleteAndWait(resourceGroupName: string, namespaceName: string, options?: NamespacesDeleteOptionalParams): Promise<void>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos.

namespaceName

string

O nome do namespace.

options

NamespacesDeleteOptionalParams

Os parâmetros de opções.

Devoluções

Promise<void>

checkAvailability(CheckAvailabilityParameters, NamespacesCheckAvailabilityOptionalParams)

Verifica a disponibilidade do namespace de serviço fornecido em todas as assinaturas do Azure. Isso é útil porque o nome de domínio é criado com base no nome do namespace do serviço.

function checkAvailability(parameters: CheckAvailabilityParameters, options?: NamespacesCheckAvailabilityOptionalParams): Promise<CheckAvailabilityResult>

Parâmetros

parameters

CheckAvailabilityParameters

O nome do namespace.

options

NamespacesCheckAvailabilityOptionalParams

Os parâmetros de opções.

Devoluções

Promise<CheckAvailabilityResult>

createOrUpdate(string, string, NamespaceCreateOrUpdateParameters, NamespacesCreateOrUpdateOptionalParams)

Cria/atualiza um namespace de serviço. Uma vez criado, o manifesto de recursos desse namespace é imutável. Esta operação é idempotente.

function createOrUpdate(resourceGroupName: string, namespaceName: string, parameters: NamespaceCreateOrUpdateParameters, options?: NamespacesCreateOrUpdateOptionalParams): Promise<NamespaceResource>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos.

namespaceName

string

O nome do namespace.

parameters

NamespaceCreateOrUpdateParameters

Parâmetros fornecidos para criar um recurso de namespace.

options

NamespacesCreateOrUpdateOptionalParams

Os parâmetros de opções.

Devoluções

Promise<NamespaceResource>

createOrUpdateAuthorizationRule(string, string, string, SharedAccessAuthorizationRuleCreateOrUpdateParameters, NamespacesCreateOrUpdateAuthorizationRuleOptionalParams)

Cria uma regra de autorização para um namespace

function createOrUpdateAuthorizationRule(resourceGroupName: string, namespaceName: string, authorizationRuleName: string, parameters: SharedAccessAuthorizationRuleCreateOrUpdateParameters, options?: NamespacesCreateOrUpdateAuthorizationRuleOptionalParams): Promise<SharedAccessAuthorizationRuleResource>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos.

namespaceName

string

O nome do namespace.

authorizationRuleName

string

Nome da regra de autorização.

parameters

SharedAccessAuthorizationRuleCreateOrUpdateParameters

A regra de autorização de acesso compartilhado.

options

NamespacesCreateOrUpdateAuthorizationRuleOptionalParams

Os parâmetros de opções.

Devoluções

Promise<SharedAccessAuthorizationRuleResource>

deleteAuthorizationRule(string, string, string, NamespacesDeleteAuthorizationRuleOptionalParams)

Exclui uma regra de autorização de namespace

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos.

namespaceName

string

O nome do namespace.

authorizationRuleName

string

Nome da regra de autorização.

options

NamespacesDeleteAuthorizationRuleOptionalParams

Os parâmetros de opções.

Devoluções

Promise<void>

get(string, string, NamespacesGetOptionalParams)

Retorna a descrição para o namespace especificado.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos.

namespaceName

string

O nome do namespace.

options

NamespacesGetOptionalParams

Os parâmetros de opções.

Devoluções

Promise<NamespaceResource>

getAuthorizationRule(string, string, string, NamespacesGetAuthorizationRuleOptionalParams)

Obtém uma regra de autorização para um namespace por nome.

function getAuthorizationRule(resourceGroupName: string, namespaceName: string, authorizationRuleName: string, options?: NamespacesGetAuthorizationRuleOptionalParams): Promise<SharedAccessAuthorizationRuleResource>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos.

namespaceName

string

O nome do namespace

authorizationRuleName

string

Nome da regra de autorização.

options

NamespacesGetAuthorizationRuleOptionalParams

Os parâmetros de opções.

Devoluções

Promise<SharedAccessAuthorizationRuleResource>

list(string, NamespacesListOptionalParams)

Lista os namespaces disponíveis em um resourceGroup.

function list(resourceGroupName: string, options?: NamespacesListOptionalParams): PagedAsyncIterableIterator<NamespaceResource, NamespaceResource[], PageSettings>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. Se o valor resourceGroupName for null, o método listará todos os namespaces dentro da assinatura:

options

NamespacesListOptionalParams

Os parâmetros de opções.

Devoluções

PagedAsyncIterableIterator<NamespaceResource, NamespaceResource[], PageSettings>

listAll(NamespacesListAllOptionalParams)

Lista todos os namespaces disponíveis na assinatura, independentemente dos resourceGroups.

function listAll(options?: NamespacesListAllOptionalParams): PagedAsyncIterableIterator<NamespaceResource, NamespaceResource[], PageSettings>

Parâmetros

options

NamespacesListAllOptionalParams

Os parâmetros de opções.

Devoluções

PagedAsyncIterableIterator<NamespaceResource, NamespaceResource[], PageSettings>

listAuthorizationRules(string, string, NamespacesListAuthorizationRulesOptionalParams)

Obtém as regras de autorização para um namespace.

function listAuthorizationRules(resourceGroupName: string, namespaceName: string, options?: NamespacesListAuthorizationRulesOptionalParams): PagedAsyncIterableIterator<SharedAccessAuthorizationRuleResource, SharedAccessAuthorizationRuleResource[], PageSettings>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos.

namespaceName

string

O nome do namespace

options

NamespacesListAuthorizationRulesOptionalParams

Os parâmetros de opções.

Devoluções

PagedAsyncIterableIterator<SharedAccessAuthorizationRuleResource, SharedAccessAuthorizationRuleResource[], PageSettings>

listKeys(string, string, string, NamespacesListKeysOptionalParams)

Obtém as ConnectionStrings primária e secundária para o namespace

function listKeys(resourceGroupName: string, namespaceName: string, authorizationRuleName: string, options?: NamespacesListKeysOptionalParams): Promise<ResourceListKeys>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos.

namespaceName

string

O nome do namespace.

authorizationRuleName

string

A cadeia de conexão do namespace para o authorizationRule especificado.

options

NamespacesListKeysOptionalParams

Os parâmetros de opções.

Devoluções

Promise<ResourceListKeys>

patch(string, string, NamespacePatchParameters, NamespacesPatchOptionalParams)

Corrige o namespace existente

function patch(resourceGroupName: string, namespaceName: string, parameters: NamespacePatchParameters, options?: NamespacesPatchOptionalParams): Promise<NamespaceResource>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos.

namespaceName

string

O nome do namespace.

parameters

NamespacePatchParameters

Parâmetros fornecidos para corrigir um recurso de namespace.

options

NamespacesPatchOptionalParams

Os parâmetros de opções.

Devoluções

Promise<NamespaceResource>

regenerateKeys(string, string, string, PolicykeyResource, NamespacesRegenerateKeysOptionalParams)

Regenera as chaves primárias/secundárias para a regra de autorização de namespace

function regenerateKeys(resourceGroupName: string, namespaceName: string, authorizationRuleName: string, parameters: PolicykeyResource, options?: NamespacesRegenerateKeysOptionalParams): Promise<ResourceListKeys>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos.

namespaceName

string

O nome do namespace.

authorizationRuleName

string

A cadeia de conexão do namespace para o authorizationRule especificado.

parameters

PolicykeyResource

Parâmetros fornecidos para regenerar a Chave de Regra de Autorização de Espaço de Nome.

options

NamespacesRegenerateKeysOptionalParams

Os parâmetros de opções.

Devoluções

Promise<ResourceListKeys>