@azure/arm-servicebus package

Interfaces

@azure/arm-servicebus.FailOverProperties
AccessKeys

Cadeia de conexão namespace/ServiceBus

Action

Representa as ações de filtro permitidas para a transformação de uma mensagem que foram correspondidas por uma expressão de filtro.

ArmDisasterRecovery

Item único na operação Lista ou Obter Alias (Configuração de Recuperação de Desastre)

ArmDisasterRecoveryProperties

Propriedades necessárias para criar ou atualizar alias (configurações de recuperação de desastre)

CheckNameAvailability

Descrição de uma solicitação de disponibilidade Check Name.

CheckNameAvailabilityResult

Descrição de uma solicitação de disponibilidade Check Name.

ConfidentialCompute

interface de modelo ConfidentialCompute

ConnectionState

Informações do ConnectionState.

CorrelationFilter

Representa a expressão de filtro de correlação.

DisasterRecoveryConfigsBreakPairingOptionalParams

Parâmetros opcionais.

DisasterRecoveryConfigsCheckNameAvailabilityOptionalParams

Parâmetros opcionais.

DisasterRecoveryConfigsCreateOrUpdateOptionalParams

Parâmetros opcionais.

DisasterRecoveryConfigsDeleteOptionalParams

Parâmetros opcionais.

DisasterRecoveryConfigsFailOverOptionalParams

Parâmetros opcionais.

DisasterRecoveryConfigsGetAuthorizationRuleOptionalParams

Parâmetros opcionais.

DisasterRecoveryConfigsGetOptionalParams

Parâmetros opcionais.

DisasterRecoveryConfigsListAuthorizationRulesOptionalParams

Parâmetros opcionais.

DisasterRecoveryConfigsListKeysOptionalParams

Parâmetros opcionais.

DisasterRecoveryConfigsListOptionalParams

Parâmetros opcionais.

DisasterRecoveryConfigsOperations

Interface representando uma operação DisasterRecoveryConfigs.

Encryption

Propriedades para configurar a Criptografia

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

ErrorResponse

A resposta de erro de gerenciamento de recursos.

ErrorResponseError

O objeto de erro.

FailOver

FailOver da interface do modelo

FailoverProperties

O failover seguro é para indicar que o serviço deve aguardar a conclusão da replicação pendente antes de alternar para o secundário.

FailoverPropertiesProperties

O failover seguro é para indicar que o serviço deve aguardar a conclusão da replicação pendente antes de alternar para o secundário.

GeoDataReplicationProperties

Propriedades de Replicação de GeoDR

Identity

Propriedades para configurar identidades atribuídas pelo usuário para trazer suas próprias chaves

KeyVaultProperties

Propriedades para configurar propriedades keyVault

MessageCountDetails

Detalhes da contagem de mensagens.

MigrationConfigProperties

Item único na operação Listar ou Obter Configuração de Migração

MigrationConfigPropertiesProperties

Propriedades necessárias para criar a configuração de migração

MigrationConfigsCompleteMigrationOptionalParams

Parâmetros opcionais.

MigrationConfigsCreateAndStartMigrationOptionalParams

Parâmetros opcionais.

MigrationConfigsDeleteOptionalParams

Parâmetros opcionais.

MigrationConfigsGetOptionalParams

Parâmetros opcionais.

MigrationConfigsListOptionalParams

Parâmetros opcionais.

MigrationConfigsOperations

Interface representando operações MigrationConfigs.

MigrationConfigsRevertOptionalParams

Parâmetros opcionais.

NWRuleSetIpRules

Descrição do recurso NetWorkRuleSet – IpRules.

NWRuleSetVirtualNetworkRules

Descrição do recurso VirtualNetworkRules – NetworkRules.

NamespaceReplicaLocation

Propriedades de replicação de namespace

NamespacesCheckNameAvailabilityOptionalParams

Parâmetros opcionais.

NamespacesCreateOrUpdateAuthorizationRuleOptionalParams

Parâmetros opcionais.

NamespacesCreateOrUpdateNetworkRuleSetOptionalParams

