Compartilhar via

@azure/arm-communication package

  • Referência

Classes

CommunicationServiceManagementClient

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

Uma classe que representa um recurso CommunicationService.
CommunicationServiceResourceList

Objeto que inclui uma matriz de CommunicationServices e um possível link para o próximo conjunto.
CommunicationServiceResourceUpdate

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

Interface que representa um CommunicationServices.
CommunicationServicesCheckNameAvailabilityOptionalParams

Parâmetros opcionais.
CommunicationServicesCreateOrUpdateHeaders

Define cabeçalhos para CommunicationServices_createOrUpdate operação.
CommunicationServicesCreateOrUpdateOptionalParams

Parâmetros opcionais.
CommunicationServicesDeleteHeaders

Define cabeçalhos para CommunicationServices_delete operação.
CommunicationServicesDeleteOptionalParams

Parâmetros opcionais.
CommunicationServicesGetOptionalParams

Parâmetros opcionais.
CommunicationServicesLinkNotificationHubOptionalParams

Parâmetros opcionais.
CommunicationServicesListByResourceGroupNextOptionalParams

Parâmetros opcionais.
CommunicationServicesListByResourceGroupOptionalParams

Parâmetros opcionais.
CommunicationServicesListBySubscriptionNextOptionalParams

Parâmetros opcionais.
CommunicationServicesListBySubscriptionOptionalParams

Parâmetros opcionais.
CommunicationServicesListKeysOptionalParams

Parâmetros opcionais.
CommunicationServicesRegenerateKeyOptionalParams

Parâmetros opcionais.
CommunicationServicesUpdateOptionalParams

Parâmetros opcionais.
DnsRecord

Uma classe que representa um registro VerificationStatus.
DomainPropertiesVerificationRecords

Lista de DnsRecord
DomainPropertiesVerificationStates

Lista de VerificationStatusRecord
DomainResource

Uma classe que representa um recurso de Domínios.
DomainResourceList

Objeto que inclui uma matriz de recursos de domínios e um possível link para o próximo conjunto.
Domains

Interface que representa um Domínio.
DomainsCancelVerificationHeaders

Define cabeçalhos para Domains_cancelVerification operação.
DomainsCancelVerificationOptionalParams

Parâmetros opcionais.
DomainsCreateOrUpdateHeaders

Define cabeçalhos para Domains_createOrUpdate operação.
DomainsCreateOrUpdateOptionalParams

Parâmetros opcionais.
DomainsDeleteHeaders

Define cabeçalhos para Domains_delete operação.
DomainsDeleteOptionalParams

Parâmetros opcionais.
DomainsGetOptionalParams

Parâmetros opcionais.
DomainsInitiateVerificationHeaders

Define cabeçalhos para Domains_initiateVerification operação.
DomainsInitiateVerificationOptionalParams

Parâmetros opcionais.
DomainsListByEmailServiceResourceNextOptionalParams

Parâmetros opcionais.
DomainsListByEmailServiceResourceOptionalParams

Parâmetros opcionais.
DomainsUpdateHeaders

Define cabeçalhos para Domains_update operação.
DomainsUpdateOptionalParams

Parâmetros opcionais.
EmailServiceResource

Uma classe que representa um recurso emailService.
EmailServiceResourceList

Objeto que inclui uma matriz de EmailServices e um possível link para o próximo conjunto.
EmailServiceResourceUpdate

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

Interface que representa um EmailServices.
EmailServicesCreateOrUpdateHeaders

Define cabeçalhos para EmailServices_createOrUpdate operação.
EmailServicesCreateOrUpdateOptionalParams

Parâmetros opcionais.
EmailServicesDeleteHeaders

Define cabeçalhos para EmailServices_delete operação.
EmailServicesDeleteOptionalParams

Parâmetros opcionais.
EmailServicesGetOptionalParams

Parâmetros opcionais.
EmailServicesListByResourceGroupNextOptionalParams

Parâmetros opcionais.
EmailServicesListByResourceGroupOptionalParams

Parâmetros opcionais.
EmailServicesListBySubscriptionNextOptionalParams

