@azure/arm-communication 4.0.0-beta.3 → 4.0.0

package/types/arm-communication.d.ts

@@ -1,8 +1,8 @@
 import * as coreAuth from '@azure/core-auth';
 import * as coreClient from '@azure/core-client';
+import { OperationState } from '@azure/core-lro';
 import { PagedAsyncIterableIterator } from '@azure/core-paging';
-import { PollerLike } from '@azure/core-lro';
-import { PollOperationState } from '@azure/core-lro';
+import { SimplePollerLike } from '@azure/core-lro';
 
 /**
  * Defines values for ActionType. \
@@ -60,7 +60,7 @@ export declare class CommunicationServiceManagementClient extends coreClient.Ser
     /**
      * Initializes a new instance of the CommunicationServiceManagementClient class.
      * @param credentials Subscription credentials which uniquely identify client subscription.
-     * @param subscriptionId The ID of the target subscription.
+     * @param subscriptionId The ID of the target subscription. The value must be an UUID.
      * @param options The parameter options
      */
     constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: CommunicationServiceManagementClientOptionalParams);
@@ -70,6 +70,7 @@ export declare class CommunicationServiceManagementClient extends coreClient.Ser
     communicationServices: CommunicationServices;
     domains: Domains;
     emailServices: EmailServices;
+    senderUsernames: SenderUsernames;
 }
 
 /** Optional parameters. */
