@azure/arm-cognitiveservices 7.4.1-alpha.20230724.1 → 7.5.0

package/types/arm-cognitiveservices.d.ts

@@ -1,8 +1,28 @@
 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';
+
+/** The abuse penalty. */
+export declare interface AbusePenalty {
+    /** The action of AbusePenalty. */
+    action?: AbusePenaltyAction;
+    /** The percentage of rate limit. */
+    rateLimitPercentage?: number;
+    /** The datetime of expiration of the AbusePenalty. */
+    expiration?: Date;
+}
+
+/**
+ * Defines values for AbusePenaltyAction. \
+ * {@link KnownAbusePenaltyAction} can be used interchangeably with AbusePenaltyAction,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **Throttle** \
+ * **Block**
+ */
+export declare type AbusePenaltyAction = string;
 
 /** Cognitive Services account is an Azure resource representing the provisioned account, it's type, location and SKU. */
 export declare interface Account extends AzureEntityResource {
@@ -42,6 +62,10 @@ export declare interface AccountListResult {
 export declare interface AccountModel extends DeploymentModel {
     /** Base Model Identifier. */
     baseModel?: DeploymentModel;
+    /** If the model is default version. */
+    isDefaultVersion?: boolean;
+    /** The list of Model Sku. */
+    skus?: ModelSku[];
     /** The max capacity. */
     maxCapacity?: number;
     /** The capabilities. */
@@ -164,6 +188,11 @@ export declare interface AccountProperties {
      * NOTE: This property will not be serialized. It can only be populated by the server.
      */
     readonly commitmentPlanAssociations?: CommitmentPlanAssociation[];
+    /**
+     * The abuse penalty.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly abusePenalty?: AbusePenalty;
 }
 
 /** Interface representing a Accounts. */
@@ -194,7 +223,7 @@ export declare interface Accounts {
      * @param account The parameters to provide for the created account.
      * @param options The options parameters.
      */
-    beginCreate(resourceGroupName: string, accountName: string, account: Account, options?: AccountsCreateOptionalParams): Promise<PollerLike<PollOperationState<AccountsCreateResponse>, AccountsCreateResponse>>;
+    beginCreate(resourceGroupName: string, accountName: string, account: Account, options?: AccountsCreateOptionalParams): Promise<SimplePollerLike<OperationState<AccountsCreateResponse>, AccountsCreateResponse>>;
     /**
      * Create Cognitive Services Account. Accounts is a resource group wide resource type. It holds the
      * keys for developer to access intelligent APIs. It's also the resource type for billing.
@@ -211,7 +240,7 @@ export declare interface Accounts {
      * @param account The parameters to provide for the created account.
      * @param options The options parameters.
      */
-    beginUpdate(resourceGroupName: string, accountName: string, account: Account, options?: AccountsUpdateOptionalParams): Promise<PollerLike<PollOperationState<AccountsUpdateResponse>, AccountsUpdateResponse>>;
+    beginUpdate(resourceGroupName: string, accountName: string, account: Account, options?: AccountsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<AccountsUpdateResponse>, AccountsUpdateResponse>>;
     /**
      * Updates a Cognitive Services account
      * @param resourceGroupName The name of the resource group. The name is case insensitive.
@@ -226,7 +255,7 @@ export declare interface Accounts {
      * @param accountName The name of Cognitive Services account.
      * @param options The options parameters.
      */
-    beginDelete(resourceGroupName: string, accountName: string, options?: AccountsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>;
+    beginDelete(resourceGroupName: string, accountName: string, options?: AccountsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
     /**
      * Deletes a Cognitive Services account from the resource group.
      * @param resourceGroupName The name of the resource group. The name is case insensitive.
@@ -456,6 +485,18 @@ export declare interface CallRateLimit {
     rules?: ThrottlingRule[];
 }
 
+/** The capacity configuration. */
+export declare interface CapacityConfig {
+    /** The minimum capacity. */
+    minimum?: number;
+    /** The maximum capacity. */
+    maximum?: number;
+    /** The minimal incremental between allowed values for capacity. */
+    step?: number;
+    /** The default capacity. */
+    default?: number;
+}
+
 /** Optional parameters. */
 export declare interface CheckDomainAvailabilityOptionalParams extends coreClient.OperationOptions {
     /** The Kind of the resource. */
@@ -524,8 +565,10 @@ export declare class CognitiveServicesManagementClient extends coreClient.Servic
     accounts: Accounts;
     deletedAccounts: DeletedAccounts;
     resourceSkus: ResourceSkus;
+    usages: Usages;
     operations: Operations;
     commitmentTiers: CommitmentTiers;
+    models: Models;
     privateEndpointConnections: PrivateEndpointConnections;
     privateLinkResources: PrivateLinkResources;
     deployments: Deployments;
@@ -669,6 +712,11 @@ export declare interface CommitmentPlanProperties {
      * NOTE: This property will not be serialized. It can only be populated by the server.
      */
     readonly last?: CommitmentPeriod;
+    /**
+     * The list of ProvisioningIssue.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly provisioningIssues?: string[];
 }
 
 /**
@@ -741,7 +789,7 @@ export declare interface CommitmentPlans {
      *                           Account
      * @param options The options parameters.
      */
-    beginDelete(resourceGroupName: string, accountName: string, commitmentPlanName: string, options?: CommitmentPlansDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>;
+    beginDelete(resourceGroupName: string, accountName: string, commitmentPlanName: string, options?: CommitmentPlansDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
     /**
      * Deletes the specified commitmentPlan associated with the Cognitive Services account.
      * @param resourceGroupName The name of the resource group. The name is case insensitive.
@@ -759,7 +807,7 @@ export declare interface CommitmentPlans {
      * @param commitmentPlan The parameters to provide for the created commitment plan.
      * @param options The options parameters.
      */
-    beginCreateOrUpdatePlan(resourceGroupName: string, commitmentPlanName: string, commitmentPlan: CommitmentPlan, options?: CommitmentPlansCreateOrUpdatePlanOptionalParams): Promise<PollerLike<PollOperationState<CommitmentPlansCreateOrUpdatePlanResponse>, CommitmentPlansCreateOrUpdatePlanResponse>>;
+    beginCreateOrUpdatePlan(resourceGroupName: string, commitmentPlanName: string, commitmentPlan: CommitmentPlan, options?: CommitmentPlansCreateOrUpdatePlanOptionalParams): Promise<SimplePollerLike<OperationState<CommitmentPlansCreateOrUpdatePlanResponse>, CommitmentPlansCreateOrUpdatePlanResponse>>;
     /**
      * Create Cognitive Services commitment plan.
      * @param resourceGroupName The name of the resource group. The name is case insensitive.
@@ -777,7 +825,7 @@ export declare interface CommitmentPlans {
      * @param commitmentPlan The parameters to provide for the created commitment plan.
      * @param options The options parameters.
      */
-    beginUpdatePlan(resourceGroupName: string, commitmentPlanName: string, commitmentPlan: PatchResourceTagsAndSku, options?: CommitmentPlansUpdatePlanOptionalParams): Promise<PollerLike<PollOperationState<CommitmentPlansUpdatePlanResponse>, CommitmentPlansUpdatePlanResponse>>;
+    beginUpdatePlan(resourceGroupName: string, commitmentPlanName: string, commitmentPlan: PatchResourceTagsAndSku, options?: CommitmentPlansUpdatePlanOptionalParams): Promise<SimplePollerLike<OperationState<CommitmentPlansUpdatePlanResponse>, CommitmentPlansUpdatePlanResponse>>;
     /**
      * Create Cognitive Services commitment plan.
      * @param resourceGroupName The name of the resource group. The name is case insensitive.
@@ -794,7 +842,7 @@ export declare interface CommitmentPlans {
      *                           Account
      * @param options The options parameters.
      */
-    beginDeletePlan(resourceGroupName: string, commitmentPlanName: string, options?: CommitmentPlansDeletePlanOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>;
+    beginDeletePlan(resourceGroupName: string, commitmentPlanName: string, options?: CommitmentPlansDeletePlanOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
     /**
      * Deletes a Cognitive Services commitment plan from the resource group.
      * @param resourceGroupName The name of the resource group. The name is case insensitive.
@@ -831,7 +879,7 @@ export declare interface CommitmentPlans {
      * @param association The commitmentPlan properties.
      * @param options The options parameters.
      */
-    beginCreateOrUpdateAssociation(resourceGroupName: string, commitmentPlanName: string, commitmentPlanAssociationName: string, association: CommitmentPlanAccountAssociation, options?: CommitmentPlansCreateOrUpdateAssociationOptionalParams): Promise<PollerLike<PollOperationState<CommitmentPlansCreateOrUpdateAssociationResponse>, CommitmentPlansCreateOrUpdateAssociationResponse>>;
+    beginCreateOrUpdateAssociation(resourceGroupName: string, commitmentPlanName: string, commitmentPlanAssociationName: string, association: CommitmentPlanAccountAssociation, options?: CommitmentPlansCreateOrUpdateAssociationOptionalParams): Promise<SimplePollerLike<OperationState<CommitmentPlansCreateOrUpdateAssociationResponse>, CommitmentPlansCreateOrUpdateAssociationResponse>>;
     /**
      * Create or update the association of the Cognitive Services commitment plan.
      * @param resourceGroupName The name of the resource group. The name is case insensitive.
@@ -852,7 +900,7 @@ export declare interface CommitmentPlans {
      *                                      Services Account
      * @param options The options parameters.
      */
-    beginDeleteAssociation(resourceGroupName: string, commitmentPlanName: string, commitmentPlanAssociationName: string, options?: CommitmentPlansDeleteAssociationOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>;
+    beginDeleteAssociation(resourceGroupName: string, commitmentPlanName: string, commitmentPlanAssociationName: string, options?: CommitmentPlansDeleteAssociationOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
     /**
      * Deletes the association of the Cognitive Services commitment plan.
      * @param resourceGroupName The name of the resource group. The name is case insensitive.
@@ -1118,7 +1166,7 @@ export declare interface DeletedAccounts {
      * @param accountName The name of Cognitive Services account.
      * @param options The options parameters.
      */
-    beginPurge(location: string, resourceGroupName: string, accountName: string, options?: DeletedAccountsPurgeOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>;
+    beginPurge(location: string, resourceGroupName: string, accountName: string, options?: DeletedAccountsPurgeOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
     /**
      * Deletes a Cognitive Services account from the resource group.
      * @param location Resource location.
@@ -1160,6 +1208,8 @@ export declare interface DeletedAccountsPurgeOptionalParams extends coreClient.O
 
 /** Cognitive Services account deployment. */
 export declare interface Deployment extends ProxyResource {
+    /** The resource model definition representing SKU */
+    sku?: Sku;
     /**
      * Metadata pertaining to creation and last modification of the resource.
      * NOTE: This property will not be serialized. It can only be populated by the server.
@@ -1191,8 +1241,10 @@ export declare interface DeploymentModel {
     format?: string;
     /** Deployment model name. */
     name?: string;
-    /** Deployment model version. */
+    /** Optional. Deployment model version. If version is not specified, a default version will be assigned. The default version is different for different models and might change when there is new version available for a model. Default version for a model could be found from list models API. */
     version?: string;
+    /** Optional. Deployment model source ARM resource ID. */
+    source?: string;
     /**
      * The call rate limit Cognitive Services account.
      * NOTE: This property will not be serialized. It can only be populated by the server.
@@ -1200,6 +1252,17 @@ export declare interface DeploymentModel {
     readonly callRateLimit?: CallRateLimit;
 }
 
+/**
+ * Defines values for DeploymentModelVersionUpgradeOption. \
+ * {@link KnownDeploymentModelVersionUpgradeOption} can be used interchangeably with DeploymentModelVersionUpgradeOption,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **OnceNewDefaultVersionAvailable** \
+ * **OnceCurrentVersionExpired** \
+ * **NoAutoUpgrade**
+ */
+export declare type DeploymentModelVersionUpgradeOption = string;
+
 /** Properties of Cognitive Services account deployment. */
 export declare interface DeploymentProperties {
     /**
@@ -1225,6 +1288,10 @@ export declare interface DeploymentProperties {
      * NOTE: This property will not be serialized. It can only be populated by the server.
      */
     readonly callRateLimit?: CallRateLimit;
+    /** NOTE: This property will not be serialized. It can only be populated by the server. */
+    readonly rateLimits?: ThrottlingRule[];
+    /** Deployment model version upgrade option. */
+    versionUpgradeOption?: DeploymentModelVersionUpgradeOption;
 }
 
 /**
@@ -1237,7 +1304,9 @@ export declare interface DeploymentProperties {
  * **Deleting** \
  * **Moving** \
  * **Failed** \
- * **Succeeded**
+ * **Succeeded** \
+ * **Disabled** \
+ * **Canceled**
  */
 export declare type DeploymentProvisioningState = string;
 
@@ -1266,7 +1335,7 @@ export declare interface Deployments {
      * @param deployment The deployment properties.
      * @param options The options parameters.
      */
-    beginCreateOrUpdate(resourceGroupName: string, accountName: string, deploymentName: string, deployment: Deployment, options?: DeploymentsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<DeploymentsCreateOrUpdateResponse>, DeploymentsCreateOrUpdateResponse>>;
+    beginCreateOrUpdate(resourceGroupName: string, accountName: string, deploymentName: string, deployment: Deployment, options?: DeploymentsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<DeploymentsCreateOrUpdateResponse>, DeploymentsCreateOrUpdateResponse>>;
     /**
      * Update the state of specified deployments associated with the Cognitive Services account.
      * @param resourceGroupName The name of the resource group. The name is case insensitive.
@@ -1283,7 +1352,7 @@ export declare interface Deployments {
      * @param deploymentName The name of the deployment associated with the Cognitive Services Account
      * @param options The options parameters.
      */
-    beginDelete(resourceGroupName: string, accountName: string, deploymentName: string, options?: DeploymentsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>;
+    beginDelete(resourceGroupName: string, accountName: string, deploymentName: string, options?: DeploymentsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
     /**
      * Deletes the specified deployment associated with the Cognitive Services account.
      * @param resourceGroupName The name of the resource group. The name is case insensitive.
@@ -1444,7 +1513,8 @@ export declare function getContinuationToken(page: unknown): string | undefined;
  * ### Known values supported by the service
  * **Web** \
  * **ConnectedContainer** \
- * **DisconnectedContainer**
+ * **DisconnectedContainer** \
+ * **ProvisionedWeb**
  */
 export declare type HostingModel = string;
 
@@ -1498,6 +1568,14 @@ export declare interface KeyVaultProperties {
     identityClientId?: string;
 }
 
+/** Known values of {@link AbusePenaltyAction} that the service accepts. */
+export declare enum KnownAbusePenaltyAction {
+    /** Throttle */
+    Throttle = "Throttle",
+    /** Block */
+    Block = "Block"
+}
+
 /** Known values of {@link ActionType} that the service accepts. */
 export declare enum KnownActionType {
     /** Internal */
@@ -1534,6 +1612,16 @@ export declare enum KnownCreatedByType {
     Key = "Key"
 }
 
+/** Known values of {@link DeploymentModelVersionUpgradeOption} that the service accepts. */
+export declare enum KnownDeploymentModelVersionUpgradeOption {
+    /** OnceNewDefaultVersionAvailable */
+    OnceNewDefaultVersionAvailable = "OnceNewDefaultVersionAvailable",
+    /** OnceCurrentVersionExpired */
+    OnceCurrentVersionExpired = "OnceCurrentVersionExpired",
+    /** NoAutoUpgrade */
+    NoAutoUpgrade = "NoAutoUpgrade"
+}
+
 /** Known values of {@link DeploymentProvisioningState} that the service accepts. */
 export declare enum KnownDeploymentProvisioningState {
     /** Accepted */
@@ -1547,7 +1635,11 @@ export declare enum KnownDeploymentProvisioningState {
     /** Failed */
     Failed = "Failed",
     /** Succeeded */
-    Succeeded = "Succeeded"
+    Succeeded = "Succeeded",
+    /** Disabled */
+    Disabled = "Disabled",
+    /** Canceled */
+    Canceled = "Canceled"
 }
 
 /** Known values of {@link DeploymentScaleType} that the service accepts. */
@@ -1565,7 +1657,9 @@ export declare enum KnownHostingModel {
     /** ConnectedContainer */
     ConnectedContainer = "ConnectedContainer",
     /** DisconnectedContainer */
-    DisconnectedContainer = "DisconnectedContainer"
+    DisconnectedContainer = "DisconnectedContainer",
+    /** ProvisionedWeb */
+    ProvisionedWeb = "ProvisionedWeb"
 }
 
 /** Known values of {@link KeySource} that the service accepts. */
@@ -1720,6 +1814,16 @@ export declare interface MetricName {
     localizedValue?: string;
 }
 
+/** Cognitive Services Model. */
+export declare interface Model {
+    /** Model Metadata. */
+    model?: AccountModel;
+    /** The Kind of the Model. */
+    kind?: string;
+    /** The SKU of the Model. */
+    skuName?: string;
+}
+
 /** Cognitive Services account ModelDeprecationInfo. */
 export declare interface ModelDeprecationInfo {
     /** The datetime of deprecation of the fineTune Model. */
@@ -1738,6 +1842,52 @@ export declare interface ModelDeprecationInfo {
  */
 export declare type ModelLifecycleStatus = string;
 
+/** The list of cognitive services models. */
+export declare interface ModelListResult {
+    /** The link used to get the next page of Model. */
+    nextLink?: string;
+    /** Gets the list of Cognitive Services accounts Model and their properties. */
+    value?: Model[];
+}
+
+/** Interface representing a Models. */
+export declare interface Models {
+    /**
+     * List Models.
+     * @param location Resource location.
+     * @param options The options parameters.
+     */
+    list(location: string, options?: ModelsListOptionalParams): PagedAsyncIterableIterator<Model>;
+}
+
+/** Describes an available Cognitive Services Model SKU. */
+export declare interface ModelSku {
+    /** The name of the model SKU. */
+    name?: string;
+    /** The usage name of the model SKU. */
+    usageName?: string;
+    /** The datetime of deprecation of the model SKU. */
+    deprecationDate?: Date;
+    /** The capacity configuration. */
+    capacity?: CapacityConfig;
+    /** The list of rateLimit. */
+    rateLimits?: CallRateLimit[];
+}
+
+/** Optional parameters. */
+export declare interface ModelsListNextOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the listNext operation. */
+export declare type ModelsListNextResponse = ModelListResult;
+
+/** Optional parameters. */
+export declare interface ModelsListOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the list operation. */
+export declare type ModelsListResponse = ModelListResult;
+
 /** The multiregion settings Cognitive Services account. */
 export declare interface MultiRegionSettings {
     /** Multiregion routing methods. */
@@ -1960,7 +2110,7 @@ export declare interface PrivateEndpointConnections {
      * @param properties The private endpoint connection properties.
      * @param options The options parameters.
      */
-    beginCreateOrUpdate(resourceGroupName: string, accountName: string, privateEndpointConnectionName: string, properties: PrivateEndpointConnection, options?: PrivateEndpointConnectionsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<PrivateEndpointConnectionsCreateOrUpdateResponse>, PrivateEndpointConnectionsCreateOrUpdateResponse>>;
+    beginCreateOrUpdate(resourceGroupName: string, accountName: string, privateEndpointConnectionName: string, properties: PrivateEndpointConnection, options?: PrivateEndpointConnectionsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<PrivateEndpointConnectionsCreateOrUpdateResponse>, PrivateEndpointConnectionsCreateOrUpdateResponse>>;
     /**
      * Update the state of specified private endpoint connection associated with the Cognitive Services
      * account.
@@ -1980,7 +2130,7 @@ export declare interface PrivateEndpointConnections {
      *                                      Cognitive Services Account
      * @param options The options parameters.
      */
-    beginDelete(resourceGroupName: string, accountName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>;
+    beginDelete(resourceGroupName: string, accountName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
     /**
      * Deletes the specified private endpoint connection associated with the Cognitive Services account.
      * @param resourceGroupName The name of the resource group. The name is case insensitive.
@@ -2404,10 +2554,38 @@ export declare interface Usage {
 
 /** The response to a list usage request. */
 export declare interface UsageListResult {
+    /** The link used to get the next page of Usages. */
+    nextLink?: string;
     /** The list of usages for Cognitive Service account. */
     value?: Usage[];
 }
 
+/** Interface representing a Usages. */
+export declare interface Usages {
+    /**
+     * Get usages for the requested subscription
+     * @param location Resource location.
+     * @param options The options parameters.
+     */
+    list(location: string, options?: UsagesListOptionalParams): PagedAsyncIterableIterator<Usage>;
+}
+
+/** Optional parameters. */
+export declare interface UsagesListNextOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the listNext operation. */
+export declare type UsagesListNextResponse = UsageListResult;
+
+/** Optional parameters. */
+export declare interface UsagesListOptionalParams extends coreClient.OperationOptions {
+    /** An OData filter expression that describes a subset of usages to return. The supported parameter is name.value (name of the metric, can have an or of multiple names). */
+    filter?: string;
+}
+
+/** Contains response data for the list operation. */
+export declare type UsagesListResponse = UsageListResult;
+
 /** User-assigned managed identity. */
 export declare interface UserAssignedIdentity {
     /**