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

package/src/models/index.ts

@@ -161,6 +161,11 @@ export 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;
 }
 
 /** SkuCapability indicates the capability of a certain feature. */
@@ -366,6 +371,16 @@ export interface CommitmentPlanAssociation {
   commitmentPlanLocation?: string;
 }
 
+/** The abuse penalty. */
+export interface AbusePenalty {
+  /** The action of AbusePenalty. */
+  action?: AbusePenaltyAction;
+  /** The percentage of rate limit. */
+  rateLimitPercentage?: number;
+  /** The datetime of expiration of the AbusePenalty. */
+  expiration?: Date;
+}
+
 /** Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). */
 export interface ErrorResponse {
   /** The error object. */
@@ -499,6 +514,8 @@ export interface AccountSku {
 
 /** The response to a list usage request. */
 export interface UsageListResult {
+  /** The link used to get the next page of Usages. */
+  nextLink?: string;
   /** The list of usages for Cognitive Service account. */
   value?: Usage[];
 }
@@ -543,8 +560,10 @@ export 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.
@@ -552,6 +571,32 @@ export interface DeploymentModel {
   readonly callRateLimit?: CallRateLimit;
 }
 
+/** Describes an available Cognitive Services Model SKU. */
+export 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[];
+}
+
+/** The capacity configuration. */
+export 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;
+}
+
 /** Cognitive Services account ModelDeprecationInfo. */
 export interface ModelDeprecationInfo {
   /** The datetime of deprecation of the fineTune Model. */
@@ -703,6 +748,24 @@ export interface CommitmentCost {
   overageMeterId?: string;
 }
 
+/** The list of cognitive services models. */
+export 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[];
+}
+
+/** Cognitive Services Model. */
+export interface Model {
+  /** Model Metadata. */
+  model?: AccountModel;
+  /** The Kind of the Model. */
+  kind?: string;
+  /** The SKU of the Model. */
+  skuName?: string;
+}
+
 /** Check Domain availability parameter. */
 export interface CheckDomainAvailabilityParameter {
   /** The subdomain name to use. */
@@ -794,6 +857,10 @@ export 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;
 }
 
 /** Properties of Cognitive Services account deployment model. */
@@ -844,6 +911,11 @@ export 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[];
 }
 
 /** Cognitive Services account commitment period. */
@@ -908,6 +980,10 @@ export interface ProxyResource extends Resource {}
 export 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. */