Parâmetros opcionais.

NamespacesCreateOrUpdateOptionalParams

Parâmetros opcionais.

NamespacesDeleteAuthorizationRuleOptionalParams

Parâmetros opcionais.

NamespacesDeleteOptionalParams

Parâmetros opcionais.

NamespacesFailoverOptionalParams

Parâmetros opcionais.

NamespacesGetAuthorizationRuleOptionalParams

Parâmetros opcionais.

NamespacesGetNetworkRuleSetOptionalParams

Parâmetros opcionais.

NamespacesGetOptionalParams

Parâmetros opcionais.

NamespacesListAuthorizationRulesOptionalParams

Parâmetros opcionais.

NamespacesListByResourceGroupOptionalParams

Parâmetros opcionais.

NamespacesListKeysOptionalParams

Parâmetros opcionais.

NamespacesListNetworkRuleSetsOptionalParams

Parâmetros opcionais.

NamespacesListOptionalParams

Parâmetros opcionais.

NamespacesOperations

Interface que representa uma operação de Namespaces.

NamespacesRegenerateKeysOptionalParams

Parâmetros opcionais.

NamespacesUpdateOptionalParams

Parâmetros opcionais.

NetworkRuleSet

Descrição do recurso NetworkRuleSet.

NetworkRuleSetProperties

Propriedades de NetworkRuleSet

NetworkSecurityPerimeter

Informações relacionadas a NetworkSecurityPerimeter

NetworkSecurityPerimeterConfiguration

Configurações relacionadas ao Perímetro de Segurança de Rede de um determinado namespace

NetworkSecurityPerimeterConfigurationListOptionalParams

Parâmetros opcionais.

NetworkSecurityPerimeterConfigurationOperations

Interface representando operações de NetworkSecurityPerimeterConfiguration.

NetworkSecurityPerimeterConfigurationProperties

Propriedades da RedeSegurançaConfiguração do Perímetro

NetworkSecurityPerimeterConfigurationPropertiesProfile

Informações sobre o perfil de rede atual

NetworkSecurityPerimeterConfigurationPropertiesResourceAssociation

Informações sobre associação de recursos

NetworkSecurityPerimeterConfigurationsGetResourceAssociationNameOptionalParams

Parâmetros opcionais.

NetworkSecurityPerimeterConfigurationsOperations

Interface representando operações de NetworkSecurityPerimeterConfigurations.

NetworkSecurityPerimeterConfigurationsReconcileOptionalParams

Parâmetros opcionais.

NspAccessRule

Informações da regra de acesso no perfil de rede

NspAccessRuleProperties

Propriedades da regra de acesso

NspAccessRulePropertiesSubscriptionsItem

Assinatura da regra de entrada

Operation

Uma operação de API REST do Barramento de Serviço

OperationDisplay

Conteúdo de exibição da operação

OperationsListOptionalParams

Parâmetros opcionais.

OperationsOperations

Interface que representa operações de operações.

PageSettings

Opções para o método byPage

PagedAsyncIterableIterator

Uma interface que permite iteração assíncrona iterável tanto para conclusão quanto por página.

PlatformCapabilities

interface de modelo Plataformas Capacidades

PrivateEndpoint

Informações do PrivateEndpoint.

PrivateEndpointConnection

Propriedades do PrivateEndpointConnection.

PrivateEndpointConnectionProperties

Propriedades do recurso de conexão do endpoint privado.

PrivateEndpointConnectionsCreateOrUpdateOptionalParams

Parâmetros opcionais.

PrivateEndpointConnectionsDeleteOptionalParams

Parâmetros opcionais.

PrivateEndpointConnectionsGetOptionalParams

Parâmetros opcionais.

PrivateEndpointConnectionsListOptionalParams

Parâmetros opcionais.

PrivateEndpointConnectionsOperations

Interface que representa uma operação PrivateEndpointConnections.

PrivateLinkResource

Informações do recurso de link privado.

PrivateLinkResourceProperties

Propriedades do PrivateLinkResource

