@azure/arm-communication package

Classes

Interfaces

CheckNameAvailabilityRequest	The check availability request body.
CheckNameAvailabilityResponse	The check availability result.
CommunicationServiceKeys	A class representing the access keys of a CommunicationService.
CommunicationServiceManagementClientOptionalParams	Optional parameters for the client.
CommunicationServiceProperties	A class that describes the properties of the CommunicationService.
CommunicationServiceResource	A class representing a CommunicationService resource.
CommunicationServiceResourceUpdate	A class representing update parameters for CommunicationService resource.
CommunicationServiceUpdateProperties	A class that describes the properties that can be updated for CommunicationService resource.
CommunicationServicesCheckNameAvailabilityOptionalParams	Optional parameters.
CommunicationServicesCreateOrUpdateOptionalParams	Optional parameters.
CommunicationServicesDeleteOptionalParams	Optional parameters.
CommunicationServicesGetOptionalParams	Optional parameters.
CommunicationServicesLinkNotificationHubOptionalParams	Optional parameters.
CommunicationServicesListByResourceGroupOptionalParams	Optional parameters.
CommunicationServicesListBySubscriptionOptionalParams	Optional parameters.
CommunicationServicesListKeysOptionalParams	Optional parameters.
CommunicationServicesOperations	Interface representing a CommunicationServices operations.
CommunicationServicesRegenerateKeyOptionalParams	Optional parameters.
CommunicationServicesUpdateOptionalParams	Optional parameters.
DnsRecord	A class that represents a VerificationStatus record.
DomainProperties	A class that describes the properties of a Domains resource.
DomainPropertiesVerificationRecords	List of DnsRecord
DomainPropertiesVerificationStates	List of VerificationStatusRecord
DomainResource	A class representing a Domains resource.
DomainsCancelVerificationOptionalParams	Optional parameters.
DomainsCreateOrUpdateOptionalParams	Optional parameters.
DomainsDeleteOptionalParams	Optional parameters.
DomainsGetOptionalParams	Optional parameters.
DomainsInitiateVerificationOptionalParams	Optional parameters.
DomainsListByEmailServiceResourceOptionalParams	Optional parameters.
DomainsOperations	Interface representing a Domains operations.
DomainsUpdateOptionalParams	Optional parameters.
EmailServiceProperties	A class that describes the properties of the EmailService.
EmailServiceResource	A class representing an EmailService resource.
EmailServiceResourceUpdate	A class representing update parameters for EmailService resource.
EmailServicesCreateOrUpdateOptionalParams	Optional parameters.
EmailServicesDeleteOptionalParams	Optional parameters.
EmailServicesGetOptionalParams	Optional parameters.
EmailServicesListByResourceGroupOptionalParams	Optional parameters.
EmailServicesListBySubscriptionOptionalParams	Optional parameters.
EmailServicesListVerifiedExchangeOnlineDomainsOptionalParams	Optional parameters.
EmailServicesOperations	Interface representing a EmailServices operations.
EmailServicesUpdateOptionalParams	Optional parameters.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Common error response for all Azure Resource Manager APIs to return error details for failed operations.
LinkNotificationHubParameters	Description of an Azure Notification Hub to link to the communication service
LinkedNotificationHub	A notification hub that has been linked to the communication service
ManagedServiceIdentity	Managed service identity (system assigned and/or user assigned identities)
NameAvailabilityParameters	Data POST-ed to the nameAvailability action
Operation	Details of a REST API operation, returned from the Resource Provider Operations API
OperationDisplay	Localized display information for an operation.
OperationsListOptionalParams	Optional parameters.
OperationsOperations	Interface representing a Operations operations.
PageSettings	Options for the byPage method
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
RegenerateKeyParameters	Parameters describes the request to regenerate access keys
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
RestorePollerOptions
SenderUsernameProperties	A class that describes the properties of a SenderUsername resource.
SenderUsernameResource	A class representing a SenderUsername resource.
SenderUsernamesCreateOrUpdateOptionalParams	Optional parameters.
SenderUsernamesDeleteOptionalParams	Optional parameters.
SenderUsernamesGetOptionalParams	Optional parameters.
SenderUsernamesListByDomainsOptionalParams	Optional parameters.
SenderUsernamesOperations	Interface representing a SenderUsernames operations.
SimplePollerLike	A simple poller that can be used to poll a long running operation.
SmtpUsernameProperties	A class that describes the properties of a SmtpUsername resource.
SmtpUsernameResource	The object describing the smtp username resource.
SmtpUsernamesCreateOrUpdateOptionalParams	Optional parameters.
SmtpUsernamesDeleteOptionalParams	Optional parameters.
SmtpUsernamesGetOptionalParams	Optional parameters.
SmtpUsernamesListOptionalParams	Optional parameters.
SmtpUsernamesOperations	Interface representing a SmtpUsernames operations.
SuppressionListAddressProperties	A class that describes the properties of a SuppressionListAddress resource.
SuppressionListAddressResource	A object that represents a SuppressionList record.
SuppressionListAddressesCreateOrUpdateOptionalParams	Optional parameters.
SuppressionListAddressesDeleteOptionalParams	Optional parameters.
SuppressionListAddressesGetOptionalParams	Optional parameters.
SuppressionListAddressesListOptionalParams	Optional parameters.
SuppressionListAddressesOperations	Interface representing a SuppressionListAddresses operations.
SuppressionListProperties	A class that describes the properties of a SuppressionList resource.
SuppressionListResource	A class representing a SuppressionList resource.
SuppressionListsCreateOrUpdateOptionalParams	Optional parameters.
SuppressionListsDeleteOptionalParams	Optional parameters.
SuppressionListsGetOptionalParams	Optional parameters.
SuppressionListsListByDomainOptionalParams	Optional parameters.
SuppressionListsOperations	Interface representing a SuppressionLists operations.
SystemData	Metadata pertaining to creation and last modification of the resource.
TaggedResource	An ARM resource with that can accept tags
TrackedResource	The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'
UpdateDomainProperties	A class that describes the updatable properties of a Domains resource.
UpdateDomainRequestParameters	A class that describes the PATCH request parameters of a Domains resource.
UserAssignedIdentity	User assigned identity properties
VerificationParameter	Input parameter for verification APIs
VerificationStatusRecord	A class that represents a VerificationStatus record.