@@ -967,6 +1043,8 @@ export interface Account extends AzureEntityResource {
 
 /** Cognitive Services account deployment. */
 export 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.
@@ -1240,6 +1318,24 @@ export enum KnownRoutingMethods {
  */
 export type RoutingMethods = string;
 
+/** Known values of {@link AbusePenaltyAction} that the service accepts. */
+export enum KnownAbusePenaltyAction {
+  /** Throttle */
+  Throttle = "Throttle",
+  /** Block */
+  Block = "Block"
+}
+
+/**
+ * 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 type AbusePenaltyAction = string;
+
 /** Known values of {@link ResourceSkuRestrictionsReasonCode} that the service accepts. */
 export enum KnownResourceSkuRestrictionsReasonCode {
   /** QuotaId */
@@ -1376,7 +1472,9 @@ export enum KnownHostingModel {
   /** ConnectedContainer */
   ConnectedContainer = "ConnectedContainer",
   /** DisconnectedContainer */
-  DisconnectedContainer = "DisconnectedContainer"
+  DisconnectedContainer = "DisconnectedContainer",
+  /** ProvisionedWeb */
+  ProvisionedWeb = "ProvisionedWeb"
 }
 
 /**
@@ -1386,7 +1484,8 @@ export enum KnownHostingModel {
  * ### Known values supported by the service
  * **Web** \
  * **ConnectedContainer** \
- * **DisconnectedContainer**
+ * **DisconnectedContainer** \
+ * **ProvisionedWeb**
  */
 export type HostingModel = string;
 
@@ -1403,7 +1502,11 @@ export enum KnownDeploymentProvisioningState {
   /** Failed */
   Failed = "Failed",
   /** Succeeded */
-  Succeeded = "Succeeded"
+  Succeeded = "Succeeded",
+  /** Disabled */
+  Disabled = "Disabled",
+  /** Canceled */
+  Canceled = "Canceled"
 }
 
 /**
@@ -1416,7 +1519,9 @@ export enum KnownDeploymentProvisioningState {
  * **Deleting** \
  * **Moving** \
  * **Failed** \
- * **Succeeded**
+ * **Succeeded** \
+ * **Disabled** \
+ * **Canceled**
  */
 export type DeploymentProvisioningState = string;
 
@@ -1438,6 +1543,27 @@ export enum KnownDeploymentScaleType {
  */
 export type DeploymentScaleType = string;
 
+/** Known values of {@link DeploymentModelVersionUpgradeOption} that the service accepts. */
+export enum KnownDeploymentModelVersionUpgradeOption {
+  /** OnceNewDefaultVersionAvailable */
+  OnceNewDefaultVersionAvailable = "OnceNewDefaultVersionAvailable",
+  /** OnceCurrentVersionExpired */
+  OnceCurrentVersionExpired = "OnceCurrentVersionExpired",
+  /** NoAutoUpgrade */
+  NoAutoUpgrade = "NoAutoUpgrade"
+}
+
+/**
+ * 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 type DeploymentModelVersionUpgradeOption = string;
+
 /** Known values of {@link CommitmentPlanProvisioningState} that the service accepts. */
 export enum KnownCommitmentPlanProvisioningState {
   /** Accepted */
@@ -1638,6 +1764,22 @@ export interface ResourceSkusListNextOptionalParams
 /** Contains response data for the listNext operation. */
 export type ResourceSkusListNextResponse = ResourceSkuListResult;
 
+/** Optional parameters. */
+export 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 type UsagesListResponse = UsageListResult;
+
+/** Optional parameters. */
+export interface UsagesListNextOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Contains response data for the listNext operation. */
+export type UsagesListNextResponse = UsageListResult;
+
 /** Optional parameters. */
 export interface OperationsListOptionalParams
   extends coreClient.OperationOptions {}
@@ -1683,6 +1825,19 @@ export interface CommitmentTiersListNextOptionalParams
 /** Contains response data for the listNext operation. */
 export type CommitmentTiersListNextResponse = CommitmentTierListResult;
 
+/** Optional parameters. */
+export interface ModelsListOptionalParams extends coreClient.OperationOptions {}
+
+/** Contains response data for the list operation. */
+export type ModelsListResponse = ModelListResult;
+
+/** Optional parameters. */
+export interface ModelsListNextOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Contains response data for the listNext operation. */
+export type ModelsListNextResponse = ModelListResult;
+
 /** Optional parameters. */
 export interface PrivateEndpointConnectionsListOptionalParams
   extends coreClient.OperationOptions {}

package/src/models/mappers.ts

@@ -374,6 +374,13 @@ export const AccountProperties: coreClient.CompositeMapper = {
             }
           }
         }
+      },
+      abusePenalty: {
+        serializedName: "abusePenalty",
+        type: {
+          name: "Composite",
+          className: "AbusePenalty"
+        }
       }
     }
   }
@@ -1008,6 +1015,33 @@ export const CommitmentPlanAssociation: coreClient.CompositeMapper = {
   }
 };
 