PrivateLinkResourcesGetOptionalParams

Parâmetros opcionais.

PrivateLinkResourcesListResult

A resposta de uma operação de lista PrivateLinkResource.

PrivateLinkResourcesOperations

Interface que representa uma operação PrivateLinkResources.

ProvisioningIssue

Descreve o problema de provisionamento para determinado NetworkSecurityPerimeterConfiguration

ProvisioningIssueProperties

Propriedades do problema de provisionamento

ProxyResource

A definição do modelo de recurso para um recurso proxy do Azure Resource Manager. Ele não terá marcas e um local

QueuesCreateOrUpdateAuthorizationRuleOptionalParams

Parâmetros opcionais.

QueuesCreateOrUpdateOptionalParams

Parâmetros opcionais.

QueuesDeleteAuthorizationRuleOptionalParams

Parâmetros opcionais.

QueuesDeleteOptionalParams

Parâmetros opcionais.

QueuesGetAuthorizationRuleOptionalParams

Parâmetros opcionais.

QueuesGetOptionalParams

Parâmetros opcionais.

QueuesListAuthorizationRulesOptionalParams

Parâmetros opcionais.

QueuesListByNamespaceOptionalParams

Parâmetros opcionais.

QueuesListKeysOptionalParams

Parâmetros opcionais.

QueuesOperations

Interface representando operações de filas.

QueuesRegenerateKeysOptionalParams

Parâmetros opcionais.

RegenerateAccessKeyParameters

Parâmetros fornecidos para a operação Regra de Autorização regenerada especifica qual chave precisa ser redefinida.

Resource

Campos comuns que são retornados na resposta para todos os recursos do Azure Resource Manager

ResourceNamespacePatch

A definição de recurso.

RestorePollerOptions
Rule

Descrição do recurso de regra.

Ruleproperties

Descrição do recurso de regra.

RulesCreateOrUpdateOptionalParams

Parâmetros opcionais.

RulesDeleteOptionalParams

Parâmetros opcionais.

RulesGetOptionalParams

Parâmetros opcionais.

RulesListBySubscriptionsOptionalParams

Parâmetros opcionais.

RulesOperations

Interface representando uma operação de Regras.

SBAuthorizationRule

Descrição de uma regra de autorização de namespace.

SBAuthorizationRuleProperties

Propriedades authorizationRule.

SBClientAffineProperties

Propriedades específicas para assinaturas de affine do cliente.

SBNamespace

Descrição de um recurso de namespace.

SBNamespaceProperties

Propriedades do namespace.

SBNamespaceUpdateParameters

Descrição de um recurso de namespace.

SBNamespaceUpdateProperties

Propriedades do namespace.

SBQueue

Descrição do recurso de fila.

SBQueueProperties

A definição de Propriedades da Fila.

SBSku

SKU do namespace.

SBSubscription

Descrição do recurso de assinatura.

SBSubscriptionProperties

Descrição do recurso de assinatura.

SBTopic

Descrição do recurso de tópico.

SBTopicProperties

A definição de Propriedades do Tópico.

ServiceBusManagementClientOptionalParams

Parâmetros opcionais para o cliente.

SimplePollerLike

Um sondador simples que pode ser usado para sondar uma operação de longa execução.

SqlFilter

Representa um filtro que é uma composição de uma expressão e uma ação executada no pipeline pub/sub.

Subnet

Propriedades fornecidas para sub-rede

SubscriptionsCreateOrUpdateOptionalParams

Parâmetros opcionais.

SubscriptionsDeleteOptionalParams

Parâmetros opcionais.

SubscriptionsGetOptionalParams

Parâmetros opcionais.

SubscriptionsListByTopicOptionalParams

Parâmetros opcionais.

SubscriptionsOperations

Interface representando operações de Assinaturas.

SystemData

Metadados relativos à criação e última modificação do recurso.

TopicsCreateOrUpdateAuthorizationRuleOptionalParams

Parâmetros opcionais.

TopicsCreateOrUpdateOptionalParams

Parâmetros opcionais.