Parâmetros opcionais.
EmailServicesListBySubscriptionOptionalParams

Parâmetros opcionais.
EmailServicesListVerifiedExchangeOnlineDomainsOptionalParams

Parâmetros opcionais.
EmailServicesUpdateHeaders

Define cabeçalhos para EmailServices_update operação.
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. (Isso também segue o formato de resposta de erro OData.).
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 de exibição localizadas para esta operação específica.
OperationListResult

Uma lista de operações da API REST com suporte por um Provedor de Recursos do Azure. Ele contém um link de URL para obter o próximo conjunto de resultados.
Operations

Interface que representa uma operação.
OperationsListNextOptionalParams

Parâmetros opcionais.
OperationsListOptionalParams

Parâmetros opcionais.
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
SenderUsernameResource

Uma classe que representa um recurso SenderUsername.
SenderUsernameResourceCollection

Uma classe que representa uma coleção Domains SenderUsernames.
SenderUsernames

Interface que representa um SenderUsernames.
SenderUsernamesCreateOrUpdateOptionalParams

Parâmetros opcionais.
SenderUsernamesDeleteOptionalParams

Parâmetros opcionais.
SenderUsernamesGetOptionalParams

Parâmetros opcionais.
SenderUsernamesListByDomainsNextOptionalParams

Parâmetros opcionais.
SenderUsernamesListByDomainsOptionalParams

Parâmetros opcionais.
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'
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

Define valores para ActionType.
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

Interna
CheckNameAvailabilityReason

Define valores para CheckNameAvailabilityReason.
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
AlreadyExists
CommunicationServicesCheckNameAvailabilityResponse

Contém dados de resposta para a operação checkNameAvailability.
CommunicationServicesCreateOrUpdateResponse

Contém dados de resposta para a operação createOrUpdate.
CommunicationServicesGetResponse

Contém dados de resposta para a operação de obtenção.
CommunicationServicesLinkNotificationHubResponse

Contém dados de resposta para a operação linkNotificationHub.
CommunicationServicesListByResourceGroupNextResponse

Contém dados de resposta para a operação listByResourceGroupNext.
CommunicationServicesListByResourceGroupResponse

Contém dados de resposta para a operação listByResourceGroup.
CommunicationServicesListBySubscriptionNextResponse

Contém dados de resposta para a operação listBySubscriptionNext.
CommunicationServicesListBySubscriptionResponse

Contém dados de resposta para a operação listBySubscription.
CommunicationServicesListKeysResponse

Contém dados de resposta para a operação listKeys.
CommunicationServicesProvisioningState

Define valores para CommunicationServicesProvisioningState.
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
êxito
falha na
Cancelada
executando
criando
atualizando
excluindo
movendo
CommunicationServicesRegenerateKeyResponse

Contém dados de resposta para a operação regenerateKey.
CommunicationServicesUpdateResponse

Contém dados de resposta para a operação de atualização.
CreatedByType

Define valores para CreatedByType.
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

de usuário do
application
ManagedIdentity
key
DomainManagement

Define valores para DomainManagement.
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

do AzureManaged
CustomerManaged
CustomerManagedInExchangeOnline
DomainsCancelVerificationResponse

Contém dados de resposta para a operação cancelVerification.
DomainsCreateOrUpdateResponse

Contém dados de resposta para a operação createOrUpdate.
DomainsGetResponse

Contém dados de resposta para a operação de obtenção.
DomainsInitiateVerificationResponse

Contém dados de resposta para a operação initiateVerification.
DomainsListByEmailServiceResourceNextResponse

Contém dados de resposta para a operação listByEmailServiceResourceNext.
DomainsListByEmailServiceResourceResponse

Contém dados de resposta para a operação listByEmailServiceResource.
DomainsProvisioningState

Define valores para DomainsProvisioningState.
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
êxito
falha na
Cancelada
executando
criando
atualizando
excluindo
movendo
DomainsUpdateResponse

Contém dados de resposta para a operação de atualização.
EmailServicesCreateOrUpdateResponse

Contém dados de resposta para a operação createOrUpdate.
EmailServicesGetResponse

