@azure/arm-communication package

Interfaces

CheckNameAvailabilityRequest

O corpo da solicitação de disponibilidade de verificação.

CheckNameAvailabilityResponse

O resultado da disponibilidade de verificação.

CommunicationServiceKeys

Uma classe que representa as chaves de acesso de um CommunicationService.

CommunicationServiceManagementClientOptionalParams

Parâmetros opcionais para o cliente.

CommunicationServiceProperties

Uma classe que descreve as propriedades do CommunicationService.

CommunicationServiceResource

Uma classe que representa um recurso CommunicationService.

CommunicationServiceResourceUpdate

Uma classe que representa parâmetros de atualização para o recurso CommunicationService.

CommunicationServiceUpdateProperties

Uma classe que descreve as propriedades que podem ser atualizadas para o recurso CommunicationService.

CommunicationServicesCheckNameAvailabilityOptionalParams

Parâmetros opcionais.

CommunicationServicesCreateOrUpdateOptionalParams

Parâmetros opcionais.

CommunicationServicesDeleteOptionalParams

Parâmetros opcionais.

CommunicationServicesGetOptionalParams

Parâmetros opcionais.

CommunicationServicesLinkNotificationHubOptionalParams

Parâmetros opcionais.

CommunicationServicesListByResourceGroupOptionalParams

Parâmetros opcionais.

CommunicationServicesListBySubscriptionOptionalParams

Parâmetros opcionais.

CommunicationServicesListKeysOptionalParams

Parâmetros opcionais.

CommunicationServicesOperations

Interface representando uma operação de Serviços de Comunicação.

CommunicationServicesRegenerateKeyOptionalParams

Parâmetros opcionais.

CommunicationServicesUpdateOptionalParams

Parâmetros opcionais.

DnsRecord

Uma classe que representa um registro VerificationStatus.

DomainProperties

Uma classe que descreve as propriedades de um recurso Domains.

DomainPropertiesVerificationRecords

Lista de DnsRecord

DomainPropertiesVerificationStates

Lista de VerificationStatusRecord

DomainResource

Uma classe que representa um recurso de Domínios.

DomainsCancelVerificationOptionalParams

Parâmetros opcionais.

DomainsCreateOrUpdateOptionalParams

Parâmetros opcionais.

DomainsDeleteOptionalParams

Parâmetros opcionais.

DomainsGetOptionalParams

Parâmetros opcionais.

DomainsInitiateVerificationOptionalParams

Parâmetros opcionais.

DomainsListByEmailServiceResourceOptionalParams

Parâmetros opcionais.

DomainsOperations

Interface representando operações de domínios.

DomainsUpdateOptionalParams

Parâmetros opcionais.

EmailServiceProperties

Uma classe que descreve as propriedades do Serviço de E-mail.

EmailServiceResource

Uma classe que representa um recurso emailService.

EmailServiceResourceUpdate

Uma classe que representa parâmetros de atualização para o recurso EmailService.

EmailServicesCreateOrUpdateOptionalParams

Parâmetros opcionais.

EmailServicesDeleteOptionalParams

Parâmetros opcionais.

EmailServicesGetOptionalParams

Parâmetros opcionais.

EmailServicesListByResourceGroupOptionalParams

Parâmetros opcionais.

EmailServicesListBySubscriptionOptionalParams

Parâmetros opcionais.

EmailServicesListVerifiedExchangeOnlineDomainsOptionalParams

Parâmetros opcionais.

EmailServicesOperations

Interface representando uma operação do E-MailServices.

EmailServicesUpdateOptionalParams

Parâmetros opcionais.

ErrorAdditionalInfo

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

ErrorDetail

O detalhe do erro.

ErrorResponse

Resposta de erro comum para todas as APIs do Azure Resource Manager retornarem detalhes de erro para operações com falha.

LinkNotificationHubParameters

Descrição de um Hub de Notificação do Azure para vincular ao serviço de comunicação

LinkedNotificationHub

Um hub de notificação que foi vinculado ao serviço de comunicação

ManagedServiceIdentity

Identidade de serviço gerenciada (identidades atribuídas pelo sistema e/ou pelo usuário)

NameAvailabilityParameters

Data POST-ed para a ação nameAvailability

Operation

Detalhes de uma operação de API REST, retornada da API de Operações do Provedor de Recursos

OperationDisplay

Informações localizadas de exibição para uma operação.

OperationsListOptionalParams

Parâmetros opcionais.

OperationsOperations

Interface representando uma operação 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.

ProxyResource

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

RegenerateKeyParameters

Parâmetros descrevem a solicitação para regenerar chaves de acesso

Resource

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

RestorePollerOptions
SenderUsernameProperties

Uma classe que descreve as propriedades de um recurso SenderUsername.

SenderUsernameResource

Uma classe que representa um recurso SenderUsername.

SenderUsernamesCreateOrUpdateOptionalParams

Parâmetros opcionais.

SenderUsernamesDeleteOptionalParams

Parâmetros opcionais.

