@azure/arm-durabletask 1.0.0-beta.1 → 1.0.0

package/dist/commonjs/models/models.d.ts

@@ -1,106 +1,70 @@
-/** A Task Hub resource belonging to the scheduler */
-export interface TaskHub extends ProxyResource {
-    /** The resource-specific properties for this resource. */
-    properties?: TaskHubProperties;
+/** A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results. */
+export interface _OperationListResult {
+    /** The Operation items on this page */
+    value: Operation[];
+    /** The link to the next page of items */
+    nextLink?: string;
 }
-export declare function taskHubSerializer(item: TaskHub): any;
-export declare function taskHubDeserializer(item: any): TaskHub;
-/** The properties of Task Hub */
-export interface TaskHubProperties {
-    /** The status of the last operation */
-    readonly provisioningState?: ProvisioningState;
-    /** URL of the durable task scheduler dashboard */
-    readonly dashboardUrl?: string;
+export declare function _operationListResultDeserializer(item: any): _OperationListResult;
+export declare function operationArrayDeserializer(result: Array<Operation>): any[];
+/** Details of a REST API operation, returned from the Resource Provider Operations API */
+export interface Operation {
+    /** The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" */
+    readonly name?: string;
+    /** Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for Azure Resource Manager/control-plane operations. */
+    readonly isDataAction?: boolean;
+    /** Localized display information for this particular operation. */
+    display?: OperationDisplay;
+    /** The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" */
+    readonly origin?: Origin;
+    /** Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. */
+    readonly actionType?: ActionType;
 }
-export declare function taskHubPropertiesSerializer(item: TaskHubProperties): any;
-export declare function taskHubPropertiesDeserializer(item: any): TaskHubProperties;
-/** The status of the current operation */
-export declare enum KnownProvisioningState {
-    /** Resource has been created. */
-    Succeeded = "Succeeded",
-    /** Resource creation failed. */
-    Failed = "Failed",
-    /** Resource creation was canceled. */
-    Canceled = "Canceled",
-    /** The resource is being provisioned */
-    Provisioning = "Provisioning",
-    /** The resource is updating */
-    Updating = "Updating",
-    /** The resource is being deleted */
-    Deleting = "Deleting",
-    /** The resource create request has been accepted */
-    Accepted = "Accepted"
+export declare function operationDeserializer(item: any): Operation;
+/** Localized display information for and operation. */
+export interface OperationDisplay {
+    /** The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". */
+    readonly provider?: string;
+    /** The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". */
+    readonly resource?: string;
+    /** The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". */
+    readonly operation?: string;
+    /** The short, localized friendly description of the operation; suitable for tool tips and detailed views. */
+    readonly description?: string;
+}
+export declare function operationDisplayDeserializer(item: any): OperationDisplay;
+/** The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" */
+export declare enum KnownOrigin {
+    /** Indicates the operation is initiated by a user. */
+    User = "user",
+    /** Indicates the operation is initiated by a system. */
+    System = "system",
+    /** Indicates the operation is initiated by a user or system. */
+    UserSystem = "user,system"
 }
 /**
- * The status of the current operation \
- * {@link KnownProvisioningState} can be used interchangeably with ProvisioningState,
+ * The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" \
+ * {@link KnownOrigin} can be used interchangeably with Origin,
  *  this enum contains the known values that the service supports.
  * ### Known values supported by the service
- * **Succeeded**: Resource has been created. \
- * **Failed**: Resource creation failed. \
- * **Canceled**: Resource creation was canceled. \
- * **Provisioning**: The resource is being provisioned \
- * **Updating**: The resource is updating \
- * **Deleting**: The resource is being deleted \
- * **Accepted**: The resource create request has been accepted
+ * **user**: Indicates the operation is initiated by a user. \
+ * **system**: Indicates the operation is initiated by a system. \
+ * **user,system**: Indicates the operation is initiated by a user or system.
  */
-export type ProvisioningState = string;
-/** The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location */
-export interface ProxyResource extends Resource {
-}
-export declare function proxyResourceSerializer(item: ProxyResource): any;
-export declare function proxyResourceDeserializer(item: any): ProxyResource;
-/** Common fields that are returned in the response for all Azure Resource Manager resources */
-export interface Resource {
-    /** Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} */
-    readonly id?: string;
-    /** The name of the resource */
-    readonly name?: string;
-    /** The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */
-    readonly type?: string;
-    /** Azure Resource Manager metadata containing createdBy and modifiedBy information. */
-    readonly systemData?: SystemData;
-}
-export declare function resourceSerializer(item: Resource): any;
-export declare function resourceDeserializer(item: any): Resource;
-/** Metadata pertaining to creation and last modification of the resource. */
-export interface SystemData {
-    /** The identity that created the resource. */
-    createdBy?: string;
-    /** The type of identity that created the resource. */
-    createdByType?: CreatedByType;
-    /** The timestamp of resource creation (UTC). */
-    createdAt?: Date;
-    /** The identity that last modified the resource. */
-    lastModifiedBy?: string;
-    /** The type of identity that last modified the resource. */
-    lastModifiedByType?: CreatedByType;
-    /** The timestamp of resource last modification (UTC) */
-    lastModifiedAt?: Date;
-}
-export declare function systemDataDeserializer(item: any): SystemData;
-/** The kind of entity that created the resource. */
-export declare enum KnownCreatedByType {
-    /** The entity was created by a user. */
-    User = "User",
-    /** The entity was created by an application. */
-    Application = "Application",
-    /** The entity was created by a managed identity. */
-    ManagedIdentity = "ManagedIdentity",
-    /** The entity was created by a key. */
-    Key = "Key"
+export type Origin = string;
+/** Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. */
+export declare enum KnownActionType {
+    /** Actions are for internal-only APIs. */
+    Internal = "Internal"
 }
 /**
- * The kind of entity that created the resource. \
- * {@link KnowncreatedByType} can be used interchangeably with createdByType,
+ * Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. \
+ * {@link KnownActionType} can be used interchangeably with ActionType,
  *  this enum contains the known values that the service supports.
  * ### Known values supported by the service
- * **User**: The entity was created by a user. \
- * **Application**: The entity was created by an application. \
- * **ManagedIdentity**: The entity was created by a managed identity. \
- * **Key**: The entity was created by a key.
+ * **Internal**: Actions are for internal-only APIs.
  */
-export type CreatedByType = string;
+export type ActionType = string;
 /** Common error response for all Azure Resource Manager APIs to return error details for failed operations. */
 export interface ErrorResponse {
     /** The error object. */
@@ -128,23 +92,9 @@ export interface ErrorAdditionalInfo {
     /** The additional info type. */
     readonly type?: string;
     /** The additional info. */
-    readonly info?: Record<string, any>;
+    readonly info?: any;
 }
 export declare function errorAdditionalInfoDeserializer(item: any): ErrorAdditionalInfo;
-/** model interface _ErrorAdditionalInfoInfo */
-export interface _ErrorAdditionalInfoInfo {
-}
-export declare function _errorAdditionalInfoInfoDeserializer(item: any): _ErrorAdditionalInfoInfo;
-/** The response of a TaskHub list operation. */
-export interface _TaskHubListResult {
-    /** The TaskHub items on this page */
-    value: TaskHub[];
-    /** The link to the next page of items */
-    nextLink?: string;
-}
-export declare function _taskHubListResultDeserializer(item: any): _TaskHubListResult;
-export declare function taskHubArraySerializer(result: Array<TaskHub>): any[];
-export declare function taskHubArrayDeserializer(result: Array<TaskHub>): any[];
 /** A Durable Task Scheduler resource */
 export interface Scheduler extends TrackedResource {
     /** The resource-specific properties for this resource. */
@@ -165,10 +115,41 @@ export interface SchedulerProperties {
 }
 export declare function schedulerPropertiesSerializer(item: SchedulerProperties): any;
 export declare function schedulerPropertiesDeserializer(item: any): SchedulerProperties;
+/** The status of the current operation */
+export declare enum KnownProvisioningState {
+    /** Resource has been created. */
+    Succeeded = "Succeeded",
+    /** Resource creation failed. */
+    Failed = "Failed",
+    /** Resource creation was canceled. */
+    Canceled = "Canceled",
+    /** The resource is being provisioned */
+    Provisioning = "Provisioning",
+    /** The resource is updating */
+    Updating = "Updating",
+    /** The resource is being deleted */
+    Deleting = "Deleting",
+    /** The resource create request has been accepted */
+    Accepted = "Accepted"
+}
+/**
+ * The status of the current operation \
+ * {@link KnownProvisioningState} can be used interchangeably with ProvisioningState,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **Succeeded**: Resource has been created. \
+ * **Failed**: Resource creation failed. \
+ * **Canceled**: Resource creation was canceled. \
+ * **Provisioning**: The resource is being provisioned \
+ * **Updating**: The resource is updating \
+ * **Deleting**: The resource is being deleted \
+ * **Accepted**: The resource create request has been accepted
+ */
+export type ProvisioningState = string;
 /** The SKU (Stock Keeping Unit) assigned to this durable task scheduler */
 export interface SchedulerSku {
     /** The name of the SKU */
-    name: string;
+    name: SchedulerSkuName;
     /** The SKU capacity. This allows scale out/in for the resource and impacts zone redundancy */
     capacity?: number;
     /** Indicates whether the current SKU configuration is zone redundant */
@@ -176,6 +157,22 @@ export interface SchedulerSku {
 }
 export declare function schedulerSkuSerializer(item: SchedulerSku): any;
 export declare function schedulerSkuDeserializer(item: any): SchedulerSku;
+/** The name of the Stock Keeping Unit (SKU) of a Durable Task Scheduler */
+export declare enum KnownSchedulerSkuName {
+    /** Dedicated SKU */
+    Dedicated = "Dedicated",
+    /** Consumption SKU */
+    Consumption = "Consumption"
+}
+/**
+ * The name of the Stock Keeping Unit (SKU) of a Durable Task Scheduler \
+ * {@link KnownSchedulerSkuName} can be used interchangeably with SchedulerSkuName,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **Dedicated**: Dedicated SKU \
+ * **Consumption**: Consumption SKU
+ */
+export type SchedulerSkuName = string;
 /** The state of the resource redundancy */
 export declare enum KnownRedundancyState {
     /** The resource is not redundant */
@@ -201,6 +198,57 @@ export interface TrackedResource extends Resource {
 }
 export declare function trackedResourceSerializer(item: TrackedResource): any;
 export declare function trackedResourceDeserializer(item: any): TrackedResource;
+/** Common fields that are returned in the response for all Azure Resource Manager resources */
+export interface Resource {
+    /** Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} */
+    readonly id?: string;
+    /** The name of the resource */
+    readonly name?: string;
+    /** The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */
+    readonly type?: string;
+    /** Azure Resource Manager metadata containing createdBy and modifiedBy information. */
+    readonly systemData?: SystemData;
+}
+export declare function resourceSerializer(item: Resource): any;
+export declare function resourceDeserializer(item: any): Resource;
+/** Metadata pertaining to creation and last modification of the resource. */
+export interface SystemData {
+    /** The identity that created the resource. */
+    createdBy?: string;
+    /** The type of identity that created the resource. */
+    createdByType?: CreatedByType;
+    /** The timestamp of resource creation (UTC). */
+    createdAt?: Date;
+    /** The identity that last modified the resource. */
+    lastModifiedBy?: string;
+    /** The type of identity that last modified the resource. */
+    lastModifiedByType?: CreatedByType;
+    /** The timestamp of resource last modification (UTC) */
+    lastModifiedAt?: Date;
+}
+export declare function systemDataDeserializer(item: any): SystemData;
+/** The kind of entity that created the resource. */
+export declare enum KnownCreatedByType {
+    /** The entity was created by a user. */
+    User = "User",
+    /** The entity was created by an application. */
+    Application = "Application",
+    /** The entity was created by a managed identity. */
+    ManagedIdentity = "ManagedIdentity",
+    /** The entity was created by a key. */
+    Key = "Key"
+}
+/**
+ * The kind of entity that created the resource. \
+ * {@link KnownCreatedByType} can be used interchangeably with CreatedByType,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **User**: The entity was created by a user. \
+ * **Application**: The entity was created by an application. \
+ * **ManagedIdentity**: The entity was created by a managed identity. \
+ * **Key**: The entity was created by a key.
+ */
+export type CreatedByType = string;
 /** The update request model for the Scheduler resource */
 export interface SchedulerUpdate {
     /** The resource-specific properties for this resource. */
@@ -224,7 +272,7 @@ export declare function schedulerPropertiesUpdateSerializer(item: SchedulerPrope
 /** The SKU (Stock Keeping Unit) properties to be updated */
 export interface SchedulerSkuUpdate {
     /** The name of the SKU */
-    name?: string;
+    name?: SchedulerSkuName;
     /** The SKU capacity. This allows scale out/in for the resource and impacts zone redundancy */
     capacity?: number;
     /** Indicates whether the current SKU configuration is zone redundant */
@@ -241,76 +289,99 @@ export interface _SchedulerListResult {
 export declare function _schedulerListResultDeserializer(item: any): _SchedulerListResult;
 export declare function schedulerArraySerializer(result: Array<Scheduler>): any[];
 export declare function schedulerArrayDeserializer(result: Array<Scheduler>): any[];
-/** A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results. */
-export interface _OperationListResult {
-    /** The Operation items on this page */
-    value: Operation[];
+/** A Task Hub resource belonging to the scheduler */
+export interface TaskHub extends ProxyResource {
+    /** The resource-specific properties for this resource. */
+    properties?: TaskHubProperties;
+}
+export declare function taskHubSerializer(item: TaskHub): any;
+export declare function taskHubDeserializer(item: any): TaskHub;
+/** The properties of Task Hub */
+export interface TaskHubProperties {
+    /** The status of the last operation */
+    readonly provisioningState?: ProvisioningState;
+    /** URL of the durable task scheduler dashboard */
+    readonly dashboardUrl?: string;
+}
+export declare function taskHubPropertiesSerializer(item: TaskHubProperties): any;
+export declare function taskHubPropertiesDeserializer(item: any): TaskHubProperties;
+/** The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location */
+export interface ProxyResource extends Resource {
+}
+export declare function proxyResourceSerializer(item: ProxyResource): any;
+export declare function proxyResourceDeserializer(item: any): ProxyResource;
+/** The response of a TaskHub list operation. */
+export interface _TaskHubListResult {
+    /** The TaskHub items on this page */
+    value: TaskHub[];
     /** The link to the next page of items */
     nextLink?: string;
 }
-export declare function _operationListResultDeserializer(item: any): _OperationListResult;
-export declare function operationArrayDeserializer(result: Array<Operation>): any[];
-/** Details of a REST API operation, returned from the Resource Provider Operations API */
-export interface Operation {
-    /** The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" */
-    readonly name?: string;
-    /** Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for Azure Resource Manager/control-plane operations. */
-    readonly isDataAction?: boolean;
-    /** Localized display information for this particular operation. */
-    display?: OperationDisplay;
-    /** The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" */
-    readonly origin?: Origin;
-    /** Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. */
-    readonly actionType?: ActionType;
+export declare function _taskHubListResultDeserializer(item: any): _TaskHubListResult;
+export declare function taskHubArraySerializer(result: Array<TaskHub>): any[];
+export declare function taskHubArrayDeserializer(result: Array<TaskHub>): any[];
+/** A retention policy resource belonging to the scheduler */
+export interface RetentionPolicy extends ProxyResource {
+    /** The resource-specific properties for this resource. */
+    properties?: RetentionPolicyProperties;
 }
-export declare function operationDeserializer(item: any): Operation;
-/** Localized display information for and operation. */
-export interface OperationDisplay {
-    /** The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". */
-    readonly provider?: string;
-    /** The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". */
-    readonly resource?: string;
-    /** The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". */
-    readonly operation?: string;
-    /** The short, localized friendly description of the operation; suitable for tool tips and detailed views. */
-    readonly description?: string;
+export declare function retentionPolicySerializer(item: RetentionPolicy): any;
+export declare function retentionPolicyDeserializer(item: any): RetentionPolicy;
+/** The retention policy settings for the resource */
+export interface RetentionPolicyProperties {
+    /** The status of the last operation */
+    readonly provisioningState?: ProvisioningState;
+    /** The orchestration retention policies */
+    retentionPolicies?: RetentionPolicyDetails[];
 }
-export declare function operationDisplayDeserializer(item: any): OperationDisplay;
-/** The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" */
-export declare enum KnownOrigin {
-    /** Indicates the operation is initiated by a user. */
-    User = "user",
-    /** Indicates the operation is initiated by a system. */
-    System = "system",
-    /** Indicates the operation is initiated by a user or system. */
-    UserSystem = "user,system"
+export declare function retentionPolicyPropertiesSerializer(item: RetentionPolicyProperties): any;
+export declare function retentionPolicyPropertiesDeserializer(item: any): RetentionPolicyProperties;
+export declare function retentionPolicyDetailsArraySerializer(result: Array<RetentionPolicyDetails>): any[];
+export declare function retentionPolicyDetailsArrayDeserializer(result: Array<RetentionPolicyDetails>): any[];
+/** The properties of a retention policy */
+export interface RetentionPolicyDetails {
+    /** The retention period in days after which the orchestration will be purged automatically */
+    retentionPeriodInDays: number;
+    /** The orchestration state to which this policy applies. If omitted, the policy applies to all purgeable orchestration states. */
+    orchestrationState?: PurgeableOrchestrationState;
 }
-/**
- * The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" \
- * {@link KnownOrigin} can be used interchangeably with Origin,
- *  this enum contains the known values that the service supports.
- * ### Known values supported by the service
- * **user**: Indicates the operation is initiated by a user. \
- * **system**: Indicates the operation is initiated by a system. \
- * **user,system**: Indicates the operation is initiated by a user or system.
- */
-export type Origin = string;
-/** Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. */
-export declare enum KnownActionType {
-    /** Actions are for internal-only APIs. */
-    Internal = "Internal"
+export declare function retentionPolicyDetailsSerializer(item: RetentionPolicyDetails): any;
+export declare function retentionPolicyDetailsDeserializer(item: any): RetentionPolicyDetails;
+/** Purgeable orchestration state to be used in retention policies */
+export declare enum KnownPurgeableOrchestrationState {
+    /** The orchestration is completed */
+    Completed = "Completed",
+    /** The orchestration is failed */
+    Failed = "Failed",
+    /** The orchestration is terminated */
+    Terminated = "Terminated",
+    /** The orchestration is canceled */
+    Canceled = "Canceled"
 }
 /**
- * Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. \
- * {@link KnownActionType} can be used interchangeably with ActionType,
+ * Purgeable orchestration state to be used in retention policies \
+ * {@link KnownPurgeableOrchestrationState} can be used interchangeably with PurgeableOrchestrationState,
  *  this enum contains the known values that the service supports.
  * ### Known values supported by the service
- * **Internal**: Actions are for internal-only APIs.
+ * **Completed**: The orchestration is completed \
+ * **Failed**: The orchestration is failed \
+ * **Terminated**: The orchestration is terminated \
+ * **Canceled**: The orchestration is canceled
  */
-export type ActionType = string;
+export type PurgeableOrchestrationState = string;
+/** The response of a RetentionPolicy list operation. */
+export interface _RetentionPolicyListResult {
+    /** The RetentionPolicy items on this page */
+    value: RetentionPolicy[];
+    /** The link to the next page of items */
+    nextLink?: string;
+}
+export declare function _retentionPolicyListResultDeserializer(item: any): _RetentionPolicyListResult;
+export declare function retentionPolicyArraySerializer(result: Array<RetentionPolicy>): any[];
+export declare function retentionPolicyArrayDeserializer(result: Array<RetentionPolicy>): any[];
 /** API Versions */
 export declare enum KnownVersions {
-    /** 2024-10-01-preview */
-    V20241001Preview = "2024-10-01-preview"
+    /** 2025-11-01 */
+    V20251101 = "2025-11-01"
 }
 //# sourceMappingURL=models.d.ts.map