Type Aliases

ActionType	Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports. Known values supported by the service Internal: Actions are for internal-only APIs.
AzureSupportedClouds	The supported values for cloud setting as a string literal type
CheckNameAvailabilityReason	Possible reasons for a name not being available. KnownCheckNameAvailabilityReason can be used interchangeably with CheckNameAvailabilityReason, this enum contains the known values that the service supports. Known values supported by the service Invalid: Name is invalid. AlreadyExists: Name already exists.
CommunicationServicesProvisioningState	Provisioning state of the resource. KnownCommunicationServicesProvisioningState can be used interchangeably with CommunicationServicesProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Unknown: Unknown Succeeded: Succeeded Failed: Failed Canceled: Canceled Running: Running Creating: Creating Updating: Updating Deleting: Deleting Moving: Moving
ContinuablePage	An interface that describes a page of results.
CreatedByType	The kind of entity that created the resource. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User: The entity was created by a user. Application: The entity was created by an application. ManagedIdentity: The entity was created by a managed identity. Key: The entity was created by a key.
DomainManagement	Describes how a Domains resource is being managed. KnownDomainManagement can be used interchangeably with DomainManagement, this enum contains the known values that the service supports. Known values supported by the service AzureManaged: AzureManaged CustomerManaged: CustomerManaged CustomerManagedInExchangeOnline: CustomerManagedInExchangeOnline
DomainsProvisioningState	Provisioning state of the resource. KnownDomainsProvisioningState can be used interchangeably with DomainsProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Unknown: Unknown Succeeded: Succeeded Failed: Failed Canceled: Canceled Running: Running Creating: Creating Updating: Updating Deleting: Deleting Moving: Moving
EmailServicesListVerifiedExchangeOnlineDomainsResponse
EmailServicesProvisioningState	Provisioning state of the resource. KnownEmailServicesProvisioningState can be used interchangeably with EmailServicesProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Unknown: Unknown Succeeded: Succeeded Failed: Failed Canceled: Canceled Running: Running Creating: Creating Updating: Updating Deleting: Deleting Moving: Moving
KeyType	The keyType to regenerate. Must be either 'primary' or 'secondary'(case-insensitive).
ManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). KnownManagedServiceIdentityType can be used interchangeably with ManagedServiceIdentityType, this enum contains the known values that the service supports. Known values supported by the service None: No managed identity. SystemAssigned: System assigned managed identity. UserAssigned: User assigned managed identity. SystemAssigned,UserAssigned: System and user assigned managed identity.
Origin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports. Known values supported by the service user: Indicates the operation is initiated by a user. system: Indicates the operation is initiated by a system. user,system: Indicates the operation is initiated by a user or system.
ProvisioningState	Provisioning state of the resource. Unknown is the default state for Communication Services. KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Unknown: Unknown Succeeded: Succeeded Failed: Failed Canceled: Canceled Running: Running Creating: Creating Updating: Updating Deleting: Deleting Moving: Moving
PublicNetworkAccess	Allow, disallow, or let network security perimeter configuration control public network access to the protected resource. Value is optional but if passed in, it must be 'Enabled', 'Disabled' or 'SecuredByPerimeter'. KnownPublicNetworkAccess can be used interchangeably with PublicNetworkAccess, this enum contains the known values that the service supports. Known values supported by the service Enabled: Allows public network access to the resource Disabled: Disallows public network access to the resource SecuredByPerimeter: The network security perimeter configuration rules allow or disallow public network access to the resource. Requires an associated network security perimeter.
UserEngagementTracking	Describes whether user engagement tracking is enabled or disabled. KnownUserEngagementTracking can be used interchangeably with UserEngagementTracking, this enum contains the known values that the service supports. Known values supported by the service Disabled: Disabled Enabled: Enabled
VerificationStatus	Status of the verification operation. KnownVerificationStatus can be used interchangeably with VerificationStatus, this enum contains the known values that the service supports. Known values supported by the service NotStarted: NotStarted VerificationRequested: VerificationRequested VerificationInProgress: VerificationInProgress VerificationFailed: VerificationFailed Verified: Verified CancellationRequested: CancellationRequested
VerificationType	Type of verification. KnownVerificationType can be used interchangeably with VerificationType, this enum contains the known values that the service supports. Known values supported by the service Domain: Domain SPF: SPF DKIM: DKIM DKIM2: DKIM2 DMARC: DMARC

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownActionType	Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
KnownCheckNameAvailabilityReason	Possible reasons for a name not being available.
KnownCommunicationServicesProvisioningState	Provisioning state of the resource.
KnownCreatedByType	The kind of entity that created the resource.
KnownDomainManagement	Describes how a Domains resource is being managed.
KnownDomainsProvisioningState	Provisioning state of the resource.
KnownEmailServicesProvisioningState	Provisioning state of the resource.
KnownManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
KnownOrigin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
KnownProvisioningState	Provisioning state of the resource. Unknown is the default state for Communication Services.
KnownPublicNetworkAccess	Allow, disallow, or let network security perimeter configuration control public network access to the protected resource. Value is optional but if passed in, it must be 'Enabled', 'Disabled' or 'SecuredByPerimeter'.
KnownUserEngagementTracking	Describes whether user engagement tracking is enabled or disabled.
KnownVerificationStatus	Status of the verification operation.
KnownVerificationType	Type of verification.
KnownVersions	The available API versions.

Functions

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

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

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

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

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

Parameters

client: CommunicationServiceManagementClient

serializedState: string

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

options: RestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>

@azure/arm-communication package

Classes

Interfaces

Type Aliases

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Enums

Functions

Function Details

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

Parameters

Returns