@@ -165,15 +166,7 @@ export declare interface CommunicationServices {
      * @param parameters Parameters for the update operation
      * @param options The options parameters.
      */
-    beginUpdate(resourceGroupName: string, communicationServiceName: string, parameters: CommunicationServiceResourceUpdate, options?: CommunicationServicesUpdateOptionalParams): Promise<PollerLike<PollOperationState<CommunicationServicesUpdateResponse>, CommunicationServicesUpdateResponse>>;
-    /**
-     * Operation to update an existing CommunicationService.
-     * @param resourceGroupName The name of the resource group. The name is case insensitive.
-     * @param communicationServiceName The name of the CommunicationService resource.
-     * @param parameters Parameters for the update operation
-     * @param options The options parameters.
-     */
-    beginUpdateAndWait(resourceGroupName: string, communicationServiceName: string, parameters: CommunicationServiceResourceUpdate, options?: CommunicationServicesUpdateOptionalParams): Promise<CommunicationServicesUpdateResponse>;
+    update(resourceGroupName: string, communicationServiceName: string, parameters: CommunicationServiceResourceUpdate, options?: CommunicationServicesUpdateOptionalParams): Promise<CommunicationServicesUpdateResponse>;
     /**
      * Get the CommunicationService and its properties.
      * @param resourceGroupName The name of the resource group. The name is case insensitive.
@@ -188,7 +181,7 @@ export declare interface CommunicationServices {
      * @param parameters Parameters for the create or update operation
      * @param options The options parameters.
      */
-    beginCreateOrUpdate(resourceGroupName: string, communicationServiceName: string, parameters: CommunicationServiceResource, options?: CommunicationServicesCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<CommunicationServicesCreateOrUpdateResponse>, CommunicationServicesCreateOrUpdateResponse>>;
+    beginCreateOrUpdate(resourceGroupName: string, communicationServiceName: string, parameters: CommunicationServiceResource, options?: CommunicationServicesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<CommunicationServicesCreateOrUpdateResponse>, CommunicationServicesCreateOrUpdateResponse>>;
     /**
      * Create a new CommunicationService or update an existing CommunicationService.
      * @param resourceGroupName The name of the resource group. The name is case insensitive.
@@ -203,7 +196,7 @@ export declare interface CommunicationServices {
      * @param communicationServiceName The name of the CommunicationService resource.
      * @param options The options parameters.
      */
-    beginDelete(resourceGroupName: string, communicationServiceName: string, options?: CommunicationServicesDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>;
+    beginDelete(resourceGroupName: string, communicationServiceName: string, options?: CommunicationServicesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
     /**
      * Operation to delete a CommunicationService.
      * @param resourceGroupName The name of the resource group. The name is case insensitive.
@@ -226,16 +219,7 @@ export declare interface CommunicationServices {
      * @param parameters Parameter that describes the Regenerate Key Operation.
      * @param options The options parameters.
      */
-    beginRegenerateKey(resourceGroupName: string, communicationServiceName: string, parameters: RegenerateKeyParameters, options?: CommunicationServicesRegenerateKeyOptionalParams): Promise<PollerLike<PollOperationState<CommunicationServicesRegenerateKeyResponse>, CommunicationServicesRegenerateKeyResponse>>;
-    /**
-     * Regenerate CommunicationService access key. PrimaryKey and SecondaryKey cannot be regenerated at the
-     * same time.
-     * @param resourceGroupName The name of the resource group. The name is case insensitive.
-     * @param communicationServiceName The name of the CommunicationService resource.
-     * @param parameters Parameter that describes the Regenerate Key Operation.
-     * @param options The options parameters.
-     */
-    beginRegenerateKeyAndWait(resourceGroupName: string, communicationServiceName: string, parameters: RegenerateKeyParameters, options?: CommunicationServicesRegenerateKeyOptionalParams): Promise<CommunicationServicesRegenerateKeyResponse>;
+    regenerateKey(resourceGroupName: string, communicationServiceName: string, parameters: RegenerateKeyParameters, options?: CommunicationServicesRegenerateKeyOptionalParams): Promise<CommunicationServicesRegenerateKeyResponse>;
 }
 
 /** Optional parameters. */
@@ -346,27 +330,13 @@ export declare type CommunicationServicesProvisioningState = string;
 
 /** Optional parameters. */
 export declare interface CommunicationServicesRegenerateKeyOptionalParams extends coreClient.OperationOptions {
-    /** Delay to wait until next poll, in milliseconds. */
-    updateIntervalInMs?: number;
-    /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
-    resumeFrom?: string;
 }
 
 /** Contains response data for the regenerateKey operation. */
 export declare type CommunicationServicesRegenerateKeyResponse = CommunicationServiceKeys;
 
-/** Defines headers for CommunicationServices_update operation. */
-export declare interface CommunicationServicesUpdateHeaders {
-    /** URL to query for status of the operation. */
-    azureAsyncOperation?: string;
-}
-
 /** Optional parameters. */
 export declare interface CommunicationServicesUpdateOptionalParams extends coreClient.OperationOptions {
-    /** Delay to wait until next poll, in milliseconds. */
-    updateIntervalInMs?: number;
-    /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
-    resumeFrom?: string;
 }
 
 /** Contains response data for the update operation. */
@@ -481,10 +451,6 @@ export declare interface DomainResource extends TrackedResource {
      * NOTE: This property will not be serialized. It can only be populated by the server.
      */
     readonly verificationRecords?: DomainPropertiesVerificationRecords;
-    /** Collection of valid sender usernames. This is a key-value pair where key=username and value=display name. */
-    validSenderUsernames?: {
-        [propertyName: string]: string;
-    };
     /** Describes whether user engagement tracking is enabled or disabled. */
     userEngagementTracking?: UserEngagementTracking;
 }
@@ -526,7 +492,7 @@ export declare interface Domains {
      * @param parameters Parameters for the create or update operation
      * @param options The options parameters.
      */
-    beginCreateOrUpdate(resourceGroupName: string, emailServiceName: string, domainName: string, parameters: DomainResource, options?: DomainsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<DomainsCreateOrUpdateResponse>, DomainsCreateOrUpdateResponse>>;
+    beginCreateOrUpdate(resourceGroupName: string, emailServiceName: string, domainName: string, parameters: DomainResource, options?: DomainsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<DomainsCreateOrUpdateResponse>, DomainsCreateOrUpdateResponse>>;
     /**
      * Add a new Domains resource under the parent EmailService resource or update an existing Domains
      * resource.
@@ -544,7 +510,7 @@ export declare interface Domains {
      * @param domainName The name of the Domains resource.
      * @param options The options parameters.
      */
-    beginDelete(resourceGroupName: string, emailServiceName: string, domainName: string, options?: DomainsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>;
+    beginDelete(resourceGroupName: string, emailServiceName: string, domainName: string, options?: DomainsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
     /**
      * Operation to delete a Domains resource.
      * @param resourceGroupName The name of the resource group. The name is case insensitive.
@@ -561,7 +527,7 @@ export declare interface Domains {
      * @param parameters Parameters for the update operation
      * @param options The options parameters.
      */
-    beginUpdate(resourceGroupName: string, emailServiceName: string, domainName: string, parameters: UpdateDomainRequestParameters, options?: DomainsUpdateOptionalParams): Promise<PollerLike<PollOperationState<DomainsUpdateResponse>, DomainsUpdateResponse>>;
+    beginUpdate(resourceGroupName: string, emailServiceName: string, domainName: string, parameters: UpdateDomainRequestParameters, options?: DomainsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<DomainsUpdateResponse>, DomainsUpdateResponse>>;
     /**
      * Operation to update an existing Domains resource.
      * @param resourceGroupName The name of the resource group. The name is case insensitive.
@@ -579,7 +545,7 @@ export declare interface Domains {
      * @param parameters Type of verification to be initiated.
      * @param options The options parameters.
      */
-    beginInitiateVerification(resourceGroupName: string, emailServiceName: string, domainName: string, parameters: VerificationParameter, options?: DomainsInitiateVerificationOptionalParams): Promise<PollerLike<PollOperationState<DomainsInitiateVerificationResponse>, DomainsInitiateVerificationResponse>>;
+    beginInitiateVerification(resourceGroupName: string, emailServiceName: string, domainName: string, parameters: VerificationParameter, options?: DomainsInitiateVerificationOptionalParams): Promise<SimplePollerLike<OperationState<DomainsInitiateVerificationResponse>, DomainsInitiateVerificationResponse>>;
     /**
      * Initiate verification of DNS record.
      * @param resourceGroupName The name of the resource group. The name is case insensitive.
@@ -597,7 +563,7 @@ export declare interface Domains {
      * @param parameters Type of verification to be canceled.
      * @param options The options parameters.
      */
-    beginCancelVerification(resourceGroupName: string, emailServiceName: string, domainName: string, parameters: VerificationParameter, options?: DomainsCancelVerificationOptionalParams): Promise<PollerLike<PollOperationState<DomainsCancelVerificationResponse>, DomainsCancelVerificationResponse>>;
+    beginCancelVerification(resourceGroupName: string, emailServiceName: string, domainName: string, parameters: VerificationParameter, options?: DomainsCancelVerificationOptionalParams): Promise<SimplePollerLike<OperationState<DomainsCancelVerificationResponse>, DomainsCancelVerificationResponse>>;
     /**
      * Cancel verification of DNS record.
      * @param resourceGroupName The name of the resource group. The name is case insensitive.
@@ -782,7 +748,7 @@ export declare interface EmailServices {
      * @param parameters Parameters for the create or update operation
      * @param options The options parameters.
      */
-    beginCreateOrUpdate(resourceGroupName: string, emailServiceName: string, parameters: EmailServiceResource, options?: EmailServicesCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<EmailServicesCreateOrUpdateResponse>, EmailServicesCreateOrUpdateResponse>>;
+    beginCreateOrUpdate(resourceGroupName: string, emailServiceName: string, parameters: EmailServiceResource, options?: EmailServicesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<EmailServicesCreateOrUpdateResponse>, EmailServicesCreateOrUpdateResponse>>;
     /**
      * Create a new EmailService or update an existing EmailService.
      * @param resourceGroupName The name of the resource group. The name is case insensitive.
@@ -797,7 +763,7 @@ export declare interface EmailServices {
      * @param emailServiceName The name of the EmailService resource.
      * @param options The options parameters.
      */
-    beginDelete(resourceGroupName: string, emailServiceName: string, options?: EmailServicesDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>;
+    beginDelete(resourceGroupName: string, emailServiceName: string, options?: EmailServicesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
     /**
      * Operation to delete a EmailService.
      * @param resourceGroupName The name of the resource group. The name is case insensitive.
@@ -812,7 +778,7 @@ export declare interface EmailServices {
      * @param parameters Parameters for the update operation
      * @param options The options parameters.
      */
-    beginUpdate(resourceGroupName: string, emailServiceName: string, parameters: EmailServiceResourceUpdate, options?: EmailServicesUpdateOptionalParams): Promise<PollerLike<PollOperationState<EmailServicesUpdateResponse>, EmailServicesUpdateResponse>>;
+    beginUpdate(resourceGroupName: string, emailServiceName: string, parameters: EmailServiceResourceUpdate, options?: EmailServicesUpdateOptionalParams): Promise<SimplePollerLike<OperationState<EmailServicesUpdateResponse>, EmailServicesUpdateResponse>>;
     /**
      * Operation to update an existing EmailService.
      * @param resourceGroupName The name of the resource group. The name is case insensitive.
@@ -1112,6 +1078,28 @@ export declare enum KnownOrigin {
     UserSystem = "user,system"
 }
 
+/** Known values of {@link ProvisioningState} that the service accepts. */
+export declare enum KnownProvisioningState {
+    /** Unknown */
+    Unknown = "Unknown",
+    /** Succeeded */
+    Succeeded = "Succeeded",
+    /** Failed */
+    Failed = "Failed",
+    /** Canceled */
+    Canceled = "Canceled",
+    /** Running */
+    Running = "Running",
+    /** Creating */
+    Creating = "Creating",
+    /** Updating */
+    Updating = "Updating",
+    /** Deleting */
+    Deleting = "Deleting",
+    /** Moving */
+    Moving = "Moving"
+}
+
 /** Known values of {@link UserEngagementTracking} that the service accepts. */
 export declare enum KnownUserEngagementTracking {
     /** Disabled */
@@ -1266,6 +1254,27 @@ export declare type OperationsListResponse = OperationListResult;
  */
 export declare type Origin = string;
 
+/**
+ * Defines values for ProvisioningState. \
+ * {@link KnownProvisioningState} can be used interchangeably with ProvisioningState,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **Unknown** \
+ * **Succeeded** \
+ * **Failed** \
+ * **Canceled** \
+ * **Running** \
+ * **Creating** \
+ * **Updating** \
+ * **Deleting** \
+ * **Moving**
+ */
+export declare type ProvisioningState = string;
+
+/** The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location */
+export declare interface ProxyResource extends Resource {
+}
+
 /** Parameters describes the request to regenerate access keys */
 export declare interface RegenerateKeyParameters {
     /** The keyType to regenerate. Must be either 'primary' or 'secondary'(case-insensitive). */
@@ -1275,7 +1284,7 @@ export declare interface RegenerateKeyParameters {
 /** Common fields that are returned in the response for all Azure Resource Manager resources */
 export declare interface Resource {
     /**
-     * Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
+     * Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
      * NOTE: This property will not be serialized. It can only be populated by the server.
      */
     readonly id?: string;
@@ -1296,6 +1305,105 @@ export declare interface Resource {
     readonly systemData?: SystemData;
 }
 
+/** A class representing a SenderUsername resource. */
+export declare interface SenderUsernameResource extends ProxyResource {
+    /**
+     * The location where the SenderUsername resource data is stored at rest.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly dataLocation?: string;
+    /** A sender senderUsername to be used when sending emails. */
+    username?: string;
+    /** The display name for the senderUsername. */
+    displayName?: string;
+    /**
+     * Provisioning state of the resource. Unknown is the default state for Communication Services.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly provisioningState?: ProvisioningState;
+}
+
+/** A class representing a Domains SenderUsernames collection. */
+export declare interface SenderUsernameResourceCollection {
+    /** List of SenderUsernames */
+    value?: SenderUsernameResource[];
+    /** The URL the client should use to fetch the next page (per server side paging). */
+    nextLink?: string;
+}
+
+/** Interface representing a SenderUsernames. */
+export declare interface SenderUsernames {
+    /**
+     * List all valid sender usernames for a domains resource.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param emailServiceName The name of the EmailService resource.
+     * @param domainName The name of the Domains resource.
+     * @param options The options parameters.
+     */
+    listByDomains(resourceGroupName: string, emailServiceName: string, domainName: string, options?: SenderUsernamesListByDomainsOptionalParams): PagedAsyncIterableIterator<SenderUsernameResource>;
+    /**
+     * Get a valid sender username for a domains resource.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param emailServiceName The name of the EmailService resource.
+     * @param domainName The name of the Domains resource.
+     * @param senderUsername The valid sender Username.
+     * @param options The options parameters.
+     */
+    get(resourceGroupName: string, emailServiceName: string, domainName: string, senderUsername: string, options?: SenderUsernamesGetOptionalParams): Promise<SenderUsernamesGetResponse>;
+    /**
+     * Add a new SenderUsername resource under the parent Domains resource or update an existing
+     * SenderUsername resource.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param emailServiceName The name of the EmailService resource.
+     * @param domainName The name of the Domains resource.
+     * @param senderUsername The valid sender Username.
+     * @param parameters Parameters for the create or update operation
+     * @param options The options parameters.
+     */
+    createOrUpdate(resourceGroupName: string, emailServiceName: string, domainName: string, senderUsername: string, parameters: SenderUsernameResource, options?: SenderUsernamesCreateOrUpdateOptionalParams): Promise<SenderUsernamesCreateOrUpdateResponse>;
+    /**
+     * Operation to delete a SenderUsernames resource.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param emailServiceName The name of the EmailService resource.
+     * @param domainName The name of the Domains resource.
+     * @param senderUsername The valid sender Username.
+     * @param options The options parameters.
+     */
+    delete(resourceGroupName: string, emailServiceName: string, domainName: string, senderUsername: string, options?: SenderUsernamesDeleteOptionalParams): Promise<void>;
+}
+
+/** Optional parameters. */
+export declare interface SenderUsernamesCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the createOrUpdate operation. */
+export declare type SenderUsernamesCreateOrUpdateResponse = SenderUsernameResource;
+
+/** Optional parameters. */
+export declare interface SenderUsernamesDeleteOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Optional parameters. */
+export declare interface SenderUsernamesGetOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the get operation. */
+export declare type SenderUsernamesGetResponse = SenderUsernameResource;
+
+/** Optional parameters. */
+export declare interface SenderUsernamesListByDomainsNextOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the listByDomainsNext operation. */
+export declare type SenderUsernamesListByDomainsNextResponse = SenderUsernameResourceCollection;
+
+/** Optional parameters. */
+export declare interface SenderUsernamesListByDomainsOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the listByDomains operation. */
+export declare type SenderUsernamesListByDomainsResponse = SenderUsernameResourceCollection;
+
 /** Metadata pertaining to creation and last modification of the resource. */
 export declare interface SystemData {
     /** The identity that created the resource. */
@@ -1332,10 +1440,6 @@ export declare interface TrackedResource extends Resource {
 
 /** A class that describes the PATCH request parameters of a Domains resource. */
 export declare interface UpdateDomainRequestParameters extends TaggedResource {
-    /** Collection of valid sender usernames. This is a key-value pair where key=username and value=display name. */
-    validSenderUsernames?: {
-        [propertyName: string]: string;
-    };
     /** Describes whether user engagement tracking is enabled or disabled. */
     userEngagementTracking?: UserEngagementTracking;
 }

package/types/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.34.2"
+      "packageVersion": "7.34.4"
     }
   ]
 }