+export const AbusePenalty: coreClient.CompositeMapper = {
+  type: {
+    name: "Composite",
+    className: "AbusePenalty",
+    modelProperties: {
+      action: {
+        serializedName: "action",
+        type: {
+          name: "String"
+        }
+      },
+      rateLimitPercentage: {
+        serializedName: "rateLimitPercentage",
+        type: {
+          name: "Number"
+        }
+      },
+      expiration: {
+        serializedName: "expiration",
+        type: {
+          name: "DateTime"
+        }
+      }
+    }
+  }
+};
+
 export const ErrorResponse: coreClient.CompositeMapper = {
   type: {
     name: "Composite",
@@ -1373,6 +1407,12 @@ export const UsageListResult: coreClient.CompositeMapper = {
     name: "Composite",
     className: "UsageListResult",
     modelProperties: {
+      nextLink: {
+        serializedName: "nextLink",
+        type: {
+          name: "String"
+        }
+      },
       value: {
         serializedName: "value",
         type: {
@@ -1512,6 +1552,12 @@ export const DeploymentModel: coreClient.CompositeMapper = {
           name: "String"
         }
       },
+      source: {
+        serializedName: "source",
+        type: {
+          name: "String"
+        }
+      },
       callRateLimit: {
         serializedName: "callRateLimit",
         type: {
@@ -1523,6 +1569,85 @@ export const DeploymentModel: coreClient.CompositeMapper = {
   }
 };
 
+export const ModelSku: coreClient.CompositeMapper = {
+  type: {
+    name: "Composite",
+    className: "ModelSku",
+    modelProperties: {
+      name: {
+        serializedName: "name",
+        type: {
+          name: "String"
+        }
+      },
+      usageName: {
+        serializedName: "usageName",
+        type: {
+          name: "String"
+        }
+      },
+      deprecationDate: {
+        serializedName: "deprecationDate",
+        type: {
+          name: "DateTime"
+        }
+      },
+      capacity: {
+        serializedName: "capacity",
+        type: {
+          name: "Composite",
+          className: "CapacityConfig"
+        }
+      },
+      rateLimits: {
+        serializedName: "rateLimits",
+        type: {
+          name: "Sequence",
+          element: {
+            type: {
+              name: "Composite",
+              className: "CallRateLimit"
+            }
+          }
+        }
+      }
+    }
+  }
+};
+
+export const CapacityConfig: coreClient.CompositeMapper = {
+  type: {
+    name: "Composite",
+    className: "CapacityConfig",
+    modelProperties: {
+      minimum: {
+        serializedName: "minimum",
+        type: {
+          name: "Number"
+        }
+      },
+      maximum: {
+        serializedName: "maximum",
+        type: {
+          name: "Number"
+        }
+      },
+      step: {
+        serializedName: "step",
+        type: {
+          name: "Number"
+        }
+      },
+      default: {
+        serializedName: "default",
+        type: {
+          name: "Number"
+        }
+      }
+    }
+  }
+};
+
 export const ModelDeprecationInfo: coreClient.CompositeMapper = {
   type: {
     name: "Composite",
@@ -1884,6 +2009,61 @@ export const CommitmentCost: coreClient.CompositeMapper = {
   }
 };
 
+export const ModelListResult: coreClient.CompositeMapper = {
+  type: {
+    name: "Composite",
+    className: "ModelListResult",
+    modelProperties: {
+      nextLink: {
+        serializedName: "nextLink",
+        type: {
+          name: "String"
+        }
+      },
+      value: {
+        serializedName: "value",
+        type: {
+          name: "Sequence",
+          element: {
+            type: {
+              name: "Composite",
+              className: "Model"
+            }
+          }
+        }
+      }
+    }
+  }
+};
+
+export const Model: coreClient.CompositeMapper = {
+  type: {
+    name: "Composite",
+    className: "Model",
+    modelProperties: {
+      model: {
+        serializedName: "model",
+        type: {
+          name: "Composite",
+          className: "AccountModel"
+        }
+      },
+      kind: {
+        serializedName: "kind",
+        type: {
+          name: "String"
+        }
+      },
+      skuName: {
+        serializedName: "skuName",
+        type: {
+          name: "String"
+        }
+      }
+    }
+  }
+};
+
 export const CheckDomainAvailabilityParameter: coreClient.CompositeMapper = {
   type: {
     name: "Composite",
@@ -2114,6 +2294,25 @@ export const DeploymentProperties: coreClient.CompositeMapper = {
           name: "Composite",
           className: "CallRateLimit"
         }
+      },
+      rateLimits: {
+        serializedName: "rateLimits",
+        readOnly: true,
+        type: {
+          name: "Sequence",
+          element: {
+            type: {
+              name: "Composite",
+              className: "ThrottlingRule"
+            }
+          }
+        }
+      },
+      versionUpgradeOption: {
+        serializedName: "versionUpgradeOption",
+        type: {
+          name: "String"
+        }
       }
     }
   }
@@ -2231,6 +2430,18 @@ export const CommitmentPlanProperties: coreClient.CompositeMapper = {
           name: "Composite",
           className: "CommitmentPeriod"
         }
+      },
+      provisioningIssues: {
+        serializedName: "provisioningIssues",
+        readOnly: true,
+        type: {
+          name: "Sequence",
+          element: {
+            type: {
+              name: "String"
+            }
+          }
+        }
       }
     }
   }
@@ -2379,6 +2590,24 @@ export const AccountModel: coreClient.CompositeMapper = {
           className: "DeploymentModel"
         }
       },
+      isDefaultVersion: {
+        serializedName: "isDefaultVersion",
+        type: {
+          name: "Boolean"
+        }
+      },
+      skus: {
+        serializedName: "skus",
+        type: {
+          name: "Sequence",
+          element: {
+            type: {
+              name: "Composite",
+              className: "ModelSku"
+            }
+          }
+        }
+      },
       maxCapacity: {
         serializedName: "maxCapacity",
         type: {
@@ -2533,6 +2762,13 @@ export const Deployment: coreClient.CompositeMapper = {
     className: "Deployment",
     modelProperties: {
       ...ProxyResource.type.modelProperties,
+      sku: {
+        serializedName: "sku",
+        type: {
+          name: "Composite",
+          className: "Sku"
+        }
+      },
       systemData: {
         serializedName: "systemData",
         type: {

package/src/models/parameters.ts

@@ -98,7 +98,7 @@ export const accountName: OperationURLParameter = {
 export const apiVersion: OperationQueryParameter = {
   parameterPath: "apiVersion",
   mapper: {
-    defaultValue: "2022-12-01",
+    defaultValue: "2023-05-01",
     isConstant: true,
     serializedName: "api-version",
     type: {