SenderUsernamesGetOptionalParams

Parâmetros opcionais.

SenderUsernamesListByDomainsOptionalParams

Parâmetros opcionais.

SenderUsernamesOperations

Interface representando uma operação Nomes de Usuário do Remetente.

SimplePollerLike

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

SmtpUsernameProperties

Uma classe que descreve as propriedades de um recurso SmtpUsername.

SmtpUsernameResource

O objeto que descreve o recurso de nome de usuário SMTP.

SmtpUsernamesCreateOrUpdateOptionalParams

Parâmetros opcionais.

SmtpUsernamesDeleteOptionalParams

Parâmetros opcionais.

SmtpUsernamesGetOptionalParams

Parâmetros opcionais.

SmtpUsernamesListOptionalParams

Parâmetros opcionais.

SmtpUsernamesOperations

Interface representando operações de nomes de usuário Smtp.

SuppressionListAddressProperties

Uma classe que descreve as propriedades de um recurso SuppressionListAddress.

SuppressionListAddressResource

Um objeto que representa um registro SuppressionList.

SuppressionListAddressesCreateOrUpdateOptionalParams

Parâmetros opcionais.

SuppressionListAddressesDeleteOptionalParams

Parâmetros opcionais.

SuppressionListAddressesGetOptionalParams

Parâmetros opcionais.

SuppressionListAddressesListOptionalParams

Parâmetros opcionais.

SuppressionListAddressesOperations

Interface representando operações SuppressionListAddresss.

SuppressionListProperties

Uma classe que descreve as propriedades de um recurso SuppressionList.

SuppressionListResource

Uma classe que representa um recurso SuppressionList.

SuppressionListsCreateOrUpdateOptionalParams

Parâmetros opcionais.

SuppressionListsDeleteOptionalParams

Parâmetros opcionais.

SuppressionListsGetOptionalParams

Parâmetros opcionais.

SuppressionListsListByDomainOptionalParams

Parâmetros opcionais.

SuppressionListsOperations

Interface representando uma operação SuppressionLists.

SystemData

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

TaggedResource

Um recurso do ARM com o qual é possível aceitar marcas

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'

UpdateDomainProperties

Uma classe que descreve as propriedades atualizáveis de um recurso Domains.

UpdateDomainRequestParameters

Uma classe que descreve os parâmetros de solicitação PATCH de um recurso de Domínios.

UserAssignedIdentity

Propriedades de identidade atribuídas pelo usuário

VerificationParameter

Parâmetro de entrada para APIs de verificação

VerificationStatusRecord

Uma classe que representa um registro VerificationStatus.

Aliases de tipo

ActionType

Enumeração extensível. Indica o tipo de ação. "Interno" refere-se a ações que são apenas para APIs internas.
KnownActionType pode ser usado de forma intercambiável com ActionType, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

Interno: as ações são para APIs somente internas.

AzureSupportedClouds

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

CheckNameAvailabilityReason

Possíveis motivos para um nome não estar disponível.
KnownCheckNameAvailabilityReason pode ser usado de forma intercambiável com CheckNameAvailabilityReason, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

Inválido: o nome é inválido.
AlreadyExists: o nome já existe.

CommunicationServicesProvisioningState

Estado de provisionamento do recurso.
KnownCommunicationServicesProvisioningState pode ser usado de forma intercambiável com CommunicationServicesProvisioningState, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

Desconhecido: Desconhecido
Sucesso: Sucessor
Falha: Falha
Cancelado: Cancelado
Correndo: Correndo
Criando: Criando
Atualizando: Atualizando
Eliminando: Excluindo
Movimento: Mudança

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.

DomainManagement

Descreve como um recurso de Domínios está sendo gerenciado.
KnownDomainManagement pode ser usado de forma intercambiável com DomainManagement, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

AzureManaged: AzureManaged
Gerenciado pelo Cliente: Gerenciado pelo Cliente
ClienteGerenciadoInExchangeOnline: CustomerManagedInExchangeOnline

DomainsProvisioningState

Estado de provisionamento do recurso.
KnownDomainsProvisioningState pode ser usado de forma intercambiável com DomainsProvisioningState, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

Desconhecido: Desconhecido
Sucesso: Sucessor
Falha: Falha
Cancelado: Cancelado
Correndo: Correndo
Criando: Criando
Atualizando: Atualizando
Eliminando: Excluindo
Movimento: Mudança

EmailServicesListVerifiedExchangeOnlineDomainsResponse
EmailServicesProvisioningState

Estado de provisionamento do recurso.
KnownEmailServicesProvisioningState pode ser usado de forma intercambiável com EmailServicesProvisioningState, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

Desconhecido: Desconhecido
Sucesso: Sucessor
Falha: Falha
Cancelado: Cancelado
Correndo: Correndo
Criando: Criando
Atualizando: Atualizando
Eliminando: Excluindo
Movimento: Mudança

KeyType

O keyType a ser regenerado. Deve ser 'primário' ou 'secundário'(não diferencia maiúsculas de minúsculas).

