@azure/arm-communication package

Interfaces

CheckNameAvailabilityRequest

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

CheckNameAvailabilityResponse

O resultado da verificação da disponibilidade.

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

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 as operações de um Domínio.

DomainsUpdateOptionalParams

Parâmetros opcionais.

EmailServiceProperties

Uma classe que descreve as propriedades do Serviço de Email.

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 que representa uma operação de Serviços de Email.

EmailServicesUpdateOptionalParams

Parâmetros opcionais.

ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.

ErrorDetail

O detalhe do erro.

ErrorResponse

Resposta de erro comum para todas as APIs do Azure Resource Manager para retornar 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 do serviço gerenciado (identidades atribuídas pelo sistema e/ou pelo usuário)

NameAvailabilityParameters

Dados POST-ed para a ação nameAvailability

Operation

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

OperationDisplay

Informação de visualização localizada para uma operação.

OperationsListOptionalParams

Parâmetros opcionais.

OperationsOperations

Interface que representa 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 até a conclusão e por página.

ProxyResource

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

RegenerateKeyParameters

Parâmetros descreve 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 NomeUtilizador do Remetente.

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 que representa uma operação SenderUsernames.

SimplePollerLike

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

SmtpUsernameProperties

Uma classe que descreve as propriedades de um recurso SmtpUsername.

SmtpUsernameResource

O objeto que descreve o recurso de nome de utilizador smtp.

SmtpUsernamesCreateOrUpdateOptionalParams

Parâmetros opcionais.

SmtpUsernamesDeleteOptionalParams

Parâmetros opcionais.

SmtpUsernamesGetOptionalParams

Parâmetros opcionais.

SmtpUsernamesListOptionalParams

Parâmetros opcionais.

SmtpUsernamesOperations

Interface que representa uma operação SmtpUsernames.

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 operações de SuppressionLists.

SystemData

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

TaggedResource

Um recurso ARM com que pode aceitar tags

TrackedResource

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

UpdateDomainProperties

Uma classe que descreve as propriedades atualizáveis de um recurso Domínios.

UpdateDomainRequestParameters

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

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

Enum 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, esse enum contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

interno: As ações são apenas para APIs internas.

AzureSupportedClouds

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

CheckNameAvailabilityReason

Possíveis razões para um nome não estar disponível.
KnownCheckNameAvailabilityReason pode ser usado de forma intercambiável com CheckNameAvailabilityReason, esse enum contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo 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, esse enum contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

Desconhecido: Desconhecido
Sucesso: Sucessor
Falha: Falha
Cancelado: Cancelado
Corrida: Corrida
Criando: Criando
Atualização: Atualização
Excluindo: Excluindo
Mudança: 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, esse enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo 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, esse enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

AzureManaged: AzureManaged
Gestão do Cliente: Gestão do Cliente
ClienteGerenciadoEmTrocaOnline: ClienteGeridoEmTrocaOnlineOnline

DomainsProvisioningState

Estado de provisionamento do recurso.
KnownDomainsProvisioningState pode ser usado de forma intercambiável com DomainsProvisioningState, esse enum contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

Desconhecido: Desconhecido
Sucesso: Sucessor
Falha: Falha
Cancelado: Cancelado
Corrida: Corrida
Criando: Criando
Atualização: Atualização
Excluindo: Excluindo
Mudança: Mudança

EmailServicesListVerifiedExchangeOnlineDomainsResponse
EmailServicesProvisioningState

Estado de provisionamento do recurso.
KnownEmailServicesProvisioningState possa ser usado de forma intercambiável com EmailServicesProvisioningState, esse enum contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

Desconhecido: Desconhecido
Sucesso: Sucessor
Falha: Falha
Cancelado: Cancelado
Corrida: Corrida
Criando: Criando
Atualização: Atualização
Excluindo: Excluindo
Mudança: Mudança

KeyType

O keyType para regenerar. Deve ser «primário» ou «secundário» (sem distinção entre maiúsculas e minúsculas).

ManagedServiceIdentityType

Tipo de identidade de serviço gerenciado (onde os tipos SystemAssigned e UserAssigned são permitidos).
KnownManagedServiceIdentityType pode ser usado de forma intercambiável com ManagedServiceIdentityType, esse enum contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

Nenhuma: Nenhuma identidade gerenciada.
SystemAssigned: Identidade gerenciada atribuída ao sistema.
UserAssigned: Identidade gerenciada atribuída pelo usuário.
SystemAssigned,UserAssigned: Sistema e identidade gerenciada atribuída ao usuário.

Origin

O executor pretendido da operação; como no Controle de Acesso Baseado em Recursos (RBAC) e na UX de logs de auditoria. O valor padrão é "user,system"
KnownOrigin pode ser usado de forma intercambiável com Origin, este enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo 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, sistema: Indica que a operação é iniciada por um usuário ou sistema.

ProvisioningState

Estado de provisionamento do recurso. Desconhecido é o estado padrão dos Serviços de Comunicação.
KnownProvisioningState pode ser usado de forma intercambiável com ProvisioningState, esse enum contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

Desconhecido: Desconhecido
Sucesso: Sucessor
Falha: Falha
Cancelado: Cancelado
Corrida: Corrida
Criando: Criando
Atualização: Atualização
Excluindo: Excluindo
Mudança: Mudança

PublicNetworkAccess

Permitir, não permitir ou permitir que a configuração do perímetro de segurança da rede controle o acesso da rede pública ao recurso protegido. O valor é opcional, mas se passado, deve ser 'Enabled', 'Disabled' ou 'SecuredByPerimeter'.
KnownPublicNetworkAccess pode ser usado de forma intercambiável com PublicNetworkAccess, este enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

Ativado: Permite o acesso público da 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 acompanhamento do envolvimento do usuário está habilitado ou desabilitado.
KnownUserEngagementTracking possa ser usado de forma intercambiável com UserEngagementTracking, este enum contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

Deficiente: Deficiente
Ativado: Ativado

VerificationStatus

Estado da operação de verificação.
KnownVerificationStatus pode ser usado de forma intercambiável com VerificationStatus, esse enum contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

NotStarted: NotStarted
VerificaçãoSolicitada: VerificaçãoSolicitada
VerificationInProgress: VerificationInProgress
VerificaçãoFalhada: VerificaçãoFalhada
Verificado: Verificado
CancelamentoSolicitado: CancelamentoSolicitado

VerificationType

Tipo de verificação.
KnownVerificationType pode ser usado de forma intercambiável com VerificationType, esse enum contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

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

Enumerações

AzureClouds

Um enum para descrever ambientes Azure Cloud.

KnownActionType

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

KnownCheckNameAvailabilityReason

Possíveis razões 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 (onde os tipos SystemAssigned e UserAssigned são permitidos).

KnownOrigin

O executor pretendido da operação; como no Controle de Acesso Baseado em Recursos (RBAC) e na UX de logs de auditoria. O valor padrão é "user,system"

KnownProvisioningState

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

KnownPublicNetworkAccess

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

KnownUserEngagementTracking

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

KnownVerificationStatus

Estado 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 poller a partir do estado serializado de outro poller. Isso pode ser útil quando você deseja criar pollers em um host diferente ou um poller precisa ser construído depois que o original não está no escopo.

Detalhes de Função

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

Cria um poller a partir do estado serializado de outro poller. Isso pode ser útil quando você deseja criar pollers em um host diferente ou um poller precisa ser construído depois que o original não está 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>

Devoluções

PollerLike<OperationState<TResult>, TResult>