TopicsDeleteAuthorizationRuleOptionalParams

Parâmetros opcionais.

TopicsDeleteOptionalParams

Parâmetros opcionais.

TopicsGetAuthorizationRuleOptionalParams

Parâmetros opcionais.

TopicsGetOptionalParams

Parâmetros opcionais.

TopicsListAuthorizationRulesOptionalParams

Parâmetros opcionais.

TopicsListByNamespaceOptionalParams

Parâmetros opcionais.

TopicsListKeysOptionalParams

Parâmetros opcionais.

TopicsOperations

Interface representando uma operação de Tópicos.

TopicsRegenerateKeysOptionalParams

Parâmetros opcionais.

TrackedResource

A definição do modelo de recurso para um recurso de nível superior rastreado pelo Azure Resource Manager que tem 'marcas' e um 'local'

UserAssignedIdentity

Valor reconhecido do Dicionário.

UserAssignedIdentityProperties

interface de modelo ProprietáriosIdentidadeAtribuidosUsuários

Aliases de tipo

AccessRights

Tipo de Direitos de Acesso

AzureSupportedClouds

Os valores com suporte para a configuração de nuvem como um tipo literal de cadeia de caracteres

ContinuablePage

Uma interface que descreve uma página de resultados.

CreatedByType

O tipo de entidade que criou o recurso.
KnownCreatedByType pode ser usado de forma intercambiável com CreatedByType, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

User: a entidade foi criada por um usuário.
Application: a entidade foi criada por um aplicativo.
ManagedIdentity: a entidade foi criada por uma identidade gerenciada.
Key: a entidade foi criada por uma chave.

DefaultAction

Ação Padrão para o Conjunto de Regras de Rede
KnownDefaultAction pode ser usado de forma intercambiável com DefaultAction, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

Permitir
negar

EndPointProvisioningState

Estado de provisionamento da Conexão de Ponto de Extremidade Privado.
KnownEndPointProvisioningState pode ser usado de forma intercambiável com EndPointProvisioningState, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

criando
atualizando
excluindo
êxito
Cancelada
falha na

EntityStatus

Status da entidade.

FilterType

Tipos de filtro de regra

GeoDRRoleType

Tipos de Função do GeoDR
KnowGeoDRRoleType pode ser usado de forma intercambiável com GeoDRRoleType, esse enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos compatíveis com o serviço

Primary
Secundário

KeyType

A chave de acesso a ser regenerada.

ManagedServiceIdentityType

Tipo de identidade de serviço gerenciado.

MigrationConfigurationName

Tipo de MigraçãoConfiguraçãoNome

Mode

Configuração para Habilitar ou Desabilitar o Comput Confidencial
KnownMode pode ser usado de forma intercambiável com o Modo, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

desabilitado
habilitado

NetworkRuleIPAction

A ação do filtro IP
KnownNetworkRuleIPAction pode ser usado de forma intercambiável com NetworkRuleIPAction, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

Permitir

NetworkSecurityPerimeterConfigurationProvisioningState

Estado de provisionamento da propagação da configuração do NetworkSecurityPerimeter
KnownNetworkSecurityPerimeterConfigurationProvisioningState pode ser usado de forma intercambiável com NetworkSecurityPerimeterConfigurationProvisioningState, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

Desconhecido
criando
atualizando
Aceito
InvalidResponse
êxito
SucceededWithIssues
falha na
excluindo
Excluído
Cancelada

NspAccessRuleDirection

Regra de Direção de Acesso
KnownNspAccessRuleDirection pode ser usada de forma intercambiável com NspAccessRuleDirection, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

De entrada
Saída

PrivateLinkConnectionStatus

Status da conexão.
KnownPrivateLinkConnectionStatus pode ser usado de forma intercambiável com PrivateLinkConnectionStatus, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

pendente
aprovado
rejeitado
Desconectado

ProvisioningStateDR

Estado de provisionamento do Alias(configuração de recuperação de desastre) – valores possíveis 'Aceitos' ou 'Bem-sucedidos' ou 'Com falha'