ManagedServiceIdentityType

Tipo de identidade de serviço gerenciado (em que os tipos SystemAssigned e UserAssigned são permitidos).
KnownManagedServiceIdentityType pode ser usado de forma intercambiável com ManagedServiceIdentityType, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

Nenhum: nenhuma identidade gerenciada.
SystemAssigned: identidade gerenciada atribuída pelo sistema.
UserAssigned: identidade gerenciada atribuída pelo usuário.
SystemAssigned,UserAssigned: identidade gerenciada atribuída pelo sistema e pelo usuário.

Origin

O executor pretendido da operação; como no RBAC (Controle de Acesso Baseado em Recursos) e na experiência do usuário dos logs de auditoria. O valor padrão é "user,system"
KnownOrigin pode ser usado de forma intercambiável com a Origem, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

usuário: indica que a operação é iniciada por um usuário.
sistema: indica que a operação é iniciada por um sistema.
usuário,do sistema: indica que a operação é iniciada por um usuário ou sistema.

ProvisioningState

Estado de provisionamento do recurso. Desconhecido é o estado padrão para Serviços de Comunicação.
KnownProvisioningState pode ser usado de forma intercambiável com ProvisioningState, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

Desconhecido: Desconhecido
Sucesso: Sucessor
Falha: Falha
Cancelado: Cancelado
Correndo: Correndo
Criando: Criando
Atualizando: Atualizando
Eliminando: Excluindo
Movimento: Mudança

PublicNetworkAccess

Permitir, proibir ou permitir que a configuração do perímetro de segurança de rede controle o acesso à rede pública ao recurso protegido. O valor é opcional, mas se passado, deve ser 'Habilitado', 'Desabilitado' ou 'SecuredByPerimeter'.
KnownPublicNetworkAccess pode ser usado 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

Ativado: Permite acesso público à rede ao recurso
Desativado: Impede o acesso da rede pública ao recurso
SecuredByPerimeter: As regras de configuração do perímetro de segurança da rede permitem ou não o acesso público da rede ao recurso. Requer um perímetro de segurança de rede associado.

UserEngagementTracking

Descreve se o controle de envolvimento do usuário está habilitado ou desabilitado.
KnownUserEngagementTracking pode ser usada de forma intercambiável com UserEngagementTracking, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

Deficiente: Deficiente
Ativado: ativado

VerificationStatus

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

Valores conhecidos compatíveis com o serviço

NãoIniciado: NãoComeçado
VerificaçãoSolicitada: VerificaçãoSolicitada
VerificaçãoEm Progresso: VerificaçãoEm Progresso
VerificaçãoFalhada: VerificaçãoFalhada
Verificado: Verificado
CancelamentoSolicitado: CancelamentoSolicitado

VerificationType

Tipo de verificação.
KnownVerificationType pode ser usado de forma intercambiável com VerificationType, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

Domínio: Domínio
FPS: FPS
DKIM: DKIM
DKIM2: DKIM2
DMARC: DMARC

Enumerações

AzureClouds

Um enum para descrever ambientes de nuvem Azure.

KnownActionType

Enumeração extensível. Indica o tipo de ação. "Interno" refere-se a ações que são apenas para APIs internas.

KnownCheckNameAvailabilityReason

Possíveis motivos para um nome não estar disponível.

KnownCommunicationServicesProvisioningState

Estado de provisionamento do recurso.

KnownCreatedByType

O tipo de entidade que criou o recurso.

KnownDomainManagement

Descreve como um recurso de Domínios está sendo gerenciado.

KnownDomainsProvisioningState

Estado de provisionamento do recurso.

KnownEmailServicesProvisioningState

Estado de provisionamento do recurso.

KnownManagedServiceIdentityType

Tipo de identidade de serviço gerenciado (em que os tipos SystemAssigned e UserAssigned são permitidos).

KnownOrigin

O executor pretendido da operação; como no RBAC (Controle de Acesso Baseado em Recursos) e na experiência do usuário dos logs de auditoria. O valor padrão é "user,system"

KnownProvisioningState

Estado de provisionamento do recurso. Desconhecido é o estado padrão para Serviços de Comunicação.

KnownPublicNetworkAccess

Permitir, proibir ou permitir que a configuração do perímetro de segurança de rede controle o acesso à rede pública ao recurso protegido. O valor é opcional, mas se passado, deve ser 'Habilitado', 'Desabilitado' ou 'SecuredByPerimeter'.

KnownUserEngagementTracking

Descreve se o controle de envolvimento do usuário está habilitado ou desabilitado.

KnownVerificationStatus

Status da operação de verificação.

KnownVerificationType

Tipo de verificação.

KnownVersions

As versões de API disponíveis.

Funções

restorePoller<TResponse, TResult>(CommunicationServiceManagementClient, 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.

Detalhes da função

restorePoller<TResponse, TResult>(CommunicationServiceManagementClient, 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: CommunicationServiceManagementClient, 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>