Contém dados de resposta para a operação de obtenção.
EmailServicesListByResourceGroupNextResponse

Contém dados de resposta para a operação listByResourceGroupNext.
EmailServicesListByResourceGroupResponse

Contém dados de resposta para a operação listByResourceGroup.
EmailServicesListBySubscriptionNextResponse

Contém dados de resposta para a operação listBySubscriptionNext.
EmailServicesListBySubscriptionResponse

Contém dados de resposta para a operação listBySubscription.
EmailServicesListVerifiedExchangeOnlineDomainsResponse

Contém dados de resposta para a operação listVerifiedExchangeOnlineDomains.
EmailServicesProvisioningState

Define valores para EmailServicesProvisioningState.
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
êxito
falha na
Cancelada
executando
criando
atualizando
excluindo
movendo
EmailServicesUpdateResponse

Contém dados de resposta para a operação de atualização.
KeyType

Define valores para KeyType.
ManagedServiceIdentityType

Define valores para ManagedServiceIdentityType.
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
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned
OperationsListNextResponse

Contém dados de resposta para a operação listNext.
OperationsListResponse

Contém dados de resposta para a operação de lista.
Origin

Define valores de Origem.
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
sistema
usuário, do sistema
ProvisioningState

Define valores para ProvisioningState.
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
êxito
falha na
Cancelada
executando
criando
atualizando
excluindo
movendo
SenderUsernamesCreateOrUpdateResponse

Contém dados de resposta para a operação createOrUpdate.
SenderUsernamesGetResponse

Contém dados de resposta para a operação de obtenção.
SenderUsernamesListByDomainsNextResponse

Contém dados de resposta para a operação listByDomainsNext.
SenderUsernamesListByDomainsResponse

Contém dados de resposta para a operação listByDomains.
UserEngagementTracking

Define valores para UserEngagementTracking.
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

desabilitado
habilitado
VerificationStatus

Define valores para VerificationStatus.
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

NotStarted
VerificationRequested
VerificationInProgress
com falha na verificação
verificado
CancellationRequested
VerificationType

Define valores para VerificationType.
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
do SPF
DKIM
DKIM2
DMARC

Enumerações

KnownActionType

Valores conhecidos de ActionType que o serviço aceita.
KnownCheckNameAvailabilityReason

Valores conhecidos de CheckNameAvailabilityReason que o serviço aceita.
KnownCommunicationServicesProvisioningState

Valores conhecidos de CommunicationServicesProvisioningState que o serviço aceita.
KnownCreatedByType

Valores conhecidos de CreatedByType que o serviço aceita.
KnownDomainManagement

Valores conhecidos de DomainManagement que o serviço aceita.
KnownDomainsProvisioningState

Valores conhecidos de DomainsProvisioningState que o serviço aceita.
KnownEmailServicesProvisioningState

Valores conhecidos de EmailServicesProvisioningState que o serviço aceita.
KnownManagedServiceIdentityType

Valores conhecidos de ManagedServiceIdentityType que o serviço aceita.
KnownOrigin

Valores conhecidos de Origin que o serviço aceita.
KnownProvisioningState

Valores conhecidos de ProvisioningState que o serviço aceita.
KnownUserEngagementTracking

Valores conhecidos de UserEngagementTracking que o serviço aceita.
KnownVerificationStatus

Valores conhecidos de VerificationStatus que o serviço aceita.
KnownVerificationType

Valores conhecidos de VerificationType que o serviço aceita.

Funções

getContinuationToken(unknown)

Dado o último .value produzido pelo iterador byPage, retorna um token de continuação que pode ser usado para iniciar a paginação a partir desse ponto mais tarde.

Detalhes da função

getContinuationToken(unknown)

Dado o último .value produzido pelo iterador byPage, retorna um token de continuação que pode ser usado para iniciar a paginação a partir desse ponto mais tarde.

function getContinuationToken(page: unknown): string | undefined

Parâmetros

page

unknown

Um objeto de acessar value no IteratorResult de um iterador de byPage.

Retornos

string | undefined

O token de continuação que pode ser passado para byPage() durante chamadas futuras.