@azure/arm-cognitiveservices 7.3.1 → 7.4.0-alpha.20230217.2

package/src/models/index.ts

@@ -154,6 +154,13 @@ export interface AccountProperties {
    * NOTE: This property will not be serialized. It can only be populated by the server.
    */
   readonly scheduledPurgeDate?: string;
+  /** The multiregion settings of Cognitive Services account. */
+  locations?: MultiRegionSettings;
+  /**
+   * The commitment plan associations of Cognitive Services account.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly commitmentPlanAssociations?: CommitmentPlanAssociation[];
 }
 
 /** SkuCapability indicates the capability of a certain feature. */
@@ -334,6 +341,31 @@ export interface QuotaLimit {
   rules?: ThrottlingRule[];
 }
 
+/** The multiregion settings Cognitive Services account. */
+export interface MultiRegionSettings {
+  /** Multiregion routing methods. */
+  routingMethod?: RoutingMethods;
+  regions?: RegionSetting[];
+}
+
+/** The call rate limit Cognitive Services account. */
+export interface RegionSetting {
+  /** Name of the region. */
+  name?: string;
+  /** A value for priority or weighted routing methods. */
+  value?: number;
+  /** Maps the region to the regional custom subdomain. */
+  customsubdomain?: string;
+}
+
+/** The commitment plan association. */
+export interface CommitmentPlanAssociation {
+  /** The Azure resource id of the commitment plan. */
+  commitmentPlanId?: string;
+  /** The location of of the commitment plan. */
+  commitmentPlanLocation?: string;
+}
+
 /** 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. */
@@ -790,6 +822,13 @@ export interface CommitmentPlanListResult {
 
 /** Properties of Cognitive Services account commitment plan. */
 export interface CommitmentPlanProperties {
+  /**
+   * Gets the status of the resource at the time the operation was called.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly provisioningState?: CommitmentPlanProvisioningState;
+  /** Commitment plan guid. */
+  commitmentPlanGuid?: string;
   /** Account hosting model. */
   hostingModel?: HostingModel;
   /** Commitment plan type. */
@@ -830,6 +869,23 @@ export interface CommitmentPeriod {
   readonly endDate?: string;
 }
 
+/** The object being used to update tags of a resource, in general used for PATCH operations. */
+export interface PatchResourceTags {
+  /** Resource tags. */
+  tags?: { [propertyName: string]: string };
+}
+
+/** The list of cognitive services Commitment Plan Account Association operation response. */
+export interface CommitmentPlanAccountAssociationListResult {
+  /** The link used to get the next page of Commitment Plan Account Association. */
+  nextLink?: string;
+  /**
+   * Gets the list of Cognitive Services Commitment Plan Account Association and their properties.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly value?: CommitmentPlanAccountAssociation[];
+}
+
 /** The resource model definition for an Azure Resource Manager resource with an etag. */
 export interface AzureEntityResource extends Resource {
   /**
@@ -856,8 +912,12 @@ export interface AccountModel extends DeploymentModel {
   maxCapacity?: number;
   /** The capabilities. */
   capabilities?: { [propertyName: string]: string };
+  /** The capabilities for finetune models. */
+  finetuneCapabilities?: { [propertyName: string]: string };
   /** Cognitive Services account ModelDeprecationInfo. */
   deprecation?: ModelDeprecationInfo;
+  /** Model lifecycle status. */
+  lifecycleStatus?: ModelLifecycleStatus;
   /**
    * 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.
@@ -865,6 +925,12 @@ export interface AccountModel extends DeploymentModel {
   readonly systemData?: SystemData;
 }
 
+/** The object being used to update tags and sku of a resource, in general used for PATCH operations. */
+export interface PatchResourceTagsAndSku extends PatchResourceTags {
+  /** The resource model definition representing SKU */
+  sku?: Sku;
+}
+
 /** The Private Endpoint Connection resource. */
 export interface PrivateEndpointConnection extends AzureEntityResource {
   /** Resource properties. */
@@ -927,10 +993,49 @@ export interface CommitmentPlan extends ProxyResource {
    * NOTE: This property will not be serialized. It can only be populated by the server.
    */
   readonly etag?: string;
+  /** The Kind of the resource. */
+  kind?: string;
+  /** The resource model definition representing SKU */
+  sku?: Sku;
+  /** Resource tags. */
+  tags?: { [propertyName: string]: string };
+  /** The geo-location where the resource lives */
+  location?: string;
   /** Properties of Cognitive Services account commitment plan. */
   properties?: CommitmentPlanProperties;
 }
 
+/** The commitment plan association. */
+export interface CommitmentPlanAccountAssociation extends ProxyResource {
+  /**
+   * 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.
+   */
+  readonly systemData?: SystemData;
+  /**
+   * Resource Etag.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly etag?: string;
+  /** The Azure resource id of the account. */
+  accountId?: string;
+}
+
+/** Defines headers for CommitmentPlans_updatePlan operation. */
+export interface CommitmentPlansUpdatePlanHeaders {
+  location?: string;
+}
+
+/** Defines headers for CommitmentPlans_deletePlan operation. */
+export interface CommitmentPlansDeletePlanHeaders {
+  location?: string;
+}
+
+/** Defines headers for CommitmentPlans_deleteAssociation operation. */
+export interface CommitmentPlansDeleteAssociationHeaders {
+  location?: string;
+}
+
 /** Known values of {@link SkuTier} that the service accepts. */
 export enum KnownSkuTier {
   /** Free */
@@ -1114,6 +1219,27 @@ export enum KnownPublicNetworkAccess {
  */
 export type PublicNetworkAccess = string;
 
+/** Known values of {@link RoutingMethods} that the service accepts. */
+export enum KnownRoutingMethods {
+  /** Priority */
+  Priority = "Priority",
+  /** Weighted */
+  Weighted = "Weighted",
+  /** Performance */
+  Performance = "Performance"
+}
+
+/**
+ * Defines values for RoutingMethods. \
+ * {@link KnownRoutingMethods} can be used interchangeably with RoutingMethods,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **Priority** \
+ * **Weighted** \
+ * **Performance**
+ */
+export type RoutingMethods = string;
+
 /** Known values of {@link ResourceSkuRestrictionsReasonCode} that the service accepts. */
 export enum KnownResourceSkuRestrictionsReasonCode {
   /** QuotaId */
@@ -1189,6 +1315,24 @@ export enum KnownQuotaUsageStatus {
  */
 export type QuotaUsageStatus = string;
 
+/** Known values of {@link ModelLifecycleStatus} that the service accepts. */
+export enum KnownModelLifecycleStatus {
+  /** GenerallyAvailable */
+  GenerallyAvailable = "GenerallyAvailable",
+  /** Preview */
+  Preview = "Preview"
+}
+
+/**
+ * Defines values for ModelLifecycleStatus. \
+ * {@link KnownModelLifecycleStatus} can be used interchangeably with ModelLifecycleStatus,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **GenerallyAvailable** \
+ * **Preview**
+ */
+export type ModelLifecycleStatus = string;
+
 /** Known values of {@link Origin} that the service accepts. */
 export enum KnownOrigin {
   /** User */
@@ -1293,6 +1437,39 @@ export enum KnownDeploymentScaleType {
  * **Manual**
  */
 export type DeploymentScaleType = string;
+
+/** Known values of {@link CommitmentPlanProvisioningState} that the service accepts. */
+export enum KnownCommitmentPlanProvisioningState {
+  /** Accepted */
+  Accepted = "Accepted",
+  /** Creating */
+  Creating = "Creating",
+  /** Deleting */
+  Deleting = "Deleting",
+  /** Moving */
+  Moving = "Moving",
+  /** Failed */
+  Failed = "Failed",
+  /** Succeeded */
+  Succeeded = "Succeeded",
+  /** Canceled */
+  Canceled = "Canceled"
+}
+
+/**
+ * Defines values for CommitmentPlanProvisioningState. \
+ * {@link KnownCommitmentPlanProvisioningState} can be used interchangeably with CommitmentPlanProvisioningState,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **Accepted** \
+ * **Creating** \
+ * **Deleting** \
+ * **Moving** \
+ * **Failed** \
+ * **Succeeded** \
+ * **Canceled**
+ */
+export type CommitmentPlanProvisioningState = string;
 /** Defines values for ResourceIdentityType. */
 export type ResourceIdentityType =
   | "None"
@@ -1620,6 +1797,95 @@ export interface CommitmentPlansDeleteOptionalParams
   resumeFrom?: string;
 }
 
+/** Optional parameters. */
+export interface CommitmentPlansCreateOrUpdatePlanOptionalParams
+  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 createOrUpdatePlan operation. */
+export type CommitmentPlansCreateOrUpdatePlanResponse = CommitmentPlan;
+
+/** Optional parameters. */
+export interface CommitmentPlansUpdatePlanOptionalParams
+  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 updatePlan operation. */
+export type CommitmentPlansUpdatePlanResponse = CommitmentPlan;
+
+/** Optional parameters. */
+export interface CommitmentPlansDeletePlanOptionalParams
+  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;
+}
+
+/** Optional parameters. */
+export interface CommitmentPlansGetPlanOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Contains response data for the getPlan operation. */
+export type CommitmentPlansGetPlanResponse = CommitmentPlan;
+
+/** Optional parameters. */
+export interface CommitmentPlansListPlansByResourceGroupOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Contains response data for the listPlansByResourceGroup operation. */
+export type CommitmentPlansListPlansByResourceGroupResponse = CommitmentPlanListResult;
+
+/** Optional parameters. */
+export interface CommitmentPlansListPlansBySubscriptionOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Contains response data for the listPlansBySubscription operation. */
+export type CommitmentPlansListPlansBySubscriptionResponse = CommitmentPlanListResult;
+
+/** Optional parameters. */
+export interface CommitmentPlansListAssociationsOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Contains response data for the listAssociations operation. */
+export type CommitmentPlansListAssociationsResponse = CommitmentPlanAccountAssociationListResult;
+
+/** Optional parameters. */
+export interface CommitmentPlansGetAssociationOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Contains response data for the getAssociation operation. */
+export type CommitmentPlansGetAssociationResponse = CommitmentPlanAccountAssociation;
+
+/** Optional parameters. */
+export interface CommitmentPlansCreateOrUpdateAssociationOptionalParams
+  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 createOrUpdateAssociation operation. */
+export type CommitmentPlansCreateOrUpdateAssociationResponse = CommitmentPlanAccountAssociation;
+
+/** Optional parameters. */
+export interface CommitmentPlansDeleteAssociationOptionalParams
+  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;
+}
+
 /** Optional parameters. */
 export interface CommitmentPlansListNextOptionalParams
   extends coreClient.OperationOptions {}
@@ -1627,6 +1893,27 @@ export interface CommitmentPlansListNextOptionalParams
 /** Contains response data for the listNext operation. */
 export type CommitmentPlansListNextResponse = CommitmentPlanListResult;
 
+/** Optional parameters. */
+export interface CommitmentPlansListPlansByResourceGroupNextOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Contains response data for the listPlansByResourceGroupNext operation. */
+export type CommitmentPlansListPlansByResourceGroupNextResponse = CommitmentPlanListResult;
+
+/** Optional parameters. */
+export interface CommitmentPlansListPlansBySubscriptionNextOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Contains response data for the listPlansBySubscriptionNext operation. */
+export type CommitmentPlansListPlansBySubscriptionNextResponse = CommitmentPlanListResult;
+
+/** Optional parameters. */
+export interface CommitmentPlansListAssociationsNextOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Contains response data for the listAssociationsNext operation. */
+export type CommitmentPlansListAssociationsNextResponse = CommitmentPlanAccountAssociationListResult;
+
 /** Optional parameters. */
 export interface CognitiveServicesManagementClientOptionalParams
   extends coreClient.ServiceClientOptions {

package/src/models/mappers.ts

@@ -354,6 +354,26 @@ export const AccountProperties: coreClient.CompositeMapper = {
         type: {
           name: "String"
         }
+      },
+      locations: {
+        serializedName: "locations",
+        type: {
+          name: "Composite",
+          className: "MultiRegionSettings"
+        }
+      },
+      commitmentPlanAssociations: {
+        serializedName: "commitmentPlanAssociations",
+        readOnly: true,
+        type: {
+          name: "Sequence",
+          element: {
+            type: {
+              name: "Composite",
+              className: "CommitmentPlanAssociation"
+            }
+          }
+        }
       }
     }
   }
@@ -913,6 +933,81 @@ export const QuotaLimit: coreClient.CompositeMapper = {
   }
 };
 
+export const MultiRegionSettings: coreClient.CompositeMapper = {
+  type: {
+    name: "Composite",
+    className: "MultiRegionSettings",
+    modelProperties: {
+      routingMethod: {
+        serializedName: "routingMethod",
+        type: {
+          name: "String"
+        }
+      },
+      regions: {
+        serializedName: "regions",
+        type: {
+          name: "Sequence",
+          element: {
+            type: {
+              name: "Composite",
+              className: "RegionSetting"
+            }
+          }
+        }
+      }
+    }
+  }
+};
+
+export const RegionSetting: coreClient.CompositeMapper = {
+  type: {
+    name: "Composite",
+    className: "RegionSetting",
+    modelProperties: {
+      name: {
+        serializedName: "name",
+        type: {
+          name: "String"
+        }
+      },
+      value: {
+        serializedName: "value",
+        type: {
+          name: "Number"
+        }
+      },
+      customsubdomain: {
+        serializedName: "customsubdomain",
+        type: {
+          name: "String"
+        }
+      }
+    }
+  }
+};
+
+export const CommitmentPlanAssociation: coreClient.CompositeMapper = {
+  type: {
+    name: "Composite",
+    className: "CommitmentPlanAssociation",
+    modelProperties: {
+      commitmentPlanId: {
+        serializedName: "commitmentPlanId",
+        type: {
+          name: "String"
+        }
+      },
+      commitmentPlanLocation: {
+        serializedName: "commitmentPlanLocation",
+        type: {
+          name: "String"
+        }
+      }
+    }
+  }
+};
+
 export const ErrorResponse: coreClient.CompositeMapper = {
   type: {
     name: "Composite",
@@ -2085,6 +2180,19 @@ export const CommitmentPlanProperties: coreClient.CompositeMapper = {
     name: "Composite",
     className: "CommitmentPlanProperties",
     modelProperties: {
+      provisioningState: {
+        serializedName: "provisioningState",
+        readOnly: true,
+        type: {
+          name: "String"
+        }
+      },
+      commitmentPlanGuid: {
+        serializedName: "commitmentPlanGuid",
+        type: {
+          name: "String"
+        }
+      },
       hostingModel: {
         serializedName: "hostingModel",
         type: {
@@ -2170,6 +2278,50 @@ export const CommitmentPeriod: coreClient.CompositeMapper = {
   }
 };
 
+export const PatchResourceTags: coreClient.CompositeMapper = {
+  type: {
+    name: "Composite",
+    className: "PatchResourceTags",
+    modelProperties: {
+      tags: {
+        serializedName: "tags",
+        type: {
+          name: "Dictionary",
+          value: { type: { name: "String" } }
+        }
+      }
+    }
+  }
+};
+
+export const CommitmentPlanAccountAssociationListResult: coreClient.CompositeMapper = {
+  type: {
+    name: "Composite",
+    className: "CommitmentPlanAccountAssociationListResult",
+    modelProperties: {
+      nextLink: {
+        serializedName: "nextLink",
+        type: {
+          name: "String"
+        }
+      },
+      value: {
+        serializedName: "value",
+        readOnly: true,
+        type: {
+          name: "Sequence",
+          element: {
+            type: {
+              name: "Composite",
+              className: "CommitmentPlanAccountAssociation"
+            }
+          }
+        }
+      }
+    }
+  }
+};
+
 export const AzureEntityResource: coreClient.CompositeMapper = {
   type: {
     name: "Composite",
@@ -2240,6 +2392,13 @@ export const AccountModel: coreClient.CompositeMapper = {
           value: { type: { name: "String" } }
         }
       },
+      finetuneCapabilities: {
+        serializedName: "finetuneCapabilities",
+        type: {
+          name: "Dictionary",
+          value: { type: { name: "String" } }
+        }
+      },
       deprecation: {
         serializedName: "deprecation",
         type: {
@@ -2247,6 +2406,12 @@ export const AccountModel: coreClient.CompositeMapper = {
           className: "ModelDeprecationInfo"
         }
       },
+      lifecycleStatus: {
+        serializedName: "lifecycleStatus",
+        type: {
+          name: "String"
+        }
+      },
       systemData: {
         serializedName: "systemData",
         type: {
@@ -2258,6 +2423,23 @@ export const AccountModel: coreClient.CompositeMapper = {
   }
 };
 
+export const PatchResourceTagsAndSku: coreClient.CompositeMapper = {
+  type: {
+    name: "Composite",
+    className: "PatchResourceTagsAndSku",
+    modelProperties: {
+      ...PatchResourceTags.type.modelProperties,
+      sku: {
+        serializedName: "sku",
+        type: {
+          name: "Composite",
+          className: "Sku"
+        }
+      }
+    }
+  }
+};
+
 export const PrivateEndpointConnection: coreClient.CompositeMapper = {
   type: {
     name: "Composite",
@@ -2396,6 +2578,32 @@ export const CommitmentPlan: coreClient.CompositeMapper = {
           name: "String"
         }
       },
+      kind: {
+        serializedName: "kind",
+        type: {
+          name: "String"
+        }
+      },
+      sku: {
+        serializedName: "sku",
+        type: {
+          name: "Composite",
+          className: "Sku"
+        }
+      },
+      tags: {
+        serializedName: "tags",
+        type: {
+          name: "Dictionary",
+          value: { type: { name: "String" } }
+        }
+      },
+      location: {
+        serializedName: "location",
+        type: {
+          name: "String"
+        }
+      },
       properties: {
         serializedName: "properties",
         type: {
@@ -2406,3 +2614,78 @@ export const CommitmentPlan: coreClient.CompositeMapper = {
     }
   }
 };
+
+export const CommitmentPlanAccountAssociation: coreClient.CompositeMapper = {
+  type: {
+    name: "Composite",
+    className: "CommitmentPlanAccountAssociation",
+    modelProperties: {
+      ...ProxyResource.type.modelProperties,
+      systemData: {
+        serializedName: "systemData",
+        type: {
+          name: "Composite",
+          className: "SystemData"
+        }
+      },
+      etag: {
+        serializedName: "etag",
+        readOnly: true,
+        type: {
+          name: "String"
+        }
+      },
+      accountId: {
+        serializedName: "properties.accountId",
+        type: {
+          name: "String"
+        }
+      }
+    }
+  }
+};
+
+export const CommitmentPlansUpdatePlanHeaders: coreClient.CompositeMapper = {
+  type: {
+    name: "Composite",
+    className: "CommitmentPlansUpdatePlanHeaders",
+    modelProperties: {
+      location: {
+        serializedName: "location",
+        type: {
+          name: "String"
+        }
+      }
+    }
+  }
+};
+
+export const CommitmentPlansDeletePlanHeaders: coreClient.CompositeMapper = {
+  type: {
+    name: "Composite",
+    className: "CommitmentPlansDeletePlanHeaders",
+    modelProperties: {
+      location: {
+        serializedName: "location",
+        type: {
+          name: "String"
+        }
+      }
+    }
+  }
+};
+
+export const CommitmentPlansDeleteAssociationHeaders: coreClient.CompositeMapper = {
+  type: {
+    name: "Composite",
+    className: "CommitmentPlansDeleteAssociationHeaders",
+    modelProperties: {
+      location: {
+        serializedName: "location",
+        type: {
+          name: "String"
+        }
+      }
+    }
+  }
+};