@azure/arm-communication package
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. |
| CommunicationServiceResource |
A class representing a CommunicationService resource. |
| CommunicationServiceResourceList |
Object that includes an array of CommunicationServices and a possible link for next set. |
| CommunicationServiceResourceUpdate |
A class representing update parameters for CommunicationService resource. |
| CommunicationServices |
Interface representing a CommunicationServices. |
| CommunicationServicesCheckNameAvailabilityOptionalParams |
Optional parameters. |
| CommunicationServicesCreateOrUpdateHeaders |
Defines headers for CommunicationServices_createOrUpdate operation. |
| CommunicationServicesCreateOrUpdateOptionalParams |
Optional parameters. |
| CommunicationServicesDeleteHeaders |
Defines headers for CommunicationServices_delete operation. |
| CommunicationServicesDeleteOptionalParams |
Optional parameters. |
| CommunicationServicesGetOptionalParams |
Optional parameters. |
| CommunicationServicesLinkNotificationHubOptionalParams |
Optional parameters. |
| CommunicationServicesListByResourceGroupNextOptionalParams |
Optional parameters. |
| CommunicationServicesListByResourceGroupOptionalParams |
Optional parameters. |
| CommunicationServicesListBySubscriptionNextOptionalParams |
Optional parameters. |
| CommunicationServicesListBySubscriptionOptionalParams |
Optional parameters. |
| CommunicationServicesListKeysOptionalParams |
Optional parameters. |
| CommunicationServicesRegenerateKeyOptionalParams |
Optional parameters. |
| CommunicationServicesUpdateOptionalParams |
Optional parameters. |
| DnsRecord |
A class that represents a VerificationStatus record. |
| DomainPropertiesVerificationRecords |
List of DnsRecord |
| DomainPropertiesVerificationStates |
List of VerificationStatusRecord |
| DomainResource |
A class representing a Domains resource. |
| DomainResourceList |
Object that includes an array of Domains resource and a possible link for next set. |
| Domains |
Interface representing a Domains. |
| DomainsCancelVerificationHeaders |
Defines headers for Domains_cancelVerification operation. |
| DomainsCancelVerificationOptionalParams |
Optional parameters. |
| DomainsCreateOrUpdateHeaders |
Defines headers for Domains_createOrUpdate operation. |
| DomainsCreateOrUpdateOptionalParams |
Optional parameters. |
| DomainsDeleteHeaders |
Defines headers for Domains_delete operation. |
| DomainsDeleteOptionalParams |
Optional parameters. |
| DomainsGetOptionalParams |
Optional parameters. |
| DomainsInitiateVerificationHeaders |
Defines headers for Domains_initiateVerification operation. |
| DomainsInitiateVerificationOptionalParams |
Optional parameters. |
| DomainsListByEmailServiceResourceNextOptionalParams |
Optional parameters. |
| DomainsListByEmailServiceResourceOptionalParams |
Optional parameters. |
| DomainsUpdateHeaders |
Defines headers for Domains_update operation. |
| DomainsUpdateOptionalParams |
Optional parameters. |
| EmailServiceResource |
A class representing an EmailService resource. |
| EmailServiceResourceList |
Object that includes an array of EmailServices and a possible link for next set. |
| EmailServiceResourceUpdate |
A class representing update parameters for EmailService resource. |
| EmailServices |
Interface representing a EmailServices. |
| EmailServicesCreateOrUpdateHeaders |
Defines headers for EmailServices_createOrUpdate operation. |
| EmailServicesCreateOrUpdateOptionalParams |
Optional parameters. |
| EmailServicesDeleteHeaders |
Defines headers for EmailServices_delete operation. |
| EmailServicesDeleteOptionalParams |
Optional parameters. |
| EmailServicesGetOptionalParams |
Optional parameters. |
| EmailServicesListByResourceGroupNextOptionalParams |
Optional parameters. |
| EmailServicesListByResourceGroupOptionalParams |
Optional parameters. |
| EmailServicesListBySubscriptionNextOptionalParams |
Optional parameters. |
| EmailServicesListBySubscriptionOptionalParams |
Optional parameters. |
| EmailServicesListVerifiedExchangeOnlineDomainsOptionalParams |
Optional parameters. |
| EmailServicesUpdateHeaders |
Defines headers for EmailServices_update operation. |
| 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. (This also follows the OData error response format.). |
| 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 this particular operation. |
| OperationListResult |
A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results. |
| Operations |
Interface representing a Operations. |
| OperationsListNextOptionalParams |
Optional parameters. |
| OperationsListOptionalParams |
Optional parameters. |
| 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 |
| SenderUsernameResource |
A class representing a SenderUsername resource. |
| SenderUsernameResourceCollection |
A class representing a Domains SenderUsernames collection. |
| SenderUsernames |
Interface representing a SenderUsernames. |
| SenderUsernamesCreateOrUpdateOptionalParams |
Optional parameters. |
| SenderUsernamesDeleteOptionalParams |
Optional parameters. |
| SenderUsernamesGetOptionalParams |
Optional parameters. |
| SenderUsernamesListByDomainsNextOptionalParams |
Optional parameters. |
| SenderUsernamesListByDomainsOptionalParams |
Optional parameters. |
| 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' |
| 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 |
Defines values for ActionType. Known values supported by the serviceInternal |
| CheckNameAvailabilityReason |
Defines values for CheckNameAvailabilityReason. Known values supported by the serviceInvalid |
| CommunicationServicesCheckNameAvailabilityResponse |
Contains response data for the checkNameAvailability operation. |
| CommunicationServicesCreateOrUpdateResponse |
Contains response data for the createOrUpdate operation. |
| CommunicationServicesGetResponse |
Contains response data for the get operation. |
| CommunicationServicesLinkNotificationHubResponse |
Contains response data for the linkNotificationHub operation. |
| CommunicationServicesListByResourceGroupNextResponse |
Contains response data for the listByResourceGroupNext operation. |
| CommunicationServicesListByResourceGroupResponse |
Contains response data for the listByResourceGroup operation. |
| CommunicationServicesListBySubscriptionNextResponse |
Contains response data for the listBySubscriptionNext operation. |
| CommunicationServicesListBySubscriptionResponse |
Contains response data for the listBySubscription operation. |
| CommunicationServicesListKeysResponse |
Contains response data for the listKeys operation. |
| CommunicationServicesProvisioningState |
Defines values for CommunicationServicesProvisioningState. Known values supported by the serviceUnknown |
| CommunicationServicesRegenerateKeyResponse |
Contains response data for the regenerateKey operation. |
| CommunicationServicesUpdateResponse |
Contains response data for the update operation. |
| CreatedByType |
Defines values for CreatedByType. Known values supported by the serviceUser |
| DomainManagement |
Defines values for DomainManagement. Known values supported by the serviceAzureManaged |
| DomainsCancelVerificationResponse |
Contains response data for the cancelVerification operation. |
| DomainsCreateOrUpdateResponse |
Contains response data for the createOrUpdate operation. |
| DomainsGetResponse |
Contains response data for the get operation. |
| DomainsInitiateVerificationResponse |
Contains response data for the initiateVerification operation. |
| DomainsListByEmailServiceResourceNextResponse |
Contains response data for the listByEmailServiceResourceNext operation. |
| DomainsListByEmailServiceResourceResponse |
Contains response data for the listByEmailServiceResource operation. |
| DomainsProvisioningState |
Defines values for DomainsProvisioningState. Known values supported by the serviceUnknown |
| DomainsUpdateResponse |
Contains response data for the update operation. |
| EmailServicesCreateOrUpdateResponse |
Contains response data for the createOrUpdate operation. |
| EmailServicesGetResponse |
Contains response data for the get operation. |
| EmailServicesListByResourceGroupNextResponse |
Contains response data for the listByResourceGroupNext operation. |
| EmailServicesListByResourceGroupResponse |
Contains response data for the listByResourceGroup operation. |
| EmailServicesListBySubscriptionNextResponse |
Contains response data for the listBySubscriptionNext operation. |
| EmailServicesListBySubscriptionResponse |
Contains response data for the listBySubscription operation. |
| EmailServicesListVerifiedExchangeOnlineDomainsResponse |
Contains response data for the listVerifiedExchangeOnlineDomains operation. |
| EmailServicesProvisioningState |
Defines values for EmailServicesProvisioningState. Known values supported by the serviceUnknown |
| EmailServicesUpdateResponse |
Contains response data for the update operation. |
| KeyType |
Defines values for KeyType. |
| ManagedServiceIdentityType |
Defines values for ManagedServiceIdentityType. Known values supported by the serviceNone |
| OperationsListNextResponse |
Contains response data for the listNext operation. |
| OperationsListResponse |
Contains response data for the list operation. |
| Origin |
Defines values for Origin. Known values supported by the serviceuser |
| ProvisioningState |
Defines values for ProvisioningState. Known values supported by the serviceUnknown |
| SenderUsernamesCreateOrUpdateResponse |
Contains response data for the createOrUpdate operation. |
| SenderUsernamesGetResponse |
Contains response data for the get operation. |
| SenderUsernamesListByDomainsNextResponse |
Contains response data for the listByDomainsNext operation. |
| SenderUsernamesListByDomainsResponse |
Contains response data for the listByDomains operation. |
| UserEngagementTracking |
Defines values for UserEngagementTracking. Known values supported by the serviceDisabled |
| VerificationStatus |
Defines values for VerificationStatus. Known values supported by the serviceNotStarted |
| VerificationType |
Defines values for VerificationType. Known values supported by the serviceDomain |
Enums
Functions
| get |
Given the last |
Function Details
getContinuationToken(unknown)
Given the last .value produced by the byPage iterator,
returns a continuation token that can be used to begin paging from
that point later.
function getContinuationToken(page: unknown): string | undefined
Parameters
- page
-
unknown
An object from accessing value on the IteratorResult from a byPage iterator.
Returns
string | undefined
The continuation token that can be passed into byPage() during future calls.