PublicNetworkAccess

Isso determina se o tráfego é permitido pela rede pública. Por padrão, ele está habilitado.
KnownPublicNetworkAccess podem ser usados de forma intercambiável com PublicNetworkAccess, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

habilitado
desabilitado
SecuredByPerimeter

PublicNetworkAccessFlag

Isso determina se o tráfego é permitido pela rede pública. Por padrão, ele está habilitado.
KnownPublicNetworkAccessFlag podem ser usados de forma intercambiável com PublicNetworkAccessFlag, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

habilitado
desabilitado

ResourceAssociationAccessMode

Modo de acesso da associação de recursos
KnownResourceAssociationAccessMode pode ser usado de forma intercambiável com ResourceAssociationAccessMode, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

NoAssociationMode
EnforcedMode
LearningMode
auditMode
UnspecifiedMode

RoleDisasterRecovery

função de namespace na RECUPERAÇÃO GEOGRÁFICA – valores possíveis 'Primary' ou 'PrimaryNotReplicating' ou 'Secondary'

SkuName

Nome dessa SKU.

SkuTier

A camada de cobrança deste SKU específico.

TlsVersion

A versão mínima de TLS para o cluster suportar, por exemplo, '1.3'
KnownTlsVersion pode ser usado de forma intercambiável com TlsVersion, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

1.0
1.1
1.2
1.3

UnavailableReason

Especifica o motivo da indisponibilidade do serviço.

Enumerações

AzureClouds

Um enum para descrever ambientes de nuvem Azure.

KnownCreatedByType

O tipo de entidade que criou o recurso.

KnownDefaultAction

Ação padrão para o conjunto de regras de rede

KnownEndPointProvisioningState

Estado de provisionamento da Conexão de Ponto de Extremidade Privado.

KnownGeoDRRoleType

Tipos de função GeoDR

KnownMigrationConfigurationName

Valores conhecidos de MigrationConfigurationName que o serviço aceita.

KnownMode

Configuração para habilitar ou desabilitar a computação confidencial

KnownNetworkRuleIPAction

A ação filtro IP

KnownNetworkSecurityPerimeterConfigurationProvisioningState

Estado de provisionamento da propagação de configuração de NetworkSecurityPerimeter

KnownNspAccessRuleDirection

Direção da regra de acesso

KnownPrivateLinkConnectionStatus

Status da conexão.

KnownPublicNetworkAccess

Isso determina se o tráfego é permitido pela rede pública. Por padrão, ele está habilitado.

KnownPublicNetworkAccessFlag

Isso determina se o tráfego é permitido pela rede pública. Por padrão, ele está habilitado.

KnownResourceAssociationAccessMode

Modo de Acesso da associação de recursos

KnownTlsVersion

A versão mínima de TLS para o cluster suportar, por exemplo, '1.3'

KnownVersions

As versões de API disponíveis.

Funções

isRestError(unknown)

Typeguard para RestError

restorePoller<TResponse, TResult>(ServiceBusManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Cria um sondador do estado serializado de outro sondador. Isso pode ser útil quando você deseja criar sondadores em um host diferente ou um sondador precisa ser construído depois que o original não estiver no escopo.

Variáveis

RestError

Um tipo de erro personalizado para solicitações de pipeline com falha.

Detalhes da função

isRestError(unknown)

Typeguard para RestError

function isRestError(e: unknown): e

Parâmetros

e

unknown

Algo pego por uma cláusula catch.

Retornos

e

restorePoller<TResponse, TResult>(ServiceBusManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Cria um sondador do estado serializado de outro sondador. Isso pode ser útil quando você deseja criar sondadores em um host diferente ou um sondador precisa ser construído depois que o original não estiver no escopo.

function restorePoller<TResponse, TResult>(client: ServiceBusManagementClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parâmetros

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

Retornos

PollerLike<OperationState<TResult>, TResult>

Detalhes da variável

RestError

Um tipo de erro personalizado para solicitações de pipeline com falha.

RestError: RestErrorConstructor

Tipo