@azure/arm-compute

Version:

A generated SDK for ComputeManagementClient.

github.com/Azure/azure-sdk-for-js/tree/main/sdk/compute/arm-compute

13,363 lines • 728 kB

TypeScript

import type * as coreClient from "@azure/core-client";
/** 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 {
/**
* List of operations supported by the resource provider
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly value?: Operation[];
/**
* URL to get the next set of operation list results (if there are any).
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly nextLink?: string;
}
/** 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"
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly name?: string;
/**
* Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
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"
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly origin?: Origin;
/**
* Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly actionType?: ActionType;
}
/** Localized display information for this particular operation. */
export interface OperationDisplay {
/**
* The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute".
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly provider?: string;
/**
* The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections".
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly resource?: string;
/**
* The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine".
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly operation?: string;
/**
* The short, localized friendly description of the operation; suitable for tool tips and detailed views.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly description?: string;
}
/** An error response from the Compute service. */
export interface CloudError {
/** Api error. */
error?: ApiError;
}
/** Api error. */
export interface ApiError {
/** The Api error details */
details?: ApiErrorBase[];
/** The Api inner error */
innererror?: InnerError;
/** The error code. */
code?: string;
/** The target of the particular error. */
target?: string;
/** The error message. */
message?: string;
}
/** Api error base. */
export interface ApiErrorBase {
/** The error code. */
code?: string;
/** The target of the particular error. */
target?: string;
/** The error message. */
message?: string;
}
/** Inner error details. */
export interface InnerError {
/** The exception type. */
exceptiontype?: string;
/** The internal error message or exception dump. */
errordetail?: string;
}
/** The List Availability Set operation response. */
export interface AvailabilitySetListResult {
/** The list of availability sets. */
value: AvailabilitySet[];
/** The URI to fetch the next page of AvailabilitySets. Call ListNext() with this URI to fetch the next page of AvailabilitySets. */
nextLink?: string;
}
export interface SubResource {
/** Resource Id */
id?: string;
}
/** Instance view status. */
export interface InstanceViewStatus {
/** The status code. */
code?: string;
/** The level code. */
level?: StatusLevelTypes;
/** The short localizable label for the status. */
displayStatus?: string;
/** The detailed status message, including for alerts and error messages. */
message?: string;
/** The time of the status. */
time?: Date;
}
/** Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations. */
export interface ScheduledEventsPolicy {
/** The configuration parameters used while creating userInitiatedRedeploy scheduled event setting creation. */
userInitiatedRedeploy?: UserInitiatedRedeploy;
/** The configuration parameters used while creating userInitiatedReboot scheduled event setting creation. */
userInitiatedReboot?: UserInitiatedReboot;
/** The configuration parameters used while publishing scheduledEventsAdditionalPublishingTargets. */
scheduledEventsAdditionalPublishingTargets?: ScheduledEventsAdditionalPublishingTargets;
/** The configuration parameters used while creating AllInstancesDown scheduled event setting creation. */
allInstancesDown?: AllInstancesDown;
}
/** Specifies Redeploy related Scheduled Event related configurations. */
export interface UserInitiatedRedeploy {
/** Specifies Redeploy Scheduled Event related configurations. */
automaticallyApprove?: boolean;
}
/** Specifies Reboot related Scheduled Event related configurations. */
export interface UserInitiatedReboot {
/** Specifies Reboot Scheduled Event related configurations. */
automaticallyApprove?: boolean;
}
export interface ScheduledEventsAdditionalPublishingTargets {
/** The configuration parameters used while creating eventGridAndResourceGraph Scheduled Event setting. */
eventGridAndResourceGraph?: EventGridAndResourceGraph;
}
/** Specifies eventGridAndResourceGraph related Scheduled Event related configurations. */
export interface EventGridAndResourceGraph {
/** Specifies if event grid and resource graph is enabled for Scheduled event related configurations. */
enable?: boolean;
/** Specifies the api-version to determine which Scheduled Events configuration schema version will be delivered. */
scheduledEventsApiVersion?: string;
}
/** Specifies if Scheduled Events should be auto-approved when all instances are down. */
export interface AllInstancesDown {
/**
* Specifies if Scheduled Events should be auto-approved when all instances are down.
* its default value is true
*/
automaticallyApprove?: boolean;
}
/** Describes the Availability Set properties related to migration to Flexible Virtual Machine Scale Set. */
export interface VirtualMachineScaleSetMigrationInfo {
/**
* Indicates the target Virtual Machine ScaleSet properties upon triggering a seamless migration without downtime of the VMs via the ConvertToVirtualMachineScaleSet API.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly defaultVirtualMachineScaleSetInfo?: DefaultVirtualMachineScaleSetInfo;
/**
* Specifies the Virtual Machine Scale Set that the Availability Set is migrated to.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly migrateToVirtualMachineScaleSet?: SubResource;
}
/** Indicates the target Virtual Machine ScaleSet properties upon triggering a seamless migration without downtime of the VMs via the ConvertToVirtualMachineScaleSet API. */
export interface DefaultVirtualMachineScaleSetInfo {
/**
* Indicates if the the maximum capacity of the default migrated Virtual Machine Scale Set after its migration will be constrained to a limited number of VMs.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly constrainedMaximumCapacity?: boolean;
/**
* The default Virtual Machine ScaleSet Uri that the Availability Set will be moved to upon triggering a seamless migration via the ConvertToVirtualMachineScaleSet API.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly defaultVirtualMachineScaleSet?: SubResource;
}
/** Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name. */
export interface Sku {
/** The sku name. */
name?: string;
/** Specifies the tier of virtual machines in a scale set. Possible Values: **Standard** **Basic** */
tier?: string;
/** Specifies the number of virtual machines in the scale set. */
capacity?: number;
}
/** 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}
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly id?: string;
/**
* The name of the resource
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly name?: string;
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly type?: string;
/**
* Azure Resource Manager metadata containing createdBy and modifiedBy information.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly systemData?: SystemData;
}
/** 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;
}
/** The List capacity reservation group with resource group response. */
export interface CapacityReservationGroupListResult {
/** The list of capacity reservation groups. */
value: CapacityReservationGroup[];
/** The URI to fetch the next page of capacity reservation groups. Call ListNext() with this URI to fetch the next page of capacity reservation groups. */
nextLink?: string;
}
export interface SubResourceReadOnly {
/**
* Resource Id
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly id?: string;
}
export interface CapacityReservationGroupInstanceView {
/**
* List of instance view of the capacity reservations under the capacity reservation group.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly capacityReservations?: CapacityReservationInstanceViewWithName[];
/**
* List of the subscriptions that the capacity reservation group is shared with. **Note:** Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly sharedSubscriptionIds?: SubResourceReadOnly[];
}
/** The instance view of a capacity reservation that provides as snapshot of the runtime properties of the capacity reservation that is managed by the platform and can change outside of control plane operations. */
export interface CapacityReservationInstanceView {
/** Unutilized capacity of the capacity reservation. */
utilizationInfo?: CapacityReservationUtilization;
/** The resource status information. */
statuses?: InstanceViewStatus[];
}
/** Represents the capacity reservation utilization in terms of resources allocated. */
export interface CapacityReservationUtilization {
/**
* The value provides the current capacity of the VM size which was reserved successfully and for which the customer is getting billed. Minimum api-version: 2022-08-01.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly currentCapacity?: number;
/**
* A list of all virtual machines resource ids allocated against the capacity reservation.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly virtualMachinesAllocated?: SubResourceReadOnly[];
}
export interface ResourceSharingProfile {
/** Specifies an array of subscription resource IDs that capacity reservation group is shared with. Block Capacity Reservations does not support sharing across subscriptions. **Note:** Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details. */
subscriptionIds?: SubResource[];
}
/** The List Dedicated Host Group with resource group response. */
export interface DedicatedHostGroupListResult {
/** The list of dedicated host groups. */
value: DedicatedHostGroup[];
/** The URI to fetch the next page of Dedicated Host Groups. Call ListNext() with this URI to fetch the next page of Dedicated Host Groups. */
nextLink?: string;
}
export interface DedicatedHostGroupInstanceView {
/** List of instance view of the dedicated hosts under the dedicated host group. */
hosts?: DedicatedHostInstanceViewWithName[];
}
/** The instance view of a dedicated host. */
export interface DedicatedHostInstanceView {
/**
* Specifies the unique id of the dedicated physical machine on which the dedicated host resides.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly assetId?: string;
/** Unutilized capacity of the dedicated host. */
availableCapacity?: DedicatedHostAvailableCapacity;
/** The resource status information. */
statuses?: InstanceViewStatus[];
}
/** Dedicated host unutilized capacity. */
export interface DedicatedHostAvailableCapacity {
/** The unutilized capacity of the dedicated host represented in terms of each VM size that is allowed to be deployed to the dedicated host. */
allocatableVMs?: DedicatedHostAllocatableVM[];
}
/** Represents the dedicated host unutilized capacity in terms of a specific VM size. */
export interface DedicatedHostAllocatableVM {
/** VM size in terms of which the unutilized capacity is represented. */
vmSize?: string;
/** Maximum number of VMs of size vmSize that can fit in the dedicated host's remaining capacity. */
count?: number;
}
/** Enables or disables a capability on the dedicated host group. Minimum api-version: 2022-03-01. */
export interface DedicatedHostGroupPropertiesAdditionalCapabilities {
/** The flag that enables or disables a capability to have UltraSSD Enabled Virtual Machines on Dedicated Hosts of the Dedicated Host Group. For the Virtual Machines to be UltraSSD Enabled, UltraSSDEnabled flag for the resource needs to be set true as well. The value is defaulted to 'false' when not provided. Please refer to https://docs.microsoft.com/en-us/azure/virtual-machines/disks-enable-ultra-ssd for more details on Ultra SSD feature. **Note:** The ultraSSDEnabled setting can only be enabled for Host Groups that are created as zonal. Minimum api-version: 2022-03-01. */
ultraSSDEnabled?: boolean;
}
/** The List Image operation response. */
export interface ImageListResult {
/** The list of Images */
value: Image[];
/** The uri to fetch the next page of Images. Call ListNext() with this to fetch the next page of Images. */
nextLink?: string;
}
/** Describes a storage profile. */
export interface ImageStorageProfile {
/** Specifies information about the operating system disk used by the virtual machine. For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview). */
osDisk?: ImageOSDisk;
/** Specifies the parameters that are used to add a data disk to a virtual machine. For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview). */
dataDisks?: ImageDataDisk[];
/** Specifies whether an image is zone resilient or not. Default is false. Zone resilient images can be created only in regions that provide Zone Redundant Storage (ZRS). */
zoneResilient?: boolean;
}
/** Describes a image disk. */
export interface ImageDisk {
/** The snapshot. */
snapshot?: SubResource;
/** The managedDisk. */
managedDisk?: SubResource;
/** The Virtual Hard Disk. */
blobUri?: string;
/** Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The default values are: **None for Standard storage. ReadOnly for Premium storage.** */
caching?: CachingTypes;
/** Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image. This value cannot be larger than 1023 GB. */
diskSizeGB?: number;
/** Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk. */
storageAccountType?: StorageAccountTypes;
/** Specifies the customer managed disk encryption set resource id for the managed image disk. */
diskEncryptionSet?: DiskEncryptionSetParameters;
}
/** The complex type of the extended location. */
export interface ExtendedLocation {
/** The name of the extended location. */
name?: string;
/** The type of the extended location. */
type?: ExtendedLocationTypes;
}
/** Used for establishing the purchase context of any 3rd Party artifact through MarketPlace. */
export interface PurchasePlan {
/** The publisher ID. */
publisher: string;
/** The plan ID. */
name: string;
/** Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. */
product: string;
}
/** Contains the os disk image information. */
export interface OSDiskImage {
/** The operating system of the osDiskImage. */
operatingSystem: OperatingSystemTypes;
}
/** Contains the data disk images information. */
export interface DataDiskImage {
/**
* Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly lun?: number;
}
/** Describes automatic OS upgrade properties on the image. */
export interface AutomaticOSUpgradeProperties {
/** Specifies whether automatic OS upgrade is supported on the image. */
automaticOSUpgradeSupported: boolean;
}
/** Specifies the disallowed configuration for a virtual machine image. */
export interface DisallowedConfiguration {
/** VM disk types which are disallowed. */
vmDiskType?: VmDiskTypes;
}
/** Specifies additional capabilities supported by the image */
export interface VirtualMachineImageFeature {
/** The name of the feature. */
name?: string;
/** The corresponding value for the feature. */
value?: string;
}
/** Describes image deprecation status properties on the image. */
export interface ImageDeprecationStatus {
/** Describes the state of the image. */
imageState?: ImageState;
/** The time, in future, at which this image will be marked as deprecated. This scheduled time is chosen by the Publisher. */
scheduledDeprecationTime?: Date;
/** Describes the alternative option specified by the Publisher for this image when this image is deprecated. */
alternativeOption?: AlternativeOption;
}
/** Describes the alternative option specified by the Publisher for this image when this image is deprecated. */
export interface AlternativeOption {
/** Describes the type of the alternative option. */
type?: AlternativeType;
/** Indicates the alternative option value specified by the Publisher. This is the Offer name when the type is Offer or the Plan name when the type is Plan. */
value?: string;
}
/** The List VmImages in EdgeZone operation response. */
export interface VmImagesInEdgeZoneListResult {
/** The list of VMImages in EdgeZone */
value?: VirtualMachineImageResource[];
/** The URI to fetch the next page of VMImages in EdgeZone. Call ListNext() with this URI to fetch the next page of VmImages. */
nextLink?: string;
}
/** Api input base class for LogAnalytics Api. */
export interface LogAnalyticsInputBase {
/** SAS Uri of the logging blob container to which LogAnalytics Api writes output logs to. */
blobContainerSasUri: string;
/** From time of the query */
fromTime: Date;
/** To time of the query */
toTime: Date;
/** Group query result by Throttle Policy applied. */
groupByThrottlePolicy?: boolean;
/** Group query result by Operation Name. */
groupByOperationName?: boolean;
/** Group query result by Resource Name. */
groupByResourceName?: boolean;
/** Group query result by Client Application ID. */
groupByClientApplicationId?: boolean;
/** Group query result by User Agent. */
groupByUserAgent?: boolean;
}
/** LogAnalytics operation status response */
export interface LogAnalyticsOperationResult {
/**
* LogAnalyticsOutput
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly properties?: LogAnalyticsOutput;
}
/** LogAnalytics output properties */
export interface LogAnalyticsOutput {
/**
* Output file Uri path to blob container.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly output?: string;
}
/** The List Virtual Machine operation response. */
export interface RunCommandListResult {
/** The list of virtual machine run commands. */
value: RunCommandDocumentBase[];
/** The uri to fetch the next page of run commands. Call ListNext() with this to fetch the next page of run commands. */
nextLink?: string;
}
/** Describes the properties of a Run Command metadata. */
export interface RunCommandDocumentBase {
/** The VM run command schema. */
schema: string;
/** The VM run command id. */
id: string;
/** The Operating System type. */
osType: OperatingSystemTypes;
/** The VM run command label. */
label: string;
/** The VM run command description. */
description: string;
}
/** Describes the properties of a run command parameter. */
export interface RunCommandParameterDefinition {
/** The run command parameter name. */
name: string;
/** The run command parameter type. */
type: string;
/** The run command parameter default value. */
defaultValue?: string;
/** The run command parameter required. */
required?: boolean;
}
/** The List Usages operation response. */
export interface ListUsagesResult {
/** The list of compute resource usages. */
value: Usage[];
/** The URI to fetch the next page of compute resource usage information. Call ListNext() with this to fetch the next page of compute resource usage information. */
nextLink?: string;
}
/** Describes Compute Resource Usage. */
export interface Usage {
/** An enum describing the unit of usage measurement. */
unit: "Count";
/** The current usage of the resource. */
currentValue: number;
/** The maximum permitted usage of the resource. */
limit: number;
/** The name of the type of usage. */
name: UsageName;
}
/** The Usage Names. */
export interface UsageName {
/** The name of the resource. */
value?: string;
/** The localized name of the resource. */
localizedValue?: string;
}
/** The List Virtual Machine operation response. */
export interface VirtualMachineScaleSetListResult {
/** The list of virtual machine scale sets. */
value: VirtualMachineScaleSet[];
/** The uri to fetch the next page of Virtual Machine Scale Sets. Call ListNext() with this to fetch the next page of VMSS. */
nextLink?: string;
}
/** Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**. */
export interface Plan {
/** The plan ID. */
name?: string;
/** The publisher ID. */
publisher?: string;
/** Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. */
product?: string;
/** The promotion code. */
promotionCode?: string;
}
/** Describes an upgrade policy - automatic, manual, or rolling. */
export interface UpgradePolicy {
/** Specifies the mode of an upgrade to virtual machines in the scale set. Possible values are: **Manual** - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action. **Automatic** - All virtual machines in the scale set are automatically updated at the same time. */
mode?: UpgradeMode;
/** The configuration parameters used while performing a rolling upgrade. */
rollingUpgradePolicy?: RollingUpgradePolicy;
/** Configuration parameters used for performing automatic OS Upgrade. */
automaticOSUpgradePolicy?: AutomaticOSUpgradePolicy;
}
/** The configuration parameters used while performing a rolling upgrade. */
export interface RollingUpgradePolicy {
/** The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The default value for this parameter is 20%. */
maxBatchInstancePercent?: number;
/** The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The default value for this parameter is 20%. */
maxUnhealthyInstancePercent?: number;
/** The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The default value for this parameter is 20%. */
maxUnhealthyUpgradedInstancePercent?: number;
/** The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format. The default value is 0 seconds (PT0S). */
pauseTimeBetweenBatches?: string;
/** Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size. */
enableCrossZoneUpgrade?: boolean;
/** Upgrade all unhealthy instances in a scale set before any healthy instances. */
prioritizeUnhealthyInstances?: boolean;
/** Rollback failed instances to previous model if the Rolling Upgrade policy is violated. */
rollbackFailedInstancesOnPolicyBreach?: boolean;
/** Create new virtual machines to upgrade the scale set, rather than updating the existing virtual machines. Existing virtual machines will be deleted once the new virtual machines are created for each batch. */
maxSurge?: boolean;
}
/** The configuration parameters used for performing automatic OS upgrade. */
export interface AutomaticOSUpgradePolicy {
/** Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available. Default value is false. If this is set to true for Windows based scale sets, [enableAutomaticUpdates](https://docs.microsoft.com/dotnet/api/microsoft.azure.management.compute.models.windowsconfiguration.enableautomaticupdates?view=azure-dotnet) is automatically set to false and cannot be set to true. */
enableAutomaticOSUpgrade?: boolean;
/** Whether OS image rollback feature should be disabled. Default value is false. */
disableAutomaticRollback?: boolean;
/** Indicates whether rolling upgrade policy should be used during Auto OS Upgrade. Default value is false. Auto OS Upgrade will fallback to the default policy if no policy is defined on the VMSS. */
useRollingUpgradePolicy?: boolean;
/** Indicates whether Auto OS Upgrade should undergo deferral. Deferred OS upgrades will send advanced notifications on a per-VM basis that an OS upgrade from rolling upgrades is incoming, via the IMDS tag 'Platform.PendingOSUpgrade'. The upgrade then defers until the upgrade is approved via an ApproveRollingUpgrade call. */
osRollingUpgradeDeferral?: boolean;
}
/** Specifies the configuration parameters for automatic repairs on the virtual machine scale set. */
export interface AutomaticRepairsPolicy {
/** Specifies whether automatic repairs should be enabled on the virtual machine scale set. The default value is false. */
enabled?: boolean;
/** The amount of time for which automatic repairs are suspended due to a state change on VM. The grace time starts after the state change has completed. This helps avoid premature or accidental repairs. The time duration should be specified in ISO 8601 format. The minimum allowed grace period is 10 minutes (PT10M), which is also the default value. The maximum allowed grace period is 90 minutes (PT90M). */
gracePeriod?: string;
/** Type of repair action (replace, restart, reimage) that will be used for repairing unhealthy virtual machines in the scale set. Default value is replace. */
repairAction?: RepairAction;
}
/** Describes a virtual machine scale set virtual machine profile. */
export interface VirtualMachineScaleSetVMProfile {
/** Specifies the operating system settings for the virtual machines in the scale set. */
osProfile?: VirtualMachineScaleSetOSProfile;
/** Specifies the storage settings for the virtual machine disks. */
storageProfile?: VirtualMachineScaleSetStorageProfile;
/** Specifies properties of the network interfaces of the virtual machines in the scale set. */
networkProfile?: VirtualMachineScaleSetNetworkProfile;
/** Specifies the Security related profile settings for the virtual machines in the scale set. */
securityProfile?: SecurityProfile;
/** Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15. */
diagnosticsProfile?: DiagnosticsProfile;
/** Specifies a collection of settings for extensions installed on virtual machines in the scale set. */
extensionProfile?: VirtualMachineScaleSetExtensionProfile;
/** Specifies that the image or disk that is being used was licensed on-premises. Possible values for Windows Server operating system are: Windows_Client Windows_Server Possible values for Linux Server operating system are: RHEL_BYOS (for RHEL) SLES_BYOS (for SUSE) For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing) [Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux) Minimum api-version: 2015-06-15 */
licenseType?: string;
/** Specifies the priority for the virtual machines in the scale set. Minimum api-version: 2017-10-30-preview. */
priority?: VirtualMachinePriorityTypes;
/** Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set. For Azure Spot virtual machines, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2019-03-01. For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview. */
evictionPolicy?: VirtualMachineEvictionPolicyTypes;
/** Specifies the billing related details of a Azure Spot VMSS. Minimum api-version: 2019-03-01. */
billingProfile?: BillingProfile;
/** Specifies Scheduled Event related configurations. */
scheduledEventsProfile?: ScheduledEventsProfile;
/** UserData for the virtual machines in the scale set, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01. */
userData?: string;
/** Specifies the capacity reservation related details of a scale set. Minimum api-version: 2021-04-01. */
capacityReservation?: CapacityReservationProfile;
/** Specifies the gallery applications that should be made available to the VM/VMSS */
applicationProfile?: ApplicationProfile;
/** Specifies the hardware profile related details of a scale set. Minimum api-version: 2021-11-01. */
hardwareProfile?: VirtualMachineScaleSetHardwareProfile;
/** Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version. Minimum api-version: 2022-11-01 */
serviceArtifactReference?: ServiceArtifactReference;
/** Specifies the security posture to be used in the scale set. Minimum api-version: 2023-03-01 */
securityPostureReference?: SecurityPostureReference;
/**
* Specifies the time in which this VM profile for the Virtual Machine Scale Set was created. This value will be added to VMSS Flex VM tags when creating/updating the VMSS VM Profile. Minimum API version for this property is 2023-09-01.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly timeCreated?: Date;
}
/** Describes a virtual machine scale set OS profile. */
export interface VirtualMachineScaleSetOSProfile {
/** Specifies the computer name prefix for all of the virtual machines in the scale set. Computer name prefixes must be 1 to 15 characters long. */
computerNamePrefix?: string;
/** Specifies the name of the administrator account. **Windows-only restriction:** Cannot end in "." **Disallowed values:** "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5". **Minimum-length (Linux):** 1 character **Max-length (Linux):** 64 characters **Max-length (Windows):** 20 characters */
adminUsername?: string;
/**
* Specifies the password of the administrator account. **Minimum-length (Windows):** 8 characters **Minimum-length (Linux):** 6 characters **Max-length (Windows):** 123 characters **Max-length (Linux):** 72 characters **Complexity requirements:** 3 out of 4 conditions below need to be fulfilled Has lower characters Has upper characters Has a digit Has a special character (Regex match [\W_]) **Disallowed values:** "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!" For resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows VM](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/reset-rdp) For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection)
* This value contains a credential. Consider obscuring before showing to users
*/
adminPassword?: string;
/** Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes. For using cloud-init for your VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/linux/using-cloud-init) */
customData?: string;
/** Specifies Windows operating system settings on the virtual machine. */
windowsConfiguration?: WindowsConfiguration;
/** Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/linux/endorsed-distros). */
linuxConfiguration?: LinuxConfiguration;
/** Specifies set of certificates that should be installed onto the virtual machines in the scale set. To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). */
secrets?: VaultSecretGroup[];
/** Specifies whether extension operations should be allowed on the virtual machine scale set. This may only be set to False when no extensions are present on the virtual machine scale set. */
allowExtensionOperations?: boolean;
/** Optional property which must either be set to True or omitted. */
requireGuestProvisionSignal?: boolean;
}
/** Specifies Windows operating system settings on the virtual machine. */
export interface WindowsConfiguration {
/** Indicates whether virtual machine agent should be provisioned on the virtual machine. When this property is not specified in the request body, it is set to true by default. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later. */
provisionVMAgent?: boolean;
/** Indicates whether Automatic Updates is enabled for the Windows virtual machine. Default value is true. For virtual machine scale sets, this property can be updated and updates will take effect on OS reprovisioning. */
enableAutomaticUpdates?: boolean;
/** Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time". Possible values can be [TimeZoneInfo.Id](https://docs.microsoft.com/dotnet/api/system.timezoneinfo.id?#System_TimeZoneInfo_Id) value from time zones returned by [TimeZoneInfo.GetSystemTimeZones](https://docs.microsoft.com/dotnet/api/system.timezoneinfo.getsystemtimezones). */
timeZone?: string;
/** Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. */
additionalUnattendContent?: AdditionalUnattendContent[];
/** [Preview Feature] Specifies settings related to VM Guest Patching on Windows. */
patchSettings?: PatchSettings;
/** Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell. */
winRM?: WinRMConfiguration;
/**
* Indicates whether VMAgent Platform Updates are enabled for the Windows Virtual Machine.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly enableVMAgentPlatformUpdates?: boolean;
}
/** Specifies additional XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. Contents are defined by setting name, component name, and the pass in which the content is applied. */
export interface AdditionalUnattendContent {
/** The pass name. Currently, the only allowable value is OobeSystem. */
passName?: "OobeSystem";
/** The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. */
componentName?: "Microsoft-Windows-Shell-Setup";
/** Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. */
settingName?: SettingNames;
/** Specifies the XML formatted content that is added to the unattend.xml file for the specified path and component. The XML must be less than 4KB and must include the root element for the setting or feature that is being inserted. */
content?: string;
}
/** Specifies settings related to VM Guest Patching on Windows. */
export interface PatchSettings {
/** Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible. Possible values are: **Manual** - You control the application of patches to a virtual machine. You do this by applying patches manually inside the VM. In this mode, automatic updates are disabled; the property WindowsConfiguration.enableAutomaticUpdates must be false **AutomaticByOS** - The virtual machine will automatically be updated by the OS. The property WindowsConfiguration.enableAutomaticUpdates must be true. **AutomaticByPlatform** - the virtual machine will automatically updated by the platform. The properties provisionVMAgent and WindowsConfiguration.enableAutomaticUpdates must be true */
patchMode?: WindowsVMGuestPatchMode;
/** Enables customers to patch their Azure VMs without requiring a reboot. For enableHotpatching, the 'provisionVMAgent' must be set to true and 'patchMode' must be set to 'AutomaticByPlatform'. */
enableHotpatching?: boolean;
/** Specifies the mode of VM Guest patch assessment for the IaaS virtual machine. Possible values are: **ImageDefault** - You control the timing of patch assessments on a virtual machine. **AutomaticByPlatform** - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true. */
assessmentMode?: WindowsPatchAssessmentMode;
/** Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Windows. */
automaticByPlatformSettings?: WindowsVMGuestPatchAutomaticByPlatformSettings;
}
/** Specifies additional settings to be applied when patch mode AutomaticByPlatform is selected in Windows patch settings. */
export interface WindowsVMGuestPatchAutomaticByPlatformSettings {
/** Specifies the reboot setting for all AutomaticByPlatform patch installation operations. */
rebootSetting?: WindowsVMGuestPatchAutomaticByPlatformRebootSetting;
/** Enables customer to schedule patching without accidental upgrades */
bypassPlatformSafetyChecksOnUserSchedule?: boolean;
}
/** Describes Windows Remote Management configuration of the VM */
export interface WinRMConfiguration {
/** The list of Windows Remote Management listeners */
listeners?: WinRMListener[];
}
/** Describes Protocol and thumbprint of Windows Remote Management listener */
export interface WinRMListener {
/** Specifies the protocol of WinRM listener. Possible values are: **http,** **https.** */
protocol?: ProtocolTypes;
/** This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be the Base64 encoding of the following JSON Object which is encoded in UTF-8: { "data":"<Base64-encoded-certificate>", "dataType":"pfx", "password":"<pfx-file-password>" } To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). */
certificateUrl?: string;
}
/** Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/linux/endorsed-distros). */
export interface LinuxConfiguration {
/** Specifies whether password authentication should be disabled. */
disablePasswordAuthentication?: boolean;
/** Specifies the ssh key configuration for a Linux OS. */
ssh?: SshConfiguration;
/** Indicates whether virtual machine agent should be provisioned on the virtual machine. When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later. */
provisionVMAgent?: boolean;
/** [Preview Feature] Specifies settings related to VM Guest Patching on Linux. */
patchSettings?: LinuxPatchSettings;
/** Indicates whether VMAgent Platform Updates is enabled for the Linux virtual machine. Default value is false. */
enableVMAgentPlatformUpdates?: boolean;
}
/** SSH configuration for Linux based VMs running on Azure */
export interface SshConfiguration {
/** The list of SSH public keys used to authenticate with linux based VMs. */
publicKeys?: SshPublicKey[];
}
/** Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed. */
export interface SshPublicKey {
/** Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys */
path?: string;
/** SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format. For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed). */
keyData?: string;
}
/** Specifies settings related to VM Guest Patching on Linux. */
export interface LinuxPatchSettings {
/** Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible. Possible values are: **ImageDefault** - The virtual machine's default patching configuration is used. **AutomaticByPlatform** - The virtual machine will be automatically updated by the platform. The property provisionVMAgent must be true */
patchMode?: LinuxVMGuestPatchMode;
/** Specifies the mode of VM Guest Patch Assessment for the IaaS virtual machine. Possible values are: **ImageDefault** - You control the timing of patch assessments on a virtual machine. **AutomaticByPlatform** - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true. */
assessmentMode?: LinuxPatchAssessmentMode;
/** Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Linux. */
automaticByPlatformSettings?: LinuxVMGuestPatchAutomaticByPlatformSettings;
}
/** Specifies additional settings to be applied when patch mode AutomaticByPlatform is selected in Linux patch settings. */
export interface LinuxVMGuestPatchAutomaticByPlatformSettings {
/** Specifies the reboot setting for all AutomaticByPlatform patch installation operations. */
rebootSetting?: LinuxVMGuestPatchAutomaticByPlatformRebootSetting;
/** Enables customer to schedule patching without accidental upgrades */
bypassPlatformSafetyChecksOnUserSchedule?: boolean;
}
/** Describes a set of certificates which are all in the same Key Vault. */
export interface VaultSecretGroup {
/** The relative URL of the Key Vault containing all of the certificates in VaultCertificates. */
sourceVault?: SubResource;
/** The list of key vault references in SourceVault which contain certificates. */
vaultCertificates?: VaultCertificate[];
}
/** Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM. */
export interface VaultCertificate {
/** This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8: { "data":"<Base64-encoded-certificate>", "dataType":"pfx", "password":"<pfx-file-password>" } To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). */
certificateUrl?: string;
/** For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account. For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name &lt;UppercaseThumbprint&gt;.crt for the X509 certificate file and &lt;UppercaseThumbprint&gt;.prv for private key. Both of these files are .pem formatted. */
certificateStore?: string;
}
/** Describes a virtual machine scale set storage profile. */
export interface VirtualMachineScaleSetStorageProfile {
/** Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. */
imageReference?: ImageReference;
/** Specifies information about the operating system disk used by the virtual machines in the scale set. For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview). */
osDisk?: VirtualMachineScaleSetOSDisk;
/** Specifies the parameters that are used to add data disks to the virtual machines in the scale set. For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview). */
dataDisks?: VirtualMachineScaleSetDataDisk[];
/** Specifies the disk controller type configured for the virtual machines in the scale set. Minimum api-version: 2022-08-01 */
diskControllerType?: DiskControllerTypes;
}
/** Describes a virtual machine scale set operating system disk. */
export interface VirtualMachineScaleSetOSDisk {
/** The disk name. */
name?: string;
/** Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The default values are: **None for Standard storage. ReadOnly for Premium storage.** */
caching?: CachingTypes;
/** Specifies whether writeAccelerator should be enabled or disabled on the disk. */
writeAcceleratorEnabled?: boolean;
/** Specifies how the virtual machines in the scale set should be created. The only allowed value is: **FromImage.** This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described. */
createOption: DiskCreateOptionTypes;
/** Specifies the ephemeral disk Settings for the operating system disk used by the virtual machine scale set. */
diffDiskSettings?: DiffDiskSettings;
/** Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023. */
diskSizeGB?: number;
/** This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD. Possible values are: **Windows,** **Linux.** */
osType?: OperatingSystemTypes;
/** Specifies information about the unmanaged user image to base the scale set on. */
image?: VirtualHardDisk;
/** Specifies the container urls that are used to store operating system disks for the scale set. */
vhdContainers?: string[];
/** The managed disk parameters. */
managedDisk?: VirtualMachineScaleSetManagedDiskParameters;
/** Specifies whether OS Disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only). Possible values: **Delete** If this value is used, the OS disk is deleted when VMSS Flex VM is deleted. **Detach** If this value is used, the OS disk is retained after VMSS Flex VM is deleted. The default value is set to **Delete**. For an Ephemeral OS Disk, the default value is set to **Delete**. User cannot change the delete option for Ephemeral OS Disk. */
deleteOption?: DiskDeleteOptionTypes;
}
/** Describes the parameters of ephemeral disk settings that can be specified for operating system disk. **Note:** The ephemeral disk settings can only be specified for managed disk. */
export interface DiffDiskSettings {
/** Specifies the ephemeral disk settings for operating system disk. */
option?: DiffDiskOptions;
/** Specifies the ephemeral disk placement for operating system disk. Possible values are: **CacheDisk,** **ResourceDisk,** **NvmeDisk.** The defaulting behavior is: **CacheDisk** if one is configured for the VM size otherwise **ResourceDisk** or **NvmeDisk** is used. Refer to the VM size documentation for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk. Minimum api-version for NvmeDisk: 2024-03-01. */
placement?: DiffDiskPlacement;
}
/** Describes the uri of a disk. */
export interface VirtualHardDisk {
/** Specifies the virtual hard disk's uri. */
uri?: string;
}
/** Describes the parameters of a ScaleSet managed disk. */
export interface VirtualMachineScaleSetManagedDiskParameters {
/** Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk. */
storageAccountType?: StorageAccountTypes;
/** Specifies the customer managed disk encryption set resource id for the managed disk. */
diskEncryptionSet?: DiskEncryptionSetParameters;
/** Specifies the security profile for the managed disk. */
securityProfile?: VMDiskSecurityProfile;
}
/** Specifies the security profile settings for the managed disk. **Note:** It can only be set for Confidential VMs. */
export interface VMDiskSecurityProfile {
/** Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob.. **Note:** It can be set for only Confidential VMs. */
securityEncryptionType?: SecurityEncryptionTypes;
/** Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob. */
diskEncryptionSet?: DiskEncryptionSetParameters;
}
/** Describes a virtual machine scale set data disk. */
export interface VirtualMachineScaleSetDataDisk {
/** The disk name. */
name?: string;
/** Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM. */
lun: number;
/** Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The default values are: **None for Standard storage. ReadOnly for Premium storage.** */
caching?: CachingTypes;
/** Specifies whether writeAccelerator should be enabled or disabled on the disk. */
writeAcceleratorEnabled?: boolean;
/** The create option. */
createOption: DiskCreateOptionTypes;
/** Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property diskSizeGB is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023. */
diskSizeGB?: number;
/** The managed disk parameters. */
managedDisk?: VirtualMachineScaleSetManagedDiskParameters;
/** Specifies the Read-Write IOPS for the managed disk. Should be used only when StorageAccountType is UltraSSD_LRS. If not specified, a default value would be assigned based on diskSizeGB. */
diskIopsReadWrite?: number;
/** Specifies the bandwidth in MB per second for the managed disk. Should be used only when StorageAccountType is UltraSSD_LRS. If not specified, a default value would be assigned based on diskSizeGB. */
diskMBpsReadWrite?: number;
/** Specifies whether data disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only). Possible values: **Delete** If this value is used, the data disk is deleted when the VMSS Flex VM is deleted. **Detach** If this value is used, the data disk is retained after VMSS Flex VM is deleted. The default value is set to **Delete**. */
deleteOption?: DiskDeleteOptionTypes;
}
/** Describes a virtual machine scale set network profile. */
export interface VirtualMachineScaleSetNetworkProfile {
/** A reference to a load balancer probe used to determine the health of an instance in the virtual machine scale set. The reference will be in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'. */
healthProbe?: ApiEntityReference;
/** The list of network configurations. */
networkInterfaceConfigurations?: VirtualMachineScaleSetNetworkConfiguration[];
/** specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations for Virtual Machine Scale Set with orchestration mode 'Flexible' */
networkApiVersion?: NetworkApiVersion;
}
/** The API entity reference. */
export interface ApiEntityReference {
/** The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... */
id?: string;
}
/** Describes a virtual machine scale set network profile's network configurations. */
export interface VirtualMachineScaleSetNetworkConfiguration {
/** The network configuration name. */
name: string;
/** Resource tags applied to the networkInterface address created by this NetworkInterfaceConfiguration */
tags?: {
[propertyName: string]: string;
};
/** Specifies the primary network interface in case the virtual machine has more than 1 network interface. */
primary?: boolean;
/** Specifies whether the network interface is accelerated networking-enabled. */
enableAcceleratedNetworking?: boolean;
/** Specifies whether the network interface is disabled for tcp state tracking. */
disableTcpStateTracking?: boolean;
/** Specifies whether the network interface is FPGA networking-enabled. */
enableFpga?: boolean;
/** The network security group. */
networkSecurityGroup?: SubResource;
/** The dns settings to be applied on the network interfaces. */
dnsSettings?: VirtualMachineScaleSetNetworkConfigurationDnsSettings;
/** Specifies the IP configurations of the network interface. */
ipConfigurations?: VirtualMachineScaleSetIPConfiguration[];
/** Whether IP forwarding enabled on this NIC. */
enableIPForwarding?: boolean;
/** Specify what happens to the network interface when the VM is deleted */
deleteOption?: DeleteOptions;
/** Specifies whether the Auxiliary mode is enabled for the Network Interface resource. */
auxiliaryMode?: NetworkInterfaceAuxiliaryMode;
/** Specifies whether the Auxiliary sku is enabled for the Network Interface resource. */
auxiliarySku?: NetworkInterfaceAuxiliarySku;
}
/** Describes a virtual machines scale sets network configuration's DNS settings. */
export interface VirtualMachineScaleSetNetworkConfigurationDnsSettings {
/** List of DNS servers IP addresses */
dnsServers?: string[];
}
/** Describes a virtual machine scale set network profile's IP configuration. */
export interface VirtualMachineScaleSetIPConfiguration {
/** The IP configuration name. */
name: string;
/** Specifies the identifier of the subnet. */
subnet?: ApiEntityReference;
/** Specifies the primary network interface in case the virtual machine has more than 1 network interface. */
primary?: boolean;
/** The publicIPAddressConfiguration. */
publicIPAddressConfiguration?: VirtualMachineScaleSetPublicIPAddressConfiguration;
/** Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. */
privateIPAddressVersion?: IPVersion;
/** Specifies an array of references to backend address pools of application gateways. A scale set can reference backend address pools of multiple application gateways. Multiple scale sets cannot use the same application gateway. */
applicationGatewayBackendAddressPools?: SubResource[];
/** Specifies an array of references to application security group. */
applicationSecurityGroups?: SubResource[];
/** Specifies an array of references to backend address pools of load balancers. A scale set can reference backend address pools of one public and one internal load balancer. Multiple scale sets cannot use the same basic sku load balancer. */
loadBalancerBackendAddressPools?: SubResource[];
/** Specifies an array of references to inbound Nat pools of the load balancers. A scale set can reference inbound nat pools of one public and one internal load balancer. Multiple scale sets cannot use the same basic sku load balancer. */
loadBalancerInboundNatPools?: SubResource[];
}
/** Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration */
export interface VirtualMachineScaleSetPublicIPAddressConfiguration {
/** The publicIP address configuration name. */
name: string;
/** Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible. */
sku?: PublicIPAddressSku;
/** Resource tags applied to the publicIP address created by this PublicIPAddressConfiguration */
tags?: {
[propertyName: string]: string;
};
/** The idle timeout of the public IP address. */
idleTimeoutInMinutes?: number;
/** The dns settings to be applied on the publicIP addresses . */
dnsSettings?: VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings;
/** The list of IP tags associated with the public IP address. */
ipTags?: VirtualMachineScaleSetIpTag[];
/** The PublicIPPrefix from which to allocate publicIP addresses. */
publicIPPrefix?: SubResource;
/** Available from Api-Version 2019-07-01 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. */
publicIPAddressVersion?: IPVersion;
/** Specify what happens to the public IP when the VM is deleted */
deleteOption?: DeleteOptions;
}
/** Describes a virtual machines scale sets network configuration's DNS settings. */
export interface VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings {
/** The Domain name label.The concatenation of the domain name label and vm index will be the domain name labels of the PublicIPAddress resources that will be created */
domainNameLabel: string;
/** The Domain name label scope.The concatenation of the hashed domain name label that generated according to the policy from domain name label scope and vm index will be the domain name labels of the PublicIPAddress resources that will be created */
domainNameLabelScope?: DomainNameLabelScopeTypes;
}
/** Contains the IP tag associated with the public IP address. */
export interface VirtualMachineScaleSetIpTag {
/** IP tag type. Example: FirstPartyUsage. */
ipTagType?: string;
/** IP tag associated with the public IP. Example: SQL, Storage etc. */
tag?: string;
}
/** Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible. */
export interface PublicIPAddressSku {
/** Specify public IP sku name */
name?: PublicIPAddressSkuName;
/** Specify public IP sku tier */
tier?: PublicIPAddressSkuTier;
}
/** Specifies the Security profile settings for the virtual machine or virtual machine scale set. */
export interface SecurityProfile {
/** Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum api-version: 2020-12-01. */
uefiSettings?: UefiSettings;
/** This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself. The default behavior is: The Encryption at host will be disabled unless this property is set to true for the resource. */
encryptionAtHost?: boolean;
/** Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. The default behavior is: UefiSettings will not be enabled unless this property is set. */
securityType?: SecurityTypes;
/** Specifies the Managed Identity used by ADE to get access token for keyvault operations. */
encryptionIdentity?: EncryptionIdentity;
/** Specifies ProxyAgent settings while creating the virtual machine. Minimum api-version: 2023-09-01. */
proxyAgentSettings?: ProxyAgentSettings;
}
/** Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum api-version: 2020-12-01. */
export interface UefiSettings {
/** Specifies whether secure boot should be enabled on the virtual machine. Minimum api-version: 2020-12-01. */
secureBootEnabled?: boolean;
/** Specifies whether vTPM should be enabled on the virtual machine. Minimum api-version: 2020-12-01. */
vTpmEnabled?: boolean;
}
/** Specifies the Managed Identity used by ADE to get access token for keyvault operations. */
export interface EncryptionIdentity {
/** Specifies ARM Resource ID of one of the user identities associated with the VM. */
userAssignedIdentityResourceId?: string;
}
/** Specifies ProxyAgent settings for the virtual machine or virtual machine scale set. Minimum api-version: 2023-09-01. */
export interface ProxyAgentSettings {
/** Specifies whether ProxyAgent feature should be enabled on the virtual machine or virtual machine scale set. */
enabled?: boolean;
/** Specifies the mode that ProxyAgent will execute on. Warning: this property has been deprecated, please specify 'mode' under particular hostendpoint setting. */
mode?: Mode;
/** Increase the value of this property allows users to reset the key used for securing communication channel between guest and host. */
keyIncarnationId?: number;
/** Specifies the Wire Server endpoint settings while creating the virtual machine or virtual machine scale set. Minimum api-version: 2024-03-01. */
wireServer?: HostEndpointSettings;
/** Specifies the IMDS endpoint settings while creating the virtual machine or virtual machine scale set. Minimum api-version: 2024-03-01. */
imds?: HostEndpointSettings;
/** Specify whether to implicitly install the ProxyAgent Extension. This option is currently applicable only for Linux Os. */
addProxyAgentExtension?: boolean;
}
/** Specifies particular host endpoint settings. */
export interface HostEndpointSettings {
/** Specifies the execution mode. In Audit mode, the system acts as if it is enforcing the access control policy, including emitting access denial entries in the logs but it does not actually deny any requests to host endpoints. In Enforce mode, the system will enforce the access control and it is the recommended mode of operation. */
mode?: Modes;
/** Specifies the InVMAccessControlProfileVersion resource id in the format of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{profile}/versions/{version} */
inVMAccessControlProfileReferenceId?: string;
}
/** Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15. */
export interface DiagnosticsProfile {
/** Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. **NOTE**: If storageUri is being specified then ensure that the storage account is in the same region and subscription as the VM. You can easily view the output of your console log. Azure also enables you to see a screenshot of the VM from the hypervisor. */
bootDiagnostics?: BootDiagnostics;
}
/** Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. You can easily view the output of your console log. Azure also enables you to see a screenshot of the VM from the hypervisor. */
export interface BootDiagnostics {
/** Whether boot diagnostics should be enabled on the Virtual Machine. */
enabled?: boolean;
/** Uri of the storage account to use for placing the console output and screenshot. If storageUri is not specified while enabling boot diagnostics, managed storage will be used. */
storageUri?: string;
}
/** Describes a virtual machine scale set extension profile. */
export interface VirtualMachineScaleSetExtensionProfile {
/** The virtual machine scale set child extension resources. */
extensions?: VirtualMachineScaleSetExtension[];
/** Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M). Minimum api-version: 2020-06-01. */
extensionsTimeBudget?: string;
}
/** Describes a reference to Key Vault Secret */
export interface KeyVaultSecretReference {
/** The URL referencing a secret in a Key Vault. */
secretUrl: string;
/** The relative URL of the Key Vault containing the secret. */
sourceVault: SubResource;
}
/** Specifies the billing related details of a Azure Spot VM or VMSS. Minimum api-version: 2019-03-01. */
export interface BillingProfile {
/** Specifies the maximum price you are willing to pay for a Azure Spot VM/VMSS. This price is in US Dollars. This price will be compared with the current Azure Spot price for the VM size. Also, the prices are compared at the time of create/update of Azure Spot VM/VMSS and the operation will only succeed if the maxPrice is greater than the current Azure Spot price. The maxPrice will also be used for evicting a Azure Spot VM/VMSS if the current Azure Spot price goes beyond the maxPrice after creation of VM/VMSS. Possible values are: - Any decimal value greater than zero. Example: 0.01538 -1 – indicates default price to be up-to on-demand. You can set the maxPrice to -1 to indicate that the Azure Spot VM/VMSS should not be evicted for price reasons. Also, the default max price is -1 if it is not provided by you. Minimum api-version: 2019-03-01. */
maxPrice?: number;
}
export interface ScheduledEventsProfile {
/** Specifies Terminate Scheduled Event related configurations. */
terminateNotificationProfile?: TerminateNotificationProfile;
/** Specifies OS Image Scheduled Event related configurations. */
osImageNotificationProfile?: OSImageNotificationProfile;
}
export interface TerminateNotificationProfile {
/** Configurable length of time a Virtual Machine being deleted will have to potentially approve the Terminate Scheduled Event before the event is auto approved (timed out). The configuration must be specified in ISO 8601 format, the default value is 5 minutes (PT5M) */
notBeforeTimeout?: string;
/** Specifies whether the Terminate Scheduled event is enabled or disabled. */
enable?: boolean;
}
export interface OSImageNotificationProfile {
/** Length of time a Virtual Machine being reimaged or having its OS upgraded will have to potentially approve the OS Image Scheduled Event before the event is auto approved (timed out). The configuration is specified in ISO 8601 format, and the value must be 15 minutes (PT15M) */
notBeforeTimeout?: string;
/** Specifies whether the OS Image Scheduled event is enabled or disabled. */
enable?: boolean;
}
/** The parameters of a capacity reservation Profile. */
export interface CapacityReservationProfile {
/** Specifies the capacity reservation group resource id that should be used for allocating the virtual machine or scaleset vm instances provided enough capacity has been reserved. Please refer to https://aka.ms/CapacityReservation for more details. */
capacityReservationGroup?: SubResource;
}
/** Contains the list of gallery applications that should be made available to the VM/VMSS */
export interface ApplicationProfile {
/** Specifies the gallery applications that should be made available to the VM/VMSS */
galleryApplications?: VMGalleryApplication[];
}
/** Specifies the required information to reference a compute gallery application version */
export interface VMGalleryApplication {
/** Optional, Specifies a passthrough value for more generic context. */
tags?: string;
/** Optional, Specifies the order in which the packages have to be installed */
order?: number;
/** Specifies the GalleryApplicationVersion resource id on the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version} */
packageReferenceId: string;
/** Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided */
configurationReference?: string;
/** Optional, If true, any failure for any operation in the VmApplication will fail the deployment */
treatFailureAsDeploymentFailure?: boolean;
/** If set to true, when a new Gallery Application version is available in PIR/SIG, it will be automatically updated for the VM/VMSS */
enableAutomaticUpgrade?: boolean;
}
/** Specifies the hardware settings for the virtual machine scale set. */
export interface VirtualMachineScaleSetHardwareProfile {
/** Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-11-01. Please follow the instructions in [VM Customization](https://aka.ms/vmcustomization) for more details. */
vmSizeProperties?: VMSizeProperties;
}
/** Specifies VM Size Property settings on the virtual machine. */
export interface VMSizeProperties {
/** Specifies the number of vCPUs available for the VM. When this property is not specified in the request body the default behavior is to set it to the value of vCPUs available for that VM size exposed in api response of [List all available virtual machine sizes in a region](https://docs.microsoft.com/en-us/rest/api/compute/resource-skus/list). */
vCPUsAvailable?: number;
/** Specifies the vCPU to physical core ratio. When this property is not specified in the request body the default behavior is set to the value of vCPUsPerCore for the VM Size exposed in api response of [List all available virtual machine sizes in a region](https://docs.microsoft.com/en-us/rest/api/compute/resource-skus/list). **Setting this property to 1 also means that hyper-threading is disabled.** */
vCPUsPerCore?: number;
}
/** Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version. Minimum api-version: 2022-11-01 */
export interface ServiceArtifactReference {
/** The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} */
id?: string;
}
/** Specifies the security posture to be used in the scale set. Minimum api-version: 2023-03-01 */
export interface SecurityPostureReference {
/** The security posture reference id in the form of /CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|latest */
id: string;
/** The list of virtual machine extension names to exclude when applying the security posture. */
excludeExtensions?: string[];
/** Whether the security posture can be overridden by the user. */
isOverridable?: boolean;
}
/** Enables or disables a capability on the virtual machine or virtual machine scale set. */
export interface AdditionalCapabilities {
/** The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the VM or VMSS. Managed disks with storage account type UltraSSD_LRS can be added to a virtual machine or virtual machine scale set only if this property is enabled. */
ultraSSDEnabled?: boolean;
/** The flag that enables or disables hibernation capability on the VM. */
hibernationEnabled?: boolean;
/** The flag enables the usage of FIPS 140-3 compliant cryptography on the protectedSettings of an extension. Learn more at: https://aka.ms/linuxagentfipssupport. */
enableFips1403Encryption?: boolean;
}
/** Describes a scale-in policy for a virtual machine scale set. */
export interface ScaleInPolicy {
/** The rules to be followed when scaling-in a virtual machine scale set. Possible values are: **Default** When a virtual machine scale set is scaled in, the scale set will first be balanced across zones if it is a zonal scale set. Then, it will be balanced across Fault Domains as far as possible. Within each Fault Domain, the virtual machines chosen for removal will be the newest ones that are not protected from scale-in. **OldestVM** When a virtual machine scale set is being scaled-in, the oldest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the oldest virtual machines that are not protected will be chosen for removal. **NewestVM** When a virtual machine scale set is being scaled-in, the newest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the newest virtual machines that are not protected will be chosen for removal. */
rules?: VirtualMachineScaleSetScaleInRules[];
/** This property allows you to specify if virtual machines chosen for removal have to be force deleted when a virtual machine scale set is being scaled-in.(Feature in Preview) */
forceDeletion?: boolean;
/** This property allows you to prioritize the deletion of unhealthy and inactive VMs when a virtual machine scale set is being scaled-in.(Feature in Preview) */
prioritizeUnhealthyVMs?: boolean;
}
/** Specifies the Spot-Try-Restore properties for the virtual machine scale set. With this property customer can enable or disable automatic restore of the evicted Spot VMSS VM instances opportunistically based on capacity availability and pricing constraint. */
export interface SpotRestorePolicy {
/** Enables the Spot-Try-Restore feature where evicted VMSS SPOT instances will be tried to be restored opportunistically based on capacity availability and pricing constraints */
enabled?: boolean;
/** Timeout value expressed as an ISO 8601 time duration after which the platform will not try to restore the VMSS SPOT instances */
restoreTimeout?: string;
}
/** Specifies the target splits for Spot and Regular priority VMs within a scale set with flexible orchestration mode. With this property the customer is able to specify the base number of regular priority VMs created as the VMSS flex instance scales out and the split between Spot and Regular priority VMs after this base target has been reached. */
export interface PriorityMixPolicy {
/** The base number of regular priority VMs that will be created in this scale set as it scales out. */
baseRegularPriorityCount?: number;
/** The percentage of VM instances, after the base regular priority count has been reached, that are expected to use regular priority. */
regularPriorityPercentageAboveBase?: number;
}
/** Describes an resiliency policy - AutomaticZoneRebalancingPolicy, ResilientVMCreationPolicy and/or ResilientVMDeletionPolicy. */
export interface ResiliencyPolicy {
/** The configuration parameters used while performing resilient VM creation. */
resilientVMCreationPolicy?: ResilientVMCreationPolicy;
/** The configuration parameters used while performing resilient VM deletion. */
resilientVMDeletionPolicy?: ResilientVMDeletionPolicy;
/** The configuration parameters used while performing automatic AZ balancing. */
automaticZoneRebalancingPolicy?: AutomaticZoneRebalancingPolicy;
/** The configuration parameters used while performing zone allocation. */
zoneAllocationPolicy?: ZoneAllocationPolicy;
}
/** The configuration parameters used while performing resilient VM creation. */
export interface ResilientVMCreationPolicy {
/** Specifies whether resilient VM creation should be enabled on the virtual machine scale set. The default value is false. */
enabled?: boolean;
}
/** The configuration parameters used while performing resilient VM deletion. */
export interface ResilientVMDeletionPolicy {
/** Specifies whether resilient VM deletion should be enabled on the virtual machine scale set. The default value is false. */
enabled?: boolean;
}
/** The configuration parameters used while performing automatic AZ balancing. */
export interface AutomaticZoneRebalancingPolicy {
/** Specifies whether Automatic AZ Balancing should be enabled on the virtual machine scale set. The default value is false. */
enabled?: boolean;
/** Type of rebalance strategy that will be used for rebalancing virtual machines in the scale set across availability zones. Default and only supported value for now is Recreate. */
rebalanceStrategy?: RebalanceStrategy;
/** Type of rebalance behavior that will be used for recreating virtual machines in the scale set across availability zones. Default and only supported value for now is CreateBeforeDelete. */
rebalanceBehavior?: RebalanceBehavior;
}
/** The configuration parameters for zone allocation of a virtual machine scale set. */
export interface ZoneAllocationPolicy {
/** The maximum number of availability zones to use if the ZonePlacementPolicy is 'Auto'. If not specified, all availability zones will be used. */
maxZoneCount?: number;
/** The configuration parameters used to limit the number of virtual machines per availability zone in the virtual machine scale set. */
maxInstancePercentPerZonePolicy?: MaxInstancePercentPerZonePolicy;
}
/** The configuration parameters used to limit the number of virtual machines per availability zone in the virtual machine scale set. */
export interface MaxInstancePercentPerZonePolicy {
/** Specifies whether maxInstancePercentPerZonePolicy should be enabled on the virtual machine scale set. */
enabled?: boolean;
/** Limit on the number of instances in each zone as a percentage of the total capacity of the virtual machine scale set. */
value?: number;
}
/** Specifies the sku profile for the virtual machine scale set. With this property the customer is able to specify a list of VM sizes and an allocation strategy. */
export interface SkuProfile {
/** Specifies the VM sizes for the virtual machine scale set. */
vmSizes?: SkuProfileVMSize[];
/** Specifies the allocation strategy for the virtual machine scale set based on which the VMs will be allocated. */
allocationStrategy?: AllocationStrategy;
}
/** Specifies the VM Size. */
export interface SkuProfileVMSize {
/** Specifies the name of the VM Size. */
name?: string;
/** Specifies the rank (a.k.a priority) associated with the VM Size. */
rank?: number;
}
/** Identity for the virtual machine scale set. */
export interface VirtualMachineScaleSetIdentity {
/**
* The principal id of virtual machine scale set identity. This property will only be provided for a system assigned identity.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly principalId?: string;
/**
* The tenant id associated with the virtual machine scale set. This property will only be provided for a system assigned identity.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly tenantId?: string;
/** The type of identity used for the virtual machine scale set. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine scale set. */
type?: ResourceIdentityType;
/** The list of user identities associated with the virtual machine scale set. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. */
userAssignedIdentities?: {
[propertyName: string]: UserAssignedIdentitiesValue;
};
}
export interface UserAssignedIdentitiesValue {
/**
* The principal id of user assigned identity.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly principalId?: string;
/**
* The client id of user assigned identity.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly clientId?: string;
}
/** Describes the user-defined constraints for resource hardware placement. */
export interface Placement {
/** Specifies the policy for resource's placement in availability zone. Possible values are: **Any** (used for Virtual Machines), **Auto** (used for Virtual Machine Scale Sets) - An availability zone will be automatically picked by system as part of resource creation. */
zonePlacementPolicy?: ZonePlacementPolicyType;
/** This property supplements the 'zonePlacementPolicy' property. If 'zonePlacementPolicy' is set to 'Any'/'Auto', availability zone selected by the system must be present in the list of availability zones passed with 'includeZones'. If 'includeZones' is not provided, all availability zones in region will be considered for selection. */
includeZones?: string[];
/** This property supplements the 'zonePlacementPolicy' property. If 'zonePlacementPolicy' is set to 'Any'/'Auto', availability zone selected by the system must not be present in the list of availability zones passed with 'excludeZones'. If 'excludeZones' is not provided, all availability zones in region will be considered for selection. */
excludeZones?: string[];
}
/** The List Virtual Machine operation response. */
export interface VirtualMachineListResult {
/** The list of virtual machines. */
value: VirtualMachine[];
/** The URI to fetch the next page of VMs. Call ListNext() with this URI to fetch the next page of Virtual Machines. */
nextLink?: string;
}
/** Specifies the hardware settings for the virtual machine. */
export interface HardwareProfile {
/** Specifies the size of the virtual machine. The enum data type is currently deprecated and will be removed by December 23rd 2023. The recommended way to get the list of available sizes is using these APIs: [List all available virtual machine sizes in an availability set](https://docs.microsoft.com/rest/api/compute/availabilitysets/listavailablesizes), [List all available virtual machine sizes in a region]( https://docs.microsoft.com/rest/api/compute/resourceskus/list), [List all available virtual machine sizes for resizing](https://docs.microsoft.com/rest/api/compute/virtualmachines/listavailablesizes). For more information about virtual machine sizes, see [Sizes for virtual machines](https://docs.microsoft.com/azure/virtual-machines/sizes). The available VM sizes depend on region and availability set. */
vmSize?: VirtualMachineSizeTypes;
/** Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-07-01. This feature is still in preview mode and is not supported for VirtualMachineScaleSet. Please follow the instructions in [VM Customization](https://aka.ms/vmcustomization) for more details. */
vmSizeProperties?: VMSizeProperties;
}
/** Specifies the storage settings for the virtual machine disks. */
export interface StorageProfile {
/** Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. */
imageReference?: ImageReference;
/** Specifies information about the operating system disk used by the virtual machine. For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview). */
osDisk?: OSDisk;
/** Specifies the parameters that are used to add a data disk to a virtual machine. For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview). */
dataDisks?: DataDisk[];
/** Specifies the disk controller type configured for the VM. **Note:** This property will be set to the default disk controller type if not specified provided virtual machine is being created with 'hyperVGeneration' set to V2 based on the capabilities of the operating system disk and VM size from the the specified minimum api version. You need to deallocate the VM before updating its disk controller type unless you are updating the VM size in the VM configuration which implicitly deallocates and reallocates the VM. Minimum api-version: 2022-08-01. */
diskControllerType?: DiskControllerTypes;
/** Specifies whether the regional disks should be aligned/moved to the VM zone. This is applicable only for VMs with placement property set. Please note that this change is irreversible. Minimum api-version: 2024-11-01. */
alignRegionalDisksToVMZone?: boolean;
}
/** Specifies information about the operating system disk used by the virtual machine. For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview). */
export interface OSDisk {
/** This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD. Possible values are: **Windows,** **Linux.** */
osType?: OperatingSystemTypes;
/** Specifies the encryption settings for the OS Disk. Minimum api-version: 2015-06-15. */
encryptionSettings?: DiskEncryptionSettings;
/** The disk name. */
name?: string;
/** The virtual hard disk. */
vhd?: VirtualHardDisk;
/** The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist. */
image?: VirtualHardDisk;
/** Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The defaulting behavior is: **None for Standard storage. ReadOnly for Premium storage.** */
caching?: CachingTypes;
/** Specifies whether writeAccelerator should be enabled or disabled on the disk. */
writeAcceleratorEnabled?: boolean;
/** Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine. */
diffDiskSettings?: DiffDiskSettings;
/** Specifies how the virtual machine disk should be created. Possible values are **Attach:** This value is used when you are using a specialized disk to create the virtual machine. **FromImage:** This value is used when you are using an image to create the virtual machine. If you are using a platform image, you should also use the imageReference element described above. If you are using a marketplace image, you should also use the plan element previously described. */
createOption: DiskCreateOptionTypes;
/** Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023. */
diskSizeGB?: number;
/** The managed disk parameters. */
managedDisk?: ManagedDiskParameters;
/** Specifies whether OS Disk should be deleted or detached upon VM deletion. Possible values are: **Delete.** If this value is used, the OS disk is deleted when VM is deleted. **Detach.** If this value is used, the os disk is retained after VM is deleted. The default value is set to **Detach**. For an ephemeral OS Disk, the default value is set to **Delete**. The user cannot change the delete option for an ephemeral OS Disk. */
deleteOption?: DiskDeleteOptionTypes;
}
/** Describes a Encryption Settings for a Disk */
export interface DiskEncryptionSettings {
/** Specifies the location of the disk encryption key, which is a Key Vault Secret. */
diskEncryptionKey?: KeyVaultSecretReference;
/** Specifies the location of the key encryption key in Key Vault. */
keyEncryptionKey?: KeyVaultKeyReference;
/** Specifies whether disk encryption should be enabled on the virtual machine. */
enabled?: boolean;
}
/** Describes a reference to Key Vault Key */
export interface KeyVaultKeyReference {
/** The URL referencing a key encryption key in Key Vault. */
keyUrl: string;
/** The relative URL of the Key Vault containing the key. */
sourceVault: SubResource;
}
/** Describes a data disk. */
export interface DataDisk {
/** Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM. */
lun: number;
/** The disk name. */
name?: string;
/** The virtual hard disk. */
vhd?: VirtualHardDisk;
/** The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist. */
image?: VirtualHardDisk;
/** Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The defaulting behavior is: **None for Standard storage. ReadOnly for Premium storage.** */
caching?: CachingTypes;
/** Specifies whether writeAccelerator should be enabled or disabled on the disk. */
writeAcceleratorEnabled?: boolean;
/** Specifies how the virtual machine disk should be created. Possible values are **Attach:** This value is used when you are using a specialized disk to create the virtual machine. **FromImage:** This value is used when you are using an image to create the virtual machine data disk. If you are using a platform image, you should also use the imageReference element described above. If you are using a marketplace image, you should also use the plan element previously described. **Empty:** This value is used when creating an empty data disk. **Copy:** This value is used to create a data disk from a snapshot or another disk. **Restore:** This value is used to create a data disk from a disk restore point. */
createOption: DiskCreateOptionTypes;
/** Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023. */
diskSizeGB?: number;
/** The managed disk parameters. */
managedDisk?: ManagedDiskParameters;
/** The source resource identifier. It can be a snapshot, or disk restore point from which to create a disk. */
sourceResource?: ApiEntityReference;
/** Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset */
toBeDetached?: boolean;
/** Specifies the Read-Write IOPS for the managed disk when StorageAccountType is UltraSSD_LRS. */
diskIopsReadWrite?: number;
/** Specifies the bandwidth in MB per second for the managed disk when StorageAccountType is UltraSSD_LRS. */
diskMBpsReadWrite?: number;
/** Specifies the detach behavior to be used while detaching a disk or which is already in the process of detachment from the virtual machine. Supported values: **ForceDetach.** detachOption: **ForceDetach** is applicable only for managed data disks. If a previous detachment attempt of the data disk did not complete due to an unexpected failure from the virtual machine and the disk is still not released then use force-detach as a last resort option to detach the disk forcibly from the VM. All writes might not have been flushed when using this detach behavior. **This feature is still in preview**. To force-detach a data disk update toBeDetached to 'true' along with setting detachOption: 'ForceDetach'. */
detachOption?: DiskDetachOptionTypes;
/** Specifies whether data disk should be deleted or detached upon VM deletion. Possible values are: **Delete.** If this value is used, the data disk is deleted when VM is deleted. **Detach.** If this value is used, the data disk is retained after VM is deleted. The default value is set to **Detach**. */
deleteOption?: DiskDeleteOptionTypes;
}
/** Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned. */
export interface OSProfile {
/** Specifies the host OS name of the virtual machine. This name cannot be updated after the VM is created. **Max-length (Windows):** 15 characters. **Max-length (Linux):** 64 characters. For naming conventions and restrictions see [Azure infrastructure services implementation guidelines](https://docs.microsoft.com/azure/azure-resource-manager/management/resource-name-rules). */
computerName?: string;
/** Specifies the name of the administrator account. This property cannot be updated after the VM is created. **Windows-only restriction:** Cannot end in "." **Disallowed values:** "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5". **Minimum-length (Linux):** 1 character **Max-length (Linux):** 64 characters **Max-length (Windows):** 20 characters. */
adminUsername?: string;
/**
* Specifies the password of the administrator account. **Minimum-length (Windows):** 8 characters **Minimum-length (Linux):** 6 characters **Max-length (Windows):** 123 characters **Max-length (Linux):** 72 characters **Complexity requirements:** 3 out of 4 conditions below need to be fulfilled Has lower characters Has upper characters Has a digit Has a special character (Regex match [\W_]) **Disallowed values:** "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!" For resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows VM](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/reset-rdp) For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection)
* This value contains a credential. Consider obscuring before showing to users
*/
adminPassword?: string;
/** Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes. **Note: Do not pass any secrets or passwords in customData property.** This property cannot be updated after the VM is created. The property 'customData' is passed to the VM to be saved as a file, for more information see [Custom Data on Azure VMs](https://azure.microsoft.com/blog/custom-data-and-cloud-init-on-windows-azure/). For using cloud-init for your Linux VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/linux/using-cloud-init). */
customData?: string;
/** Specifies Windows operating system settings on the virtual machine. */
windowsConfiguration?: WindowsConfiguration;
/** Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/linux/endorsed-distros). */
linuxConfiguration?: LinuxConfiguration;
/** Specifies set of certificates that should be installed onto the virtual machine. To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). */
secrets?: VaultSecretGroup[];
/** Specifies whether extension operations should be allowed on the virtual machine. This may only be set to False when no extensions are present on the virtual machine. */
allowExtensionOperations?: boolean;
/** Optional property which must either be set to True or omitted. */
requireGuestProvisionSignal?: boolean;
}
/** Specifies the network interfaces or the networking configuration of the virtual machine. */
export interface NetworkProfile {
/** Specifies the list of resource Ids for the network interfaces associated with the virtual machine. */
networkInterfaces?: NetworkInterfaceReference[];
/** specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations */
networkApiVersion?: NetworkApiVersion;
/** Specifies the networking configurations that will be used to create the virtual machine networking resources. */
networkInterfaceConfigurations?: VirtualMachineNetworkInterfaceConfiguration[];
}
/** Describes a virtual machine network interface configurations. */
export interface VirtualMachineNetworkInterfaceConfiguration {
/** The network interface configuration name. */
name: string;
/** Resource tags applied to the networkInterface address created by this NetworkInterfaceConfiguration */
tags?: {
[propertyName: string]: string;
};
/** Specifies the primary network interface in case the virtual machine has more than 1 network interface. */
primary?: boolean;
/** Specify what happens to the network interface when the VM is deleted */
deleteOption?: DeleteOptions;
/** Specifies whether the network interface is accelerated networking-enabled. */
enableAcceleratedNetworking?: boolean;
/** Specifies whether the network interface is disabled for tcp state tracking. */
disableTcpStateTracking?: boolean;
/** Specifies whether the network interface is FPGA networking-enabled. */
enableFpga?: boolean;
/** Whether IP forwarding enabled on this NIC. */
enableIPForwarding?: boolean;
/** The network security group. */
networkSecurityGroup?: SubResource;
/** The dns settings to be applied on the network interfaces. */
dnsSettings?: VirtualMachineNetworkInterfaceDnsSettingsConfiguration;
/** Specifies the IP configurations of the network interface. */
ipConfigurations?: VirtualMachineNetworkInterfaceIPConfiguration[];
dscpConfiguration?: SubResource;
/** Specifies whether the Auxiliary mode is enabled for the Network Interface resource. */
auxiliaryMode?: NetworkInterfaceAuxiliaryMode;
/** Specifies whether the Auxiliary sku is enabled for the Network Interface resource. */
auxiliarySku?: NetworkInterfaceAuxiliarySku;
}
/** Describes a virtual machines network configuration's DNS settings. */
export interface VirtualMachineNetworkInterfaceDnsSettingsConfiguration {
/** List of DNS servers IP addresses */
dnsServers?: string[];
}
/** Describes a virtual machine network profile's IP configuration. */
export interface VirtualMachineNetworkInterfaceIPConfiguration {
/** The IP configuration name. */
name: string;
/** Specifies the identifier of the subnet. */
subnet?: SubResource;
/** Specifies the primary network interface in case the virtual machine has more than 1 network interface. */
primary?: boolean;
/** The publicIPAddressConfiguration. */
publicIPAddressConfiguration?: VirtualMachinePublicIPAddressConfiguration;
/** Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. */
privateIPAddressVersion?: IPVersions;
/** Specifies an array of references to application security group. */
applicationSecurityGroups?: SubResource[];
/** Specifies an array of references to backend address pools of application gateways. A virtual machine can reference backend address pools of multiple application gateways. Multiple virtual machines cannot use the same application gateway. */
applicationGatewayBackendAddressPools?: SubResource[];
/** Specifies an array of references to backend address pools of load balancers. A virtual machine can reference backend address pools of one public and one internal load balancer. [Multiple virtual machines cannot use the same basic sku load balancer]. */
loadBalancerBackendAddressPools?: SubResource[];
}
/** Describes a virtual machines IP Configuration's PublicIPAddress configuration */
export interface VirtualMachinePublicIPAddressConfiguration {
/** The publicIP address configuration name. */
name: string;
/** Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible. */
sku?: PublicIPAddressSku;
/** Resource tags applied to the publicIP address created by this PublicIPAddressConfiguration */
tags?: {
[propertyName: string]: string;
};
/** The idle timeout of the public IP address. */
idleTimeoutInMinutes?: number;
/** Specify what happens to the public IP address when the VM is deleted */
deleteOption?: DeleteOptions;
/** The dns settings to be applied on the publicIP addresses . */
dnsSettings?: VirtualMachinePublicIPAddressDnsSettingsConfiguration;
/** The list of IP tags associated with the public IP address. */
ipTags?: VirtualMachineIpTag[];
/** The PublicIPPrefix from which to allocate publicIP addresses. */
publicIPPrefix?: SubResource;
/** Available from Api-Version 2019-07-01 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. */
publicIPAddressVersion?: IPVersions;
/** Specify the public IP allocation type */
publicIPAllocationMethod?: PublicIPAllocationMethod;
}
/** Describes a virtual machines network configuration's DNS settings. */
export interface VirtualMachinePublicIPAddressDnsSettingsConfiguration {
/** The Domain name label prefix of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the domain name label and vm network profile unique ID. */
domainNameLabel: string;
/** The Domain name label scope of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the hashed domain name label with policy according to the domain name label scope and vm network profile unique ID. */
domainNameLabelScope?: DomainNameLabelScopeTypes;
}
/** Contains the IP tag associated with the public IP address. */
export interface VirtualMachineIpTag {
/** IP tag type. Example: FirstPartyUsage. */
ipTagType?: string;
/** IP tag associated with the public IP. Example: SQL, Storage etc. */
tag?: string;
}
/** The instance view of a virtual machine. */
export interface VirtualMachineInstanceView {
/** Specifies the update domain of the virtual machine. */
platformUpdateDomain?: number;
/** Specifies the fault domain of the virtual machine. */
platformFaultDomain?: number;
/** The computer name assigned to the virtual machine. */
computerName?: string;
/** The Operating System running on the virtual machine. */
osName?: string;
/** The version of Operating System running on the virtual machine. */
osVersion?: string;
/** Specifies the HyperVGeneration Type associated with a resource */
hyperVGeneration?: HyperVGenerationType;
/** The Remote desktop certificate thumbprint. */
rdpThumbPrint?: string;
/** The VM Agent running on the virtual machine. */
vmAgent?: VirtualMachineAgentInstanceView;
/** The Maintenance Operation status on the virtual machine. */
maintenanceRedeployStatus?: MaintenanceRedeployStatus;
/** The virtual machine disk information. */
disks?: DiskInstanceView[];
/** The extensions information. */
extensions?: VirtualMachineExtensionInstanceView[];
/**
* The health status for the VM.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly vmHealth?: VirtualMachineHealthStatus;
/** Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. You can easily view the output of your console log. Azure also enables you to see a screenshot of the VM from the hypervisor. */
bootDiagnostics?: BootDiagnosticsInstanceView;
/**
* Resource id of the dedicated host, on which the virtual machine is allocated through automatic placement, when the virtual machine is associated with a dedicated host group that has automatic placement enabled. Minimum api-version: 2020-06-01.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly assignedHost?: string;
/** The resource status information. */
statuses?: InstanceViewStatus[];
/** [Preview Feature] The status of virtual machine patch operations. */
patchStatus?: VirtualMachinePatchStatus;
/**
* [Preview Feature] Specifies whether the VM is currently in or out of the Standby Pool.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly isVMInStandbyPool?: boolean;
}
/** The instance view of the VM Agent running on the virtual machine. */
export interface VirtualMachineAgentInstanceView {
/** The VM Agent full version. */
vmAgentVersion?: string;
/** The virtual machine extension handler instance view. */
extensionHandlers?: VirtualMachineExtensionHandlerInstanceView[];
/** The resource status information. */
statuses?: InstanceViewStatus[];
}
/** The instance view of a virtual machine extension handler. */
export interface VirtualMachineExtensionHandlerInstanceView {
/** Specifies the type of the extension; an example is "CustomScriptExtension". */
type?: string;
/** Specifies the version of the script handler. */
typeHandlerVersion?: string;
/** The extension handler status. */
status?: InstanceViewStatus;
}
/** Maintenance Operation Status. */
export interface MaintenanceRedeployStatus {
/** True, if customer is allowed to perform Maintenance. */
isCustomerInitiatedMaintenanceAllowed?: boolean;
/** Start Time for the Pre Maintenance Window. */
preMaintenanceWindowStartTime?: Date;
/** End Time for the Pre Maintenance Window. */
preMaintenanceWindowEndTime?: Date;
/** Start Time for the Maintenance Window. */
maintenanceWindowStartTime?: Date;
/** End Time for the Maintenance Window. */
maintenanceWindowEndTime?: Date;
/** The Last Maintenance Operation Result Code. */
lastOperationResultCode?: MaintenanceOperationResultCodeTypes;
/** Message returned for the last Maintenance Operation. */
lastOperationMessage?: string;
}
/** The instance view of the disk. */
export interface DiskInstanceView {
/** The disk name. */
name?: string;
/** Specifies the encryption settings for the OS Disk. Minimum api-version: 2015-06-15 */
encryptionSettings?: DiskEncryptionSettings[];
/** The resource status information. */
statuses?: InstanceViewStatus[];
}
/** The instance view of a virtual machine extension. */
export interface VirtualMachineExtensionInstanceView {
/** The virtual machine extension name. */
name?: string;
/** Specifies the type of the extension; an example is "CustomScriptExtension". */
type?: string;
/** Specifies the version of the script handler. */
typeHandlerVersion?: string;
/** The resource status information. */
substatuses?: InstanceViewStatus[];
/** The resource status information. */
statuses?: InstanceViewStatus[];
}
/** The health status of the VM. */
export interface VirtualMachineHealthStatus {
/**
* The health status information for the VM.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly status?: InstanceViewStatus;
}
/** The instance view of a virtual machine boot diagnostics. */
export interface BootDiagnosticsInstanceView {
/**
* The console screenshot blob URI. **Note:** This will **not** be set if boot diagnostics is currently enabled with managed storage.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly consoleScreenshotBlobUri?: string;
/**
* The serial console log blob Uri. **Note:** This will **not** be set if boot diagnostics is currently enabled with managed storage.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly serialConsoleLogBlobUri?: string;
/**
* The boot diagnostics status information for the VM. **Note:** It will be set only if there are errors encountered in enabling boot diagnostics.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly status?: InstanceViewStatus;
}
/** The status of virtual machine patch operations. */
export interface VirtualMachinePatchStatus {
/** The available patch summary of the latest assessment operation for the virtual machine. */
availablePatchSummary?: AvailablePatchSummary;
/** The installation summary of the latest installation operation for the virtual machine. */
lastPatchInstallationSummary?: LastPatchInstallationSummary;
/**
* The enablement status of the specified patchMode
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly configurationStatuses?: InstanceViewStatus[];
}
/** Describes the properties of an virtual machine instance view for available patch summary. */
export interface AvailablePatchSummary {
/**
* The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Unknown", "Failed", "Succeeded", or "CompletedWithWarnings."
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly status?: PatchOperationStatus;
/**
* The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly assessmentActivityId?: string;
/**
* The overall reboot status of the VM. It will be true when partially installed patches require a reboot to complete installation but the reboot has not yet occurred.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly rebootPending?: boolean;
/**
* The number of critical or security patches that have been detected as available and not yet installed.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly criticalAndSecurityPatchCount?: number;
/**
* The number of all available patches excluding critical and security.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly otherPatchCount?: number;
/**
* The UTC timestamp when the operation began.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly startTime?: Date;
/**
* The UTC timestamp when the operation began.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly lastModifiedTime?: Date;
/**
* The errors that were encountered during execution of the operation. The details array contains the list of them.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly error?: ApiError;
}
/** Describes the properties of the last installed patch summary. */
export interface LastPatchInstallationSummary {
/**
* The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Unknown", "Failed", "Succeeded", or "CompletedWithWarnings."
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly status?: PatchOperationStatus;
/**
* The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly installationActivityId?: string;
/**
* Describes whether the operation ran out of time before it completed all its intended actions
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly maintenanceWindowExceeded?: boolean;
/**
* The number of all available patches but not going to be installed because it didn't match a classification or inclusion list entry.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly notSelectedPatchCount?: number;
/**
* The number of all available patches but excluded explicitly by a customer-specified exclusion list match.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly excludedPatchCount?: number;
/**
* The number of all available patches expected to be installed over the course of the patch installation operation.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly pendingPatchCount?: number;
/**
* The count of patches that successfully installed.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly installedPatchCount?: number;
/**
* The count of patches that failed installation.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly failedPatchCount?: number;
/**
* The UTC timestamp when the operation began.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly startTime?: Date;
/**
* The UTC timestamp when the operation began.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly lastModifiedTime?: Date;
/**
* The errors that were encountered during execution of the operation. The details array contains the list of them.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly error?: ApiError;
}
/** Identity for the virtual machine. */
export interface VirtualMachineIdentity {
/**
* The principal id of virtual machine identity. This property will only be provided for a system assigned identity.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly principalId?: string;
/**
* The tenant id associated with the virtual machine. This property will only be provided for a system assigned identity.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly tenantId?: string;
/** The type of identity used for the virtual machine. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine. */
type?: ResourceIdentityType;
/** The list of user identities associated with the Virtual Machine. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. */
userAssignedIdentities?: {
[propertyName: string]: UserAssignedIdentitiesValue;
};
}
/** The List Virtual Machine operation response. */
export interface VirtualMachineSizeListResult {
/** The list of virtual machine sizes. */
value?: VirtualMachineSize[];
/** The link to the next page of items. */
nextLink?: string;
}
/** Describes the properties of a VM size. */
export interface VirtualMachineSize {
/** The name of the virtual machine size. */
name?: string;
/** The number of cores supported by the virtual machine size. For Constrained vCPU capable VM sizes, this number represents the total vCPUs of quota that the VM uses. For accurate vCPU count, please refer to https://docs.microsoft.com/azure/virtual-machines/constrained-vcpu or https://docs.microsoft.com/rest/api/compute/resourceskus/list */
numberOfCores?: number;
/** The OS disk size, in MB, allowed by the virtual machine size. */
osDiskSizeInMB?: number;
/** The resource disk size, in MB, allowed by the virtual machine size. */
resourceDiskSizeInMB?: number;
/** The amount of memory, in MB, supported by the virtual machine size. */
memoryInMB?: number;
/** The maximum number of data disks that can be attached to the virtual machine size. */
maxDataDiskCount?: number;
}
/** The List Proximity Placement Group operation response. */
export interface ProximityPlacementGroupListResult {
/** The list of proximity placement groups. */
value: ProximityPlacementGroup[];
/** The URI to fetch the next page of proximity placement groups. */
nextLink?: string;
}
/** Specifies the user intent of the proximity placement group. */
export interface ProximityPlacementGroupPropertiesIntent {
/** Specifies possible sizes of virtual machines that can be created in the proximity placement group. */
vmSizes?: string[];
}
/** The List restore point collection operation response. */
export interface RestorePointCollectionListResult {
/** Gets the list of restore point collections. */
value: RestorePointCollection[];
/** The uri to fetch the next page of RestorePointCollections. Call ListNext() with this to fetch the next page of RestorePointCollections. */
nextLink?: string;
}
/** The properties of the source resource that this restore point collection is created from. */
export interface RestorePointCollectionSourceProperties {
/**
* Location of the source resource used to create this restore point collection.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly location?: string;
/** Resource Id of the source resource used to create this restore point collection */
id?: string;
}
/** Describes the properties of the Virtual Machine for which the restore point was created. The properties provided are a subset and the snapshot of the overall Virtual Machine properties captured at the time of the restore point creation. */
export interface RestorePointSourceMetadata {
/**
* Gets the hardware profile.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly hardwareProfile?: HardwareProfile;
/** Gets the storage profile. */
storageProfile?: RestorePointSourceVMStorageProfile;
/**
* Gets the OS profile.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly osProfile?: OSProfile;
/**
* Gets the diagnostics profile.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly diagnosticsProfile?: DiagnosticsProfile;
/**
* Gets the license type, which is for bring your own license scenario.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly licenseType?: string;
/**
* Gets the virtual machine unique id.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly vmId?: string;
/**
* Gets the security profile.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly securityProfile?: SecurityProfile;
/**
* Location of the VM from which the restore point was created.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly location?: string;
/**
* UserData associated with the source VM for which restore point is captured, which is a base-64 encoded value.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly userData?: string;
/**
* HyperVGeneration of the source VM for which restore point is captured.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly hyperVGeneration?: HyperVGenerationTypes;
}
/** Describes the storage profile. */
export interface RestorePointSourceVMStorageProfile {
/** Gets the OS disk of the VM captured at the time of the restore point creation. */
osDisk?: RestorePointSourceVmosDisk;
/** Gets the data disks of the VM captured at the time of the restore point creation. */
dataDisks?: RestorePointSourceVMDataDisk[];
/**
* Gets the disk controller type of the VM captured at the time of the restore point creation.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly diskControllerType?: DiskControllerTypes;
}
/** Describes an Operating System disk. */
export interface RestorePointSourceVmosDisk {
/**
* Gets the Operating System type.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly osType?: OperatingSystemType;
/**
* Gets the disk encryption settings.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly encryptionSettings?: DiskEncryptionSettings;
/**
* Gets the disk name.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly name?: string;
/**
* Gets the caching type.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly caching?: CachingTypes;
/**
* Gets the disk size in GB.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly diskSizeGB?: number;
/** Gets the managed disk details */
managedDisk?: ManagedDiskParameters;
/** Contains Disk Restore Point properties. */
diskRestorePoint?: DiskRestorePointAttributes;
/**
* Shows true if the disk is write-accelerator enabled.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly writeAcceleratorEnabled?: boolean;
}
/** Encryption at rest settings for disk restore point. It is an optional property that can be specified in the input while creating a restore point. */
export interface RestorePointEncryption {
/** Describes the parameter of customer managed disk encryption set resource id that can be specified for disk. **Note:** The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details. */
diskEncryptionSet?: DiskEncryptionSetParameters;
/** The type of key used to encrypt the data of the disk restore point. */
type?: RestorePointEncryptionType;
}
/** Describes a data disk. */
export interface RestorePointSourceVMDataDisk {
/**
* Gets the logical unit number.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly lun?: number;
/**
* Gets the disk name.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly name?: string;
/**
* Gets the caching type.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly caching?: CachingTypes;
/**
* Gets the initial disk size in GB for blank data disks, and the new desired size for existing OS and Data disks.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly diskSizeGB?: number;
/** Contains the managed disk details. */
managedDisk?: ManagedDiskParameters;
/** Contains Disk Restore Point properties. */
diskRestorePoint?: DiskRestorePointAttributes;
/**
* Shows true if the disk is write-accelerator enabled.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly writeAcceleratorEnabled?: boolean;
}
/** The instance view of a restore point. */
export interface RestorePointInstanceView {
/** The disk restore points information. */
diskRestorePoints?: DiskRestorePointInstanceView[];
/** The resource status information. */
statuses?: InstanceViewStatus[];
}
/** The instance view of a disk restore point. */
export interface DiskRestorePointInstanceView {
/** Disk restore point Id. */
id?: string;
/** The state of snapshot which determines the access availability of the snapshot. */
snapshotAccessState?: SnapshotAccessState;
/** The disk restore point replication status information. */
replicationStatus?: DiskRestorePointReplicationStatus;
}
/** The instance view of a disk restore point. */
export interface DiskRestorePointReplicationStatus {
/** The resource status information. */
status?: InstanceViewStatus;
/** Replication completion percentage. */
completionPercent?: number;
}
/** The list SSH public keys operation response. */
export interface SshPublicKeysGroupListResult {
/** The list of SSH public keys. */
value: SshPublicKeyResource[];
/** The URI to fetch the next page of SSH public keys. Call ListNext() with this URI to fetch the next page of SSH public keys. */
nextLink?: string;
}
/** The List Virtual Machine operation response. */
export interface VirtualMachineScaleSetListWithLinkResult {
/** The list of virtual machine scale sets. */
value: VirtualMachineScaleSet[];
/** The uri to fetch the next page of Virtual Machine Scale Sets. Call ListNext() with this to fetch the next page of Virtual Machine Scale Sets. */
nextLink?: string;
}
/** The Update Resource model definition. */
export interface UpdateResource {
/** Resource tags */
tags?: {
[propertyName: string]: string;
};
}
/** Describes the Virtual Machine Scale Set to convert from Availability Set. */
export interface ConvertToVirtualMachineScaleSetInput {
/** Specifies information about the Virtual Machine Scale Set that the Availability Set should be converted to. */
virtualMachineScaleSetName?: string;
}
/** Describes the Virtual Machine Scale Set to migrate from Availability Set. */
export interface MigrateToVirtualMachineScaleSetInput {
/** Specifies information about the Virtual Machine Scale Set that the Availability Set should be migrated to. Minimum api‐version: 2024‐11‐01. */
virtualMachineScaleSetFlexible: SubResource;
}
/** The list capacity reservation operation response. */
export interface CapacityReservationListResult {
/** The list of capacity reservations. */
value: CapacityReservation[];
/** The URI to fetch the next page of capacity reservations. Call ListNext() with this URI to fetch the next page of capacity reservations. */
nextLink?: string;
}
/** Defines the schedule for Block-type capacity reservations. Specifies the schedule during which capacity reservation is active and VM or VMSS resource can be allocated using reservation. This property is required and only supported when the capacity reservation group type is 'Block'. The scheduleProfile, start, and end fields are immutable after creation. Minimum API version: 2025-04-01. Please refer to https://aka.ms/blockcapacityreservation for more details. */
export interface ScheduleProfile {
/** The required start date for block capacity reservations. Must be today or within 56 days in the future. For same-day scheduling, requests must be submitted before 11:30 AM UTC. Example: 2025-06-27. */
start?: string;
/** The required end date for block capacity reservations. Must be after the start date, with a duration of either 1–14 whole days or 3–26 whole weeks. Example: 2025-06-28. */
end?: string;
}
/** The list dedicated host operation response. */
export interface DedicatedHostListResult {
/** The list of dedicated hosts. */
value: DedicatedHost[];
/** The URI to fetch the next page of dedicated hosts. Call ListNext() with this URI to fetch the next page of dedicated hosts. */
nextLink?: string;
}
/** The List Dedicated Host sizes operation response. */
export interface DedicatedHostSizeListResult {
/** The list of dedicated host sizes. */
value?: string[];
/** The link to the next page of items. */
nextLink?: string;
}
/** Parameters for GenerateSshKeyPair. */
export interface SshGenerateKeyPairInputParameters {
/** The encryption type of the SSH keys to be generated. See SshEncryptionTypes for possible set of values. If not provided, will default to RSA */
encryptionType?: SshEncryptionTypes;
}
/** Response from generation of an SSH key pair. */
export interface SshPublicKeyGenerateKeyPairResult {
/** Private key portion of the key pair used to authenticate to a virtual machine through ssh. The private key is returned in RFC3447 format and should be treated as a secret. */
privateKey: string;
/** Public key portion of the key pair used to authenticate to a virtual machine through ssh. The public key is in ssh-rsa format. */
publicKey: string;
/** The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/sshPublicKeys/{SshPublicKeyName} */
id: string;
}
/** Describes a virtual machine scale set virtual machine profile. */
export interface VirtualMachineScaleSetUpdateVMProfile {
/** The virtual machine scale set OS profile. */
osProfile?: VirtualMachineScaleSetUpdateOSProfile;
/** The virtual machine scale set storage profile. */
storageProfile?: VirtualMachineScaleSetUpdateStorageProfile;
/** The virtual machine scale set network profile. */
networkProfile?: VirtualMachineScaleSetUpdateNetworkProfile;
/** The virtual machine scale set security posture reference. */
securityPostureReference?: SecurityPostureReferenceUpdate;
/** The virtual machine scale set Security profile */
securityProfile?: SecurityProfile;
/** The virtual machine scale set diagnostics profile. */
diagnosticsProfile?: DiagnosticsProfile;
/** The virtual machine scale set extension profile. */
extensionProfile?: VirtualMachineScaleSetExtensionProfile;
/** The license type, which is for bring your own license scenario. */
licenseType?: string;
/** Specifies the billing related details of a Azure Spot VMSS. Minimum api-version: 2019-03-01. */
billingProfile?: BillingProfile;
/** Specifies Scheduled Event related configurations. */
scheduledEventsProfile?: ScheduledEventsProfile;
/** UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01 */
userData?: string;
/** Specifies the hardware profile related details of a scale set. Minimum api-version: 2021-11-01. */
hardwareProfile?: VirtualMachineScaleSetHardwareProfile;
}
/** Describes a virtual machine scale set OS profile. */
export interface VirtualMachineScaleSetUpdateOSProfile {
/** A base-64 encoded string of custom data. */
customData?: string;
/** The Windows Configuration of the OS profile. */
windowsConfiguration?: WindowsConfiguration;
/** The Linux Configuration of the OS profile. */
linuxConfiguration?: LinuxConfiguration;
/** The List of certificates for addition to the VM. */
secrets?: VaultSecretGroup[];
}
/** Describes a virtual machine scale set storage profile. */
export interface VirtualMachineScaleSetUpdateStorageProfile {
/** The image reference. */
imageReference?: ImageReference;
/** The OS disk. */
osDisk?: VirtualMachineScaleSetUpdateOSDisk;
/** The data disks. */
dataDisks?: VirtualMachineScaleSetDataDisk[];
/** Specifies the disk controller type configured for the virtual machines in the scale set. **Note:** You need to deallocate the virtual machines in the scale set before updating its disk controller type based on the upgrade mode configured for the scale set. Minimum api-version: 2022-08-01 */
diskControllerType?: DiskControllerTypes;
}
/** Describes virtual machine scale set operating system disk Update Object. This should be used for Updating VMSS OS Disk. */
export interface VirtualMachineScaleSetUpdateOSDisk {
/** The caching type. */
caching?: CachingTypes;
/** Specifies whether writeAccelerator should be enabled or disabled on the disk. */
writeAcceleratorEnabled?: boolean;
/** Specifies the ephemeral disk Settings for the operating system disk used by the virtual machine scale set. */
diffDiskSettings?: DiffDiskSettings;
/** Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. diskSizeGB is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023 */
diskSizeGB?: number;
/** The Source User Image VirtualHardDisk. This VirtualHardDisk will be copied before using it to attach to the Virtual Machine. If SourceImage is provided, the destination VirtualHardDisk should not exist. */
image?: VirtualHardDisk;
/** The list of virtual hard disk container uris. */
vhdContainers?: string[];
/** The managed disk parameters. */
managedDisk?: VirtualMachineScaleSetManagedDiskParameters;
/** Specifies whether OS Disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only). Possible values: **Delete** If this value is used, the OS disk is deleted when VMSS Flex VM is deleted. **Detach** If this value is used, the OS disk is retained after VMSS Flex VM is deleted. The default value is set to **Delete**. For an Ephemeral OS Disk, the default value is set to **Delete**. User cannot change the delete option for Ephemeral OS Disk. */
deleteOption?: DiskDeleteOptionTypes;
}
/** Describes a virtual machine scale set network profile. */
export interface VirtualMachineScaleSetUpdateNetworkProfile {
/** A reference to a load balancer probe used to determine the health of an instance in the virtual machine scale set. The reference will be in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'. */
healthProbe?: ApiEntityReference;
/** The list of network configurations. */
networkInterfaceConfigurations?: VirtualMachineScaleSetUpdateNetworkConfiguration[];
/** specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations for Virtual Machine Scale Set with orchestration mode 'Flexible' */
networkApiVersion?: NetworkApiVersion;
}
/** Describes a virtual machine scale set network profile's network configurations. */
export interface VirtualMachineScaleSetUpdateNetworkConfiguration {
/** The network configuration name. */
name?: string;
/** Resource tags applied to the networkInterface address created by this NetworkInterfaceConfiguration */
tags?: {
[propertyName: string]: string;
};
/** Whether this is a primary NIC on a virtual machine. */
primary?: boolean;
/** Specifies whether the network interface is accelerated networking-enabled. */
enableAcceleratedNetworking?: boolean;
/** Specifies whether the network interface is disabled for tcp state tracking. */
disableTcpStateTracking?: boolean;
/** Specifies whether the network interface is FPGA networking-enabled. */
enableFpga?: boolean;
/** The network security group. */
networkSecurityGroup?: SubResource;
/** The dns settings to be applied on the network interfaces. */
dnsSettings?: VirtualMachineScaleSetNetworkConfigurationDnsSettings;
/** The virtual machine scale set IP Configuration. */
ipConfigurations?: VirtualMachineScaleSetUpdateIPConfiguration[];
/** Whether IP forwarding enabled on this NIC. */
enableIPForwarding?: boolean;
/** Specify what happens to the network interface when the VM is deleted */
deleteOption?: DeleteOptions;
/** Specifies whether the Auxiliary mode is enabled for the Network Interface resource. */
auxiliaryMode?: NetworkInterfaceAuxiliaryMode;
/** Specifies whether the Auxiliary sku is enabled for the Network Interface resource. */
auxiliarySku?: NetworkInterfaceAuxiliarySku;
}
/** Describes a virtual machine scale set network profile's IP configuration. NOTE: The subnet of a scale set may be modified as long as the original subnet and the new subnet are in the same virtual network */
export interface VirtualMachineScaleSetUpdateIPConfiguration {
/** The IP configuration name. */
name?: string;
/** The subnet. */
subnet?: ApiEntityReference;
/** Specifies the primary IP Configuration in case the network interface has more than one IP Configuration. */
primary?: boolean;
/** The publicIPAddressConfiguration. */
publicIPAddressConfiguration?: VirtualMachineScaleSetUpdatePublicIPAddressConfiguration;
/** Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. */
privateIPAddressVersion?: IPVersion;
/** The application gateway backend address pools. */
applicationGatewayBackendAddressPools?: SubResource[];
/** Specifies an array of references to application security group. */
applicationSecurityGroups?: SubResource[];
/** The load balancer backend address pools. */
loadBalancerBackendAddressPools?: SubResource[];
/** The load balancer inbound nat pools. */
loadBalancerInboundNatPools?: SubResource[];
}
/** Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration */
export interface VirtualMachineScaleSetUpdatePublicIPAddressConfiguration {
/** The publicIP address configuration name. */
name?: string;
/** Resource tags applied to the publicIP address created by this PublicIPAddressConfiguration */
tags?: {
[propertyName: string]: string;
};
/** The idle timeout of the public IP address. */
idleTimeoutInMinutes?: number;
/** The dns settings to be applied on the publicIP addresses . */
dnsSettings?: VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings;
/** The PublicIPPrefix from which to allocate publicIP addresses. */
publicIPPrefix?: SubResource;
/** Specify what happens to the public IP when the VM is deleted */
deleteOption?: DeleteOptions;
}
/** Specifies the security posture to be used in the scale set. Minimum api-version: 2023-03-01 */
export interface SecurityPostureReferenceUpdate {
/** The security posture reference id in the form of /CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|latest */
id?: string;
/** The list of virtual machine extension names to exclude when applying the security posture. */
excludeExtensions?: string[];
/** Whether the security posture can be overridden by the user. */
isOverridable?: boolean;
}
/** Specifies a list of virtual machine instance IDs from the VM scale set. */
export interface VirtualMachineScaleSetVMInstanceIDs {
/** The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set. */
instanceIds?: string[];
}
export interface VMScaleSetConvertToSinglePlacementGroupInput {
/** Id of the placement group in which you want future virtual machine instances to be placed. To query placement group Id, please use Virtual Machine Scale Set VMs - Get API. If not provided, the platform will choose one with maximum number of virtual machine instances. */
activePlacementGroupId?: string;
}
/** Specifies a list of virtual machine instance IDs from the VM scale set. */
export interface VirtualMachineScaleSetVMInstanceRequiredIDs {
/** The virtual machine scale set instance ids. */
instanceIds: string[];
}
/** The List VM scale set extension operation response. */
export interface VirtualMachineScaleSetExtensionListResult {
/** The list of VM scale set extensions. */
value: VirtualMachineScaleSetExtension[];
/** The uri to fetch the next page of VM scale set extensions. Call ListNext() with this to fetch the next page of VM scale set extensions. */
nextLink?: string;
}
/** Response after calling a manual recovery walk */
export interface RecoveryWalkResponse {
/**
* Whether the recovery walk was performed
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly walkPerformed?: boolean;
/**
* The next update domain that needs to be walked. Null means walk spanning all update domains has been completed
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly nextPlatformUpdateDomain?: number;
}
/** The instance view of a virtual machine scale set. */
export interface VirtualMachineScaleSetInstanceView {
/**
* The instance view status summary for the virtual machine scale set.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly virtualMachine?: VirtualMachineScaleSetInstanceViewStatusesSummary;
/**
* The extensions information.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly extensions?: VirtualMachineScaleSetVMExtensionsSummary[];
/** The resource status information. */
statuses?: InstanceViewStatus[];
/**
* The orchestration services information.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly orchestrationServices?: OrchestrationServiceSummary[];
}
/** Instance view statuses summary for virtual machines of a virtual machine scale set. */
export interface VirtualMachineScaleSetInstanceViewStatusesSummary {
/**
* The extensions information.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly statusesSummary?: VirtualMachineStatusCodeCount[];
}
/** The status code and count of the virtual machine scale set instance view status summary. */
export interface VirtualMachineStatusCodeCount {
/**
* The instance view status code.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly code?: string;
/**
* The number of instances having a particular status code.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly count?: number;
}
/** Extensions summary for virtual machines of a virtual machine scale set. */
export interface VirtualMachineScaleSetVMExtensionsSummary {
/**
* The extension name.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly name?: string;
/**
* The extensions information.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly statusesSummary?: VirtualMachineStatusCodeCount[];
}
/** Summary for an orchestration service of a virtual machine scale set. */
export interface OrchestrationServiceSummary {
/**
* The name of the service.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly serviceName?: OrchestrationServiceNames;
/**
* The current state of the service.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly serviceState?: OrchestrationServiceState;
/**
* The latest operation status of the service. Minimum API version for this property is 2025-04-01.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly latestOperationStatus?: OrchestrationServiceOperationStatus;
/**
* The last UTC time when the operation status changed. Minimum API version for this property is 2025-04-01.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly lastStatusChangeTime?: Date;
}
/** List of Virtual Machine Scale Set OS Upgrade History operation response. */
export interface VirtualMachineScaleSetListOSUpgradeHistory {
/** The list of OS upgrades performed on the virtual machine scale set. */
value: UpgradeOperationHistoricalStatusInfo[];
/** The uri to fetch the next page of OS Upgrade History. Call ListNext() with this to fetch the next page of history of upgrades. */
nextLink?: string;
}
/** Virtual Machine Scale Set OS Upgrade History operation response. */
export interface UpgradeOperationHistoricalStatusInfo {
/**
* Information about the properties of the upgrade operation.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly properties?: UpgradeOperationHistoricalStatusInfoProperties;
/**
* Resource type
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly type?: string;
/**
* Resource location
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly location?: string;
}
/** Describes each OS upgrade on the Virtual Machine Scale Set. */
export interface UpgradeOperationHistoricalStatusInfoProperties {
/**
* Information about the overall status of the upgrade operation.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly runningStatus?: UpgradeOperationHistoryStatus;
/**
* Counts of the VMs in each state.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly progress?: RollingUpgradeProgressInfo;
/**
* Error Details for this upgrade if there are any.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly error?: ApiError;
/**
* Invoker of the Upgrade Operation
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly startedBy?: UpgradeOperationInvoker;
/**
* Image Reference details
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly targetImageReference?: ImageReference;
/**
* Information about OS rollback if performed
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly rollbackInfo?: RollbackStatusInfo;
}
/** Information about the current running state of the overall upgrade. */
export interface UpgradeOperationHistoryStatus {
/**
* Code indicating the current status of the upgrade.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly code?: UpgradeState;
/**
* Start time of the upgrade.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly startTime?: Date;
/**
* End time of the upgrade.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly endTime?: Date;
}
/** Information about the number of virtual machine instances in each upgrade state. */
export interface RollingUpgradeProgressInfo {
/**
* The number of instances that have been successfully upgraded.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly successfulInstanceCount?: number;
/**
* The number of instances that have failed to be upgraded successfully.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly failedInstanceCount?: number;
/**
* The number of instances that are currently being upgraded.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly inProgressInstanceCount?: number;
/**
* The number of instances that have not yet begun to be upgraded.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly pendingInstanceCount?: number;
}
/** Information about rollback on failed VM instances after a OS Upgrade operation. */
export interface RollbackStatusInfo {
/**
* The number of instances which have been successfully rolled back.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly successfullyRolledbackInstanceCount?: number;
/**
* The number of instances which failed to rollback.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly failedRolledbackInstanceCount?: number;
/**
* Error details if OS rollback failed.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly rollbackError?: ApiError;
}
/** Parameters for Reimaging Virtual Machine. NOTE: Virtual Machine OS disk will always be reimaged */
export interface VirtualMachineReimageParameters {
/** Specifies whether to reimage temp disk. Default value: false. Note: This temp disk reimage parameter is only supported for VM/VMSS with Ephemeral OS disk. */
tempDisk?: boolean;
/** Specifies in decimal number, the version the OS disk should be reimaged to. If exact version is not provided, the OS disk is reimaged to the existing version of OS Disk. */
exactVersion?: string;
/** Specifies information required for reimaging the non-ephemeral OS disk. */
osProfile?: OSProfileProvisioningData;
}
/** Additional parameters for Reimaging Non-Ephemeral Virtual Machine. */
export interface OSProfileProvisioningData {
/**
* Specifies the password of the administrator account. **Minimum-length (Windows):** 8 characters **Minimum-length (Linux):** 6 characters **Max-length (Windows):** 123 characters **Max-length (Linux):** 72 characters **Complexity requirements:** 3 out of 4 conditions below need to be fulfilled Has lower characters Has upper characters Has a digit Has a special character (Regex match [\W_]) **Disallowed values:** "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!" For resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows VM](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/reset-rdp) For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection)
* This value contains a credential. Consider obscuring before showing to users
*/
adminPassword?: string;
/** Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes. **Note: Do not pass any secrets or passwords in customData property.** This property cannot be updated after the VM is created. The property customData is passed to the VM to be saved as a file, for more information see [Custom Data on Azure VMs](https://azure.microsoft.com/blog/custom-data-and-cloud-init-on-windows-azure/). If using cloud-init for your Linux VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/linux/using-cloud-init). */
customData?: string;
}
/** Information about the current running state of the overall upgrade. */
export interface RollingUpgradeRunningStatus {
/**
* Code indicating the current status of the upgrade.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly code?: RollingUpgradeStatusCode;
/**
* Start time of the upgrade.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly startTime?: Date;
/**
* The last action performed on the rolling upgrade.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly lastAction?: RollingUpgradeActionType;
/**
* Last action time of the upgrade.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly lastActionTime?: Date;
}
/** The input for ScaleOut */
export interface VMScaleSetScaleOutInput {
/** Specifies the number of virtual machines in the scale set. */
capacity: number;
/** The input properties for ScaleOut */
properties?: VMScaleSetScaleOutInputProperties;
}
/** The input properties for ScaleOut */
export interface VMScaleSetScaleOutInputProperties {
/** The zone in which the scale out is requested for the virtual machine scale set. */
zone?: string;
}
/** The input for OrchestrationServiceState */
export interface OrchestrationServiceStateInput {
/** The name of the service. */
serviceName: OrchestrationServiceNames;
/** The action to be performed. */
action: OrchestrationServiceStateAction;
}
/** The Virtual Machine Scale Set List Skus operation response. */
export interface VirtualMachineScaleSetListSkusResult {
/** The list of skus available for the virtual machine scale set. */
value: VirtualMachineScaleSetSku[];
/** The uri to fetch the next page of Virtual Machine Scale Set Skus. Call ListNext() with this to fetch the next page of VMSS Skus. */
nextLink?: string;
}
/** Describes an available virtual machine scale set sku. */
export interface VirtualMachineScaleSetSku {
/**
* The type of resource the sku applies to.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly resourceType?: string;
/**
* The Sku.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly sku?: Sku;
/**
* Specifies the number of virtual machines in the scale set.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly capacity?: VirtualMachineScaleSetSkuCapacity;
}
/** Describes scaling information of a sku. */
export interface VirtualMachineScaleSetSkuCapacity {
/**
* The minimum capacity.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly minimum?: number;
/**
* The maximum capacity that can be set.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly maximum?: number;
/**
* The default capacity.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly defaultCapacity?: number;
/**
* The scale type applicable to the sku.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly scaleType?: VirtualMachineScaleSetSkuScaleType;
}
/** The List Virtual Machine Scale Set VMs operation response. */
export interface VirtualMachineScaleSetVMListResult {
/** The list of virtual machine scale sets VMs. */
value: VirtualMachineScaleSetVM[];
/** The uri to fetch the next page of Virtual Machine Scale Set VMs. Call ListNext() with this to fetch the next page of VMSS VMs. */
nextLink?: string;
}
/** The instance view of a virtual machine scale set VM. */
export interface VirtualMachineScaleSetVMInstanceView {
/** The Update Domain count. */
platformUpdateDomain?: number;
/** The Fault Domain count. */
platformFaultDomain?: number;
/** The Remote desktop certificate thumbprint. */
rdpThumbPrint?: string;
/** The VM Agent running on the virtual machine. */
vmAgent?: VirtualMachineAgentInstanceView;
/** The Maintenance Operation status on the virtual machine. */
maintenanceRedeployStatus?: MaintenanceRedeployStatus;
/** The disks information. */
disks?: DiskInstanceView[];
/** The extensions information. */
extensions?: VirtualMachineExtensionInstanceView[];
/**
* The health status for the VM.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly vmHealth?: VirtualMachineHealthStatus;
/** Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. You can easily view the output of your console log. Azure also enables you to see a screenshot of the VM from the hypervisor. */
bootDiagnostics?: BootDiagnosticsInstanceView;
/** The resource status information. */
statuses?: InstanceViewStatus[];
/**
* Resource id of the dedicated host, on which the virtual machine is allocated through automatic placement, when the virtual machine is associated with a dedicated host group that has automatic placement enabled. Minimum api-version: 2020-06-01.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly assignedHost?: string;
/** The placement group in which the VM is running. If the VM is deallocated it will not have a placementGroupId. */
placementGroupId?: string;
/** Specifies the host OS name of the virtual machine. This name cannot be updated after the VM is created. **Max-length (Windows):** 15 characters **Max-length (Linux):** 64 characters. For naming conventions and restrictions see [Azure infrastructure services implementation guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions). */
computerName?: string;
/** The Operating System running on the hybrid machine. */
osName?: string;
/** The version of Operating System running on the hybrid machine. */
osVersion?: string;
/** The hypervisor generation of the Virtual Machine [V1, V2] */
hyperVGeneration?: HyperVGeneration;
}
/** Describes a virtual machine scale set VM network profile. */
export interface VirtualMachineScaleSetVMNetworkProfileConfiguration {
/** The list of network configurations. */
networkInterfaceConfigurations?: VirtualMachineScaleSetNetworkConfiguration[];
}
/** The protection policy of a virtual machine scale set VM. */
export interface VirtualMachineScaleSetVMProtectionPolicy {
/** Indicates that the virtual machine scale set VM shouldn't be considered for deletion during a scale-in operation. */
protectFromScaleIn?: boolean;
/** Indicates that model updates or actions (including scale-in) initiated on the virtual machine scale set should not be applied to the virtual machine scale set VM. */
protectFromScaleSetActions?: boolean;
}
/** Specifies the input for attaching and detaching a list of managed data disks. */
export interface AttachDetachDataDisksRequest {
/** The list of managed data disks to be attached. */
dataDisksToAttach?: DataDisksToAttach[];
/** The list of managed data disks to be detached. */
dataDisksToDetach?: DataDisksToDetach[];
}
/** Describes the data disk to be attached. */
export interface DataDisksToAttach {
/** ID of the managed data disk. */
diskId: string;
/** The logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM. If not specified, lun would be auto assigned. */
lun?: number;
/** Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The defaulting behavior is: **None for Standard storage. ReadOnly for Premium storage.** */
caching?: CachingTypes;
/** Specifies whether data disk should be deleted or detached upon VM deletion. Possible values are: **Delete.** If this value is used, the data disk is deleted when VM is deleted. **Detach.** If this value is used, the data disk is retained after VM is deleted. The default value is set to **Detach**. */
deleteOption?: DiskDeleteOptionTypes;
/** Specifies the customer managed disk encryption set resource id for the managed disk. */
diskEncryptionSet?: DiskEncryptionSetParameters;
/** Specifies whether writeAccelerator should be enabled or disabled on the disk. */
writeAcceleratorEnabled?: boolean;
}
/** Describes the data disk to be detached. */
export interface DataDisksToDetach {
/** ID of the managed data disk. */
diskId: string;
/** Supported options available for Detach of a disk from a VM. Refer to DetachOption object reference for more details. */
detachOption?: DiskDetachOptionTypes;
}
/** The List VMSS VM Extension operation response */
export interface VirtualMachineScaleSetVMExtensionsListResult {
/** The list of VMSS VM extensions */
value?: VirtualMachineScaleSetVMExtension[];
}
/** The SAS URIs of the console screenshot and serial log blobs. */
export interface RetrieveBootDiagnosticsDataResult {
/**
* The console screenshot blob URI
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly consoleScreenshotBlobUri?: string;
/**
* The serial console log blob URI.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly serialConsoleLogBlobUri?: string;
}
/** Capture Virtual Machine parameters. */
export interface RunCommandInput {
/** Specifies a commandId of predefined built-in script. Command IDs available for Linux are listed at https://aka.ms/RunCommandManagedLinux#available-commands, Windows at https://aka.ms/RunCommandManagedWindows#available-commands. */
commandId: string;
/** Optional. The script to be executed. When this value is given, the given script will override the default script of the command. */
script?: string[];
/** The run command parameters. */
parameters?: RunCommandInputParameter[];
}
/** Describes the properties of a run command parameter. */
export interface RunCommandInputParameter {
/** The run command parameter name. */
name: string;
/** The run command parameter value. */
value: string;
}
export interface RunCommandResult {
/** Run command operation response. */
value?: InstanceViewStatus[];
}
/** The List run command operation response */
export interface VirtualMachineRunCommandsListResult {
/** The list of run commands. */
value: VirtualMachineRunCommand[];
/** The uri to fetch the next page of run commands. */
nextLink?: string;
}
/** Describes the script sources for run command. Use only one of these script sources: script, scriptUri, commandId, galleryScriptReferenceId. */
export interface VirtualMachineRunCommandScriptSource {
/** Specifies the script content to be executed on the VM. */
script?: string;
/** Specifies the script download location. It can be either SAS URI of an Azure storage blob with read access or public URI. */
scriptUri?: string;
/** Specifies a commandId of predefined built-in script. Command IDs available for Linux are listed at https://aka.ms/RunCommandManagedLinux#available-commands, Windows at https://aka.ms/RunCommandManagedWindows#available-commands. */
commandId?: string;
/** User-assigned managed identity that has access to scriptUri in case of Azure storage blob. Use an empty object in case of system-assigned identity. Make sure the Azure storage blob exists, and managed identity has been given access to blob's container with 'Storage Blob Data Reader' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged. */
scriptUriManagedIdentity?: RunCommandManagedIdentity;
/** Optional. Specify which shell to use for running the script. These values must match those expected by the extension. Currently supported only for Windows VMs, script uses Powershell 7 when specified. Powershell 7 must be already installed on the machine to use Powershell7 parameter value. */
scriptShell?: ScriptShellTypes;
/** The resource ID of a Gallery Script version that needs to be executed. Example ID looks like /subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.Compute/galleries/{galleryName}/scripts/{scriptName}/versions/{version}. */
galleryScriptReferenceId?: string;
}
/** Contains clientId or objectId (use only one, not both) of a user-assigned managed identity that has access to storage blob used in Run Command. Use an empty RunCommandManagedIdentity object in case of system-assigned identity. Make sure the Azure storage blob exists in case of scriptUri, and managed identity has been given access to blob's container with 'Storage Blob Data Reader' role assignment with scriptUri blob and 'Storage Blob Data Contributor' for Append blobs(outputBlobUri, errorBlobUri). In case of user assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged. */
export interface RunCommandManagedIdentity {
/** Client Id (GUID value) of the user-assigned managed identity. ObjectId should not be used if this is provided. */
clientId?: string;
/** Object Id (GUID value) of the user-assigned managed identity. ClientId should not be used if this is provided. */
objectId?: string;
}
/** The instance view of a virtual machine run command. */
export interface VirtualMachineRunCommandInstanceView {
/** Script execution status. */
executionState?: ExecutionState;
/** Communicate script configuration errors or execution messages. */
executionMessage?: string;
/** Exit code returned from script execution. */
exitCode?: number;
/** Script output stream. */
output?: string;
/** Script error stream. */
error?: string;
/** Script start time. */
startTime?: Date;
/** Script end time. */
endTime?: Date;
/** The resource status information. */
statuses?: InstanceViewStatus[];
}
/** Describes the properties of an AssessPatches result. */
export interface VirtualMachineAssessPatchesResult {
/**
* The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Unknown", "Failed", "Succeeded", or "CompletedWithWarnings."
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly status?: PatchOperationStatus;
/**
* The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly assessmentActivityId?: string;
/**
* The overall reboot status of the VM. It will be true when partially installed patches require a reboot to complete installation but the reboot has not yet occurred.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly rebootPending?: boolean;
/**
* The number of critical or security patches that have been detected as available and not yet installed.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly criticalAndSecurityPatchCount?: number;
/**
* The number of all available patches excluding critical and security.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly otherPatchCount?: number;
/**
* The UTC timestamp when the operation began.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly startDateTime?: Date;
/**
* The list of patches that have been detected as available for installation.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly availablePatches?: VirtualMachineSoftwarePatchProperties[];
/**
* The errors that were encountered during execution of the operation. The details array contains the list of them.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly error?: ApiError;
}
/** Describes the properties of a Virtual Machine software patch. */
export interface VirtualMachineSoftwarePatchProperties {
/**
* A unique identifier for the patch.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly patchId?: string;
/**
* The friendly name of the patch.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly name?: string;
/**
* The version number of the patch. This property applies only to Linux patches.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly version?: string;
/**
* The KBID of the patch. Only applies to Windows patches.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly kbId?: string;
/**
* The classification(s) of the patch as provided by the patch publisher.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly classifications?: string[];
/**
* Describes the reboot requirements of the patch.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly rebootBehavior?: VMGuestPatchRebootBehavior;
/**
* The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly activityId?: string;
/**
* The UTC timestamp when the repository published this patch.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly publishedDate?: Date;
/**
* The UTC timestamp of the last update to this patch record.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly lastModifiedDateTime?: Date;
/**
* Describes the availability of a given patch.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly assessmentState?: PatchAssessmentState;
}
/** Capture Virtual Machine parameters. */
export interface VirtualMachineCaptureParameters {
/** The captured virtual hard disk's name prefix. */
vhdPrefix: string;
/** The destination container name. */
destinationContainerName: string;
/** Specifies whether to overwrite the destination virtual hard disk, in case of conflict. */
overwriteVhds: boolean;
}
/** The List Extension operation response */
export interface VirtualMachineExtensionsListResult {
/** The list of extensions */
value?: VirtualMachineExtension[];
}
/** Input for InstallPatches as directly received by the API */
export interface VirtualMachineInstallPatchesParameters {
/** Specifies the maximum amount of time that the operation will run. It must be an ISO 8601-compliant duration string such as PT4H (4 hours) */
maximumDuration?: string;
/** Defines when it is acceptable to reboot a VM during a software update operation. */
rebootSetting: VMGuestPatchRebootSetting;
/** Input for InstallPatches on a Windows VM, as directly received by the API */
windowsParameters?: WindowsParameters;
/** Input for InstallPatches on a Linux VM, as directly received by the API */
linuxParameters?: LinuxParameters;
}
/** Input for InstallPatches on a Windows VM, as directly received by the API */
export interface WindowsParameters {
/** The update classifications to select when installing patches for Windows. */
classificationsToInclude?: VMGuestPatchClassificationWindows[];
/** Kbs to include in the patch operation */
kbNumbersToInclude?: string[];
/** Kbs to exclude in the patch operation */
kbNumbersToExclude?: string[];
/** Filters out Kbs that don't have an InstallationRebootBehavior of 'NeverReboots' when this is set to true. */
excludeKbsRequiringReboot?: boolean;
/** This is used to install patches that were published on or before this given max published date. */
maxPatchPublishDate?: Date;
/** This is used to include patches that match the given patch name masks. Alphanumeric strings and wildcard expressions consisting of * and ? are only supported as input values in the list. Null, empty and only whitespaces strings as inputs values are not supported. */
patchNameMasksToInclude?: string[];
/** This is used to exclude patches that match the given patch name masks. Alphanumeric strings and wildcard expressions consisting of * and ? are only supported as input values in the list. Null, empty and only whitespaces strings as inputs values are not supported. */
patchNameMasksToExclude?: string[];
}
/** Input for InstallPatches on a Linux VM, as directly received by the API */
export interface LinuxParameters {
/** The update classifications to select when installing patches for Linux. */
classificationsToInclude?: VMGuestPatchClassificationLinux[];
/** packages to include in the patch operation. Format: packageName_packageVersion */
packageNameMasksToInclude?: string[];
/** packages to exclude in the patch operation. Format: packageName_packageVersion */
packageNameMasksToExclude?: string[];
/** This is used as a maintenance run identifier for Auto VM Guest Patching in Linux. */
maintenanceRunId?: string;
}
/** The result summary of an installation operation. */
export interface VirtualMachineInstallPatchesResult {
/**
* The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Failed", "Succeeded", "Unknown" or "CompletedWithWarnings."
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly status?: PatchOperationStatus;
/**
* The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly installationActivityId?: string;
/**
* The reboot state of the VM following completion of the operation.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly rebootStatus?: VMGuestPatchRebootStatus;
/**
* Whether the operation ran out of time before it completed all its intended actions.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly maintenanceWindowExceeded?: boolean;
/**
* The number of patches that were not installed due to the user blocking their installation.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly excludedPatchCount?: number;
/**
* The number of patches that were detected as available for install, but did not meet the operation's criteria.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly notSelectedPatchCount?: number;
/**
* The number of patches that were identified as meeting the installation criteria, but were not able to be installed. Typically this happens when maintenanceWindowExceeded == true.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly pendingPatchCount?: number;
/**
* The number of patches successfully installed.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly installedPatchCount?: number;
/**
* The number of patches that could not be installed due to some issue. See errors for details.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly failedPatchCount?: number;
/**
* The patches that were installed during the operation.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly patches?: PatchInstallationDetail[];
/**
* The UTC timestamp when the operation began.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly startDateTime?: Date;
/**
* The errors that were encountered during execution of the operation. The details array contains the list of them.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly error?: ApiError;
}
/** Information about a specific patch that was encountered during an installation action. */
export interface PatchInstallationDetail {
/**
* A unique identifier for the patch.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly patchId?: string;
/**
* The friendly name of the patch.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly name?: string;
/**
* The version string of the package. It may conform to Semantic Versioning. Only applies to Linux.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly version?: string;
/**
* The KBID of the patch. Only applies to Windows patches.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly kbId?: string;
/**
* The classification(s) of the patch as provided by the patch publisher.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly classifications?: string[];
/**
* The state of the patch after the installation operation completed.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly installationState?: PatchInstallationState;
}
/** The input of virtual machine migration from Availability Set to Flexible Virtual Machine Scale Set. */
export interface MigrateVMToVirtualMachineScaleSetInput {
/** The target zone of VM migration to Flexible Virtual Machine Scale Set. */
targetZone?: string;
/** The target compute fault domain of VM migration to Flexible Virtual Machine Scale Set. */
targetFaultDomain?: number;
/** The target Virtual Machine size of VM migration to Flexible Virtual Machine Scale Set. */
targetVMSize?: string;
}
/** The List disk access operation response. */
export interface DiskAccessList {
/** The DiskAccess items on this page */
value: DiskAccess[];
/** The link to the next page of items */
nextLink?: string;
}
/** The Private Endpoint resource. */
export interface PrivateEndpoint {
/**
* The ARM identifier for Private Endpoint
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly id?: string;
}
/** A collection of information about the state of the connection between service consumer and provider. */
export interface PrivateLinkServiceConnectionState {
/** Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. */
status?: PrivateEndpointServiceConnectionStatus;
/** The reason for approval/rejection of the connection. */
description?: string;
/** A message indicating if changes on the service provider require any updates on the consumer. */
actionsRequired?: string;
}
/** The List disk encryption set operation response. */
export interface DiskEncryptionSetList {
/** The DiskEncryptionSet items on this page */
value: DiskEncryptionSet[];
/** The link to the next page of items */
nextLink?: string;
}
/** Key Vault Key Url to be used for server side encryption of Managed Disks and Snapshots */
export interface KeyForDiskEncryptionSet {
/** Resource id of the KeyVault containing the key or secret. This property is optional and cannot be used if the KeyVault subscription is not the same as the Disk Encryption Set subscription. */
sourceVault?: SourceVault;
/** Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value. */
keyUrl: string;
}
/** The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} */
export interface SourceVault {
/** Resource Id */
id?: string;
}
/** The managed identity for the disk encryption set. It should be given permission on the key vault before it can be used to encrypt disks. */
export interface EncryptionSetIdentity {
/** The type of Managed Identity used by the DiskEncryptionSet. Only SystemAssigned is supported for new creations. Disk Encryption Sets can be updated with Identity type None during migration of subscription to a new Azure Active Directory tenant; it will cause the encrypted resources to lose access to the keys. */
type?: DiskEncryptionSetIdentityType;
/**
* The object id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-identity-principal-id header in the PUT request if the resource has a systemAssigned(implicit) identity
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly principalId?: string;
/**
* The tenant id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-client-tenant-id header in the PUT request if the resource has a systemAssigned(implicit) identity
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly tenantId?: string;
/** The list of user identities associated with the disk encryption set. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. */
userAssignedIdentities?: {
[propertyName: string]: UserAssignedIdentitiesValue;
};
}
/** The List Disks operation response. */
export interface DiskList {
/** The Disk items on this page */
value: Disk[];
/** The link to the next page of items */
nextLink?: string;
}
/** Used for establishing the purchase context of any 3rd Party artifact through MarketPlace. */
export interface DiskPurchasePlan {
/** The plan ID. */
name: string;
/** The publisher ID. */
publisher: string;
/** Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. */
product: string;
/** The Offer Promotion Code. */
promotionCode?: string;
}
/** List of supported capabilities persisted on the disk resource for VM use. */
export interface SupportedCapabilities {
/** The disk controllers that an OS disk supports. If set it can be SCSI or SCSI, NVME or NVME, SCSI. */
diskControllerTypes?: string;
/** True if the image from which the OS disk is created supports accelerated networking. */
acceleratedNetwork?: boolean;
/** CPU architecture supported by an OS disk. */
architecture?: Architecture;
/** Refers to the security capability of the disk supported to create a Trusted launch or Confidential VM */
supportedSecurityOption?: SupportedSecurityOption;
}
/** Data used when creating a disk. */
export interface CreationData {
/** This enumerates the possible sources of a disk's creation. */
createOption: DiskCreateOption;
/** Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk. */
storageAccountId?: string;
/** Disk source information for PIR or user images. */
imageReference?: ImageDiskReference;
/** Required if creating from a Gallery Image. The id/sharedGalleryImageId/communityGalleryImageId of the ImageDiskReference will be the ARM id of the shared galley image version from which to create a disk. */
galleryImageReference?: ImageDiskReference;
/** If createOption is Import, this is the URI of a blob to be imported into a managed disk. */
sourceUri?: string;
/** If createOption is Copy, this is the ARM id of the source snapshot or disk. */
sourceResourceId?: string;
/**
* If this field is set, this is the unique id identifying the source of this resource.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly sourceUniqueId?: string;
/** If createOption is Upload, this is the size of the contents of the upload including the VHD footer. This value should be between 20972032 (20 MiB + 512 bytes for the VHD footer) and 35183298347520 bytes (32 TiB + 512 bytes for the VHD footer). */
uploadSizeBytes?: number;
/** Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default. */
logicalSectorSize?: number;
/** If createOption is ImportSecure, this is the URI of a blob to be imported into VM guest state. */
securityDataUri?: string;
/** If createOption is ImportSecure, this is the URI of a blob to be imported into VM metadata for Confidential VM. */
securityMetadataUri?: string;
/** Set this flag to true to get a boost on the performance target of the disk deployed, see here on the respective performance target. This flag can only be set on disk creation time and cannot be disabled after enabled. */
performancePlus?: boolean;
/** Required if createOption is CopyFromSanSnapshot. This is the ARM id of the source elastic san volume snapshot. */
elasticSanResourceId?: string;
/** If this field is set on a snapshot and createOption is CopyStart, the snapshot will be copied at a quicker speed. */
provisionedBandwidthCopySpeed?: ProvisionedBandwidthCopyOption;
/** For snapshots created from Premium SSD v2 or Ultra disk, this property determines the time in minutes the snapshot is retained for instant access to enable faster restore. */
instantAccessDurationMinutes?: number;
}
/** The source image used for creating the disk. */
export interface ImageDiskReference {
/** A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference. */
id?: string;
/** A relative uri containing a direct shared Azure Compute Gallery image reference. */
sharedGalleryImageId?: string;
/** A relative uri containing a community Azure Compute Gallery image reference. */
communityGalleryImageId?: string;
/** If the disk is created from an image's data disk, this is an index that indicates which of the data disks in the image to use. For OS disks, this field is null. */
lun?: number;
}
/** Encryption settings for disk or snapshot */
export interface EncryptionSettingsCollection {
/** Set this flag to true and provide DiskEncryptionKey and optional KeyEncryptionKey to enable encryption. Set this flag to false and remove DiskEncryptionKey and KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the request object, the existing settings remain unchanged. */
enabled: boolean;
/** A collection of encryption settings, one for each disk volume. */
encryptionSettings?: EncryptionSettingsElement[];
/** Describes what type of encryption is used for the disks. Once this field is set, it cannot be overwritten. '1.0' corresponds to Azure Disk Encryption with AAD app.'1.1' corresponds to Azure Disk Encryption. */
encryptionSettingsVersion?: string;
}
/** Encryption settings for one disk volume. */
export interface EncryptionSettingsElement {
/** Key Vault Secret Url and vault id of the disk encryption key */
diskEncryptionKey?: KeyVaultAndSecretReference;
/** Key Vault Key Url and vault id of the key encryption key. KeyEncryptionKey is optional and when provided is used to unwrap the disk encryption key. */
keyEncryptionKey?: KeyVaultAndKeyReference;
}
/** Key Vault Secret Url and vault id of the encryption key */
export interface KeyVaultAndSecretReference {
/** Resource id of the KeyVault containing the key or secret */
sourceVault: SourceVault;
/** Url pointing to a key or secret in KeyVault */
secretUrl: string;
}
/** Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey */
export interface KeyVaultAndKeyReference {
/** Resource id of the KeyVault containing the key or secret */
sourceVault: SourceVault;
/** Url pointing to a key or secret in KeyVault */
keyUrl: string;
}
/** Encryption at rest settings for disk or snapshot */
export interface Encryption {
/** ResourceId of the disk encryption set to use for enabling encryption at rest. */
diskEncryptionSetId?: string;
/** The type of key used to encrypt the data of the disk. */
type?: EncryptionType;
}
export interface ShareInfoElement {
/**
* A relative URI containing the ID of the VM that has the disk attached.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly vmUri?: string;
}
/** Properties of the disk for which update is pending. */
export interface PropertyUpdatesInProgress {
/** The target performance tier of the disk if a tier change operation is in progress. */
targetTier?: string;
}
/** Contains the security related information for the resource. */
export interface DiskSecurityProfile {
/** Specifies the SecurityType of the VM. Applicable for OS disks only. */
securityType?: DiskSecurityTypes;
/** ResourceId of the disk encryption set associated to Confidential VM supported disk encrypted with customer managed key */
secureVMDiskEncryptionSetId?: string;
}
/** In the case of an availability or connectivity issue with the data disk, specify the behavior of your VM */
export interface AvailabilityPolicy {
/** Determines on how to handle disks with slow I/O. */
actionOnDiskDelay?: AvailabilityPolicyDiskDelay;
}
/** The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, UltraSSD_LRS, Premium_ZRS, StandardSSD_ZRS, or PremiumV2_LRS. */
export interface DiskSku {
/** The sku name. */
name?: DiskStorageAccountTypes;
/**
* The sku tier.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly tier?: string;
}
/** The List Snapshots operation response. */
export interface SnapshotList {
/** A list of snapshots. */
value: Snapshot[];
/** The link to the next page of items */
nextLink?: string;
}
/** Indicates the error details if the background copy of a resource created via the CopyStart operation fails. */
export interface CopyCompletionError {
/** Indicates the error code if the background copy of a resource created via the CopyStart operation fails. */
errorCode: CopyCompletionErrorReason;
/** Indicates the error message if the background copy of a resource created via the CopyStart operation fails. */
errorMessage: string;
}
/** The snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS. This is an optional parameter for incremental snapshot and the default behavior is the SKU will be set to the same sku as the previous snapshot */
export interface SnapshotSku {
/** The sku name. */
name?: SnapshotStorageAccountTypes;
/**
* The sku tier.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly tier?: string;
}
/** Used for updating a disk access resource. */
export interface DiskAccessUpdate {
/** Resource tags */
tags?: {
[propertyName: string]: string;
};
}
/** A list of private link resources */
export interface PrivateEndpointConnectionListResult {
/** The PrivateEndpointConnection items on this page */
value: PrivateEndpointConnection[];
/** The link to the next page of items */
nextLink?: string;
}
/** A list of private link resources */
export interface PrivateLinkResourceListResult {
/** Array of private link resources */
value?: PrivateLinkResource[];
}
/** A private link resource */
export interface PrivateLinkResource {
/**
* private link resource Id
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly id?: string;
/**
* private link resource name
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly name?: string;
/**
* private link resource type
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly type?: string;
/**
* The private link resource group id.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly groupId?: string;
/**
* The private link resource required member names.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly requiredMembers?: string[];
/** The private link resource DNS zone name. */
requiredZoneNames?: string[];
}
/** disk encryption set update resource. */
export interface DiskEncryptionSetUpdate {
/** Resource tags */
tags?: {
[propertyName: string]: string;
};
/** The managed identity for the disk encryption set. It should be given permission on the key vault before it can be used to encrypt disks. */
identity?: EncryptionSetIdentity;
/** The type of key used to encrypt the data of the disk. */
encryptionType?: DiskEncryptionSetType;
/** Key Vault Key Url to be used for server side encryption of Managed Disks and Snapshots */
activeKey?: KeyForDiskEncryptionSet;
/** Set this flag to true to enable auto-updating of this disk encryption set to the latest key version. */
rotationToLatestKeyVersionEnabled?: boolean;
/** Multi-tenant application client id to access key vault in a different tenant. Setting the value to 'None' will clear the property. */
federatedClientId?: string;
}
/** The List resources which are encrypted with the disk encryption set. */
export interface ResourceUriList {
/** A list of IDs or Owner IDs of resources which are encrypted with the disk encryption set. */
value: string[];
/** The uri to fetch the next page of encrypted resources. Call ListNext() with this to fetch the next page of encrypted resources. */
nextLink?: string;
}
/** Disk update resource. */
export interface DiskUpdate {
/** Resource tags */
tags?: {
[propertyName: string]: string;
};
/** The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, UltraSSD_LRS, Premium_ZRS, StandardSSD_ZRS, or PremiumV2_LRS. */
sku?: DiskSku;
/** the Operating System type. */
osType?: OperatingSystemTypes;
/** If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size. */
diskSizeGB?: number;
/** Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot. */
encryptionSettingsCollection?: EncryptionSettingsCollection;
/** The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes. */
diskIopsReadWrite?: number;
/** The bandwidth allowed for this disk; only settable for UltraSSD disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10. */
diskMBpsReadWrite?: number;
/** The total number of IOPS that will be allowed across all VMs mounting the shared disk as ReadOnly. One operation can transfer between 4k and 256k bytes. */
diskIopsReadOnly?: number;
/** The total throughput (MBps) that will be allowed across all VMs mounting the shared disk as ReadOnly. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10. */
diskMBpsReadOnly?: number;
/** The maximum number of VMs that can attach to the disk at the same time. Value greater than one indicates a disk that can be mounted on multiple VMs at the same time. */
maxShares?: number;
/** Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys. */
encryption?: Encryption;
/** Policy for accessing the disk via network. */
networkAccessPolicy?: NetworkAccessPolicy;
/** ARM id of the DiskAccess resource for using private endpoints on disks. */
diskAccessId?: string;
/** Performance tier of the disk (e.g, P4, S10) as described here: https://azure.microsoft.com/en-us/pricing/details/managed-disks/. Does not apply to Ultra disks. */
tier?: string;
/** Set to true to enable bursting beyond the provisioned performance target of the disk. Bursting is disabled by default. Does not apply to Ultra disks. */
burstingEnabled?: boolean;
/** Purchase plan information to be added on the OS disk */
purchasePlan?: DiskPurchasePlan;
/** List of supported capabilities to be added on the OS disk. */
supportedCapabilities?: SupportedCapabilities;
/**
* Properties of the disk for which update is pending.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly propertyUpdatesInProgress?: PropertyUpdatesInProgress;
/** Indicates the OS on a disk supports hibernation. */
supportsHibernation?: boolean;
/** Policy for controlling export on the disk. */
publicNetworkAccess?: PublicNetworkAccess;
/** Additional authentication requirements when exporting or uploading to a disk or snapshot. */
dataAccessAuthMode?: DataAccessAuthMode;
/** Setting this property to true improves reliability and performance of data disks that are frequently (more than 5 times a day) by detached from one virtual machine and attached to another. This property should not be set for disks that are not detached and attached frequently as it causes the disks to not align with the fault domain of the virtual machine. */
optimizedForFrequentAttach?: boolean;
/** Determines how platform treats disk failures */
availabilityPolicy?: AvailabilityPolicy;
}
/** Data used for requesting a SAS. */
export interface GrantAccessData {
/** The Access Level, accepted values include None, Read, Write. */
access: AccessLevel;
/** Time duration in seconds until the SAS access expires. */
durationInSeconds: number;
/** Set this flag to true to get additional SAS for VM guest state */
getSecureVMGuestStateSAS?: boolean;
/** Used to specify the file format when making request for SAS on a VHDX file format snapshot */
fileFormat?: FileFormat;
}
/** A disk access SAS uri. */
export interface AccessUri {
/**
* A SAS uri for accessing a disk.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly accessSAS?: string;
/**
* A SAS uri for accessing a VM guest state.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly securityDataAccessSAS?: string;
/**
* A SAS uri for accessing a VM metadata.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly securityMetadataAccessSAS?: string;
}
/** The List Disk Restore Points operation response. */
export interface DiskRestorePointList {
/** The DiskRestorePoint items on this page */
value: DiskRestorePoint[];
/** The link to the next page of items */
nextLink?: string;
}
/** Snapshot update resource. */
export interface SnapshotUpdate {
/** Resource tags */
tags?: {
[propertyName: string]: string;
};
/** The snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS. This is an optional parameter for incremental snapshot and the default behavior is the SKU will be set to the same sku as the previous snapshot */
sku?: SnapshotSku;
/** the Operating System type. */
osType?: OperatingSystemTypes;
/** If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size. */
diskSizeGB?: number;
/** Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot. */
encryptionSettingsCollection?: EncryptionSettingsCollection;
/** Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys. */
encryption?: Encryption;
/** Policy for accessing the disk via network. */
networkAccessPolicy?: NetworkAccessPolicy;
/** ARM id of the DiskAccess resource for using private endpoints on disks. */
diskAccessId?: string;
/** Indicates the OS on a snapshot supports hibernation. */
supportsHibernation?: boolean;
/** Policy for controlling export on the disk. */
publicNetworkAccess?: PublicNetworkAccess;
/** Additional authentication requirements when exporting or uploading to a disk or snapshot. */
dataAccessAuthMode?: DataAccessAuthMode;
/** List of supported capabilities for the image from which the OS disk was created. */
supportedCapabilities?: SupportedCapabilities;
/**
* The state of snapshot which determines the access availability of the snapshot.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly snapshotAccessState?: SnapshotAccessState;
}
/** The List Resource Skus operation response. */
export interface ResourceSkusResult {
/** The ResourceSku items on this page */
value: ResourceSku[];
/** The link to the next page of items */
nextLink?: string;
}
/** Describes an available Compute SKU. */
export interface ResourceSku {
/**
* The type of resource the SKU applies to.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly resourceType?: string;
/**
* The name of SKU.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly name?: string;
/**
* Specifies the tier of virtual machines in a scale set. Possible Values: **Standard** **Basic**
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly tier?: string;
/**
* The Size of the SKU.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly size?: string;
/**
* The Family of this particular SKU.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly family?: string;
/**
* The Kind of resources that are supported in this SKU.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly kind?: string;
/**
* Specifies the number of virtual machines in the scale set.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly capacity?: ResourceSkuCapacity;
/**
* The set of locations that the SKU is available.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly locations?: string[];
/**
* A list of locations and availability zones in those locations where the SKU is available.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly locationInfo?: ResourceSkuLocationInfo[];
/**
* The api versions that support this SKU.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly apiVersions?: string[];
/**
* Metadata for retrieving price info.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly costs?: ResourceSkuCosts[];
/**
* A name value pair to describe the capability.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly capabilities?: ResourceSkuCapabilities[];
/**
* The restrictions because of which SKU cannot be used. This is empty if there are no restrictions.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly restrictions?: ResourceSkuRestrictions[];
}
/** Describes scaling information of a SKU. */
export interface ResourceSkuCapacity {
/**
* The minimum capacity.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly minimum?: number;
/**
* The maximum capacity that can be set.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly maximum?: number;
/**
* The default capacity.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly default?: number;
/**
* The scale type applicable to the sku.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly scaleType?: ResourceSkuCapacityScaleType;
}
/** Describes an available Compute SKU Location Information. */
export interface ResourceSkuLocationInfo {
/**
* Location of the SKU
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly location?: string;
/**
* List of availability zones where the SKU is supported.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly zones?: string[];
/**
* Details of capabilities available to a SKU in specific zones.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly zoneDetails?: ResourceSkuZoneDetails[];
/**
* The names of extended locations.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly extendedLocations?: string[];
/**
* The type of the extended location.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly type?: ExtendedLocationType;
}
/** Describes The zonal capabilities of a SKU. */
export interface ResourceSkuZoneDetails {
/**
* The set of zones that the SKU is available in with the specified capabilities.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly name?: string[];
/**
* A list of capabilities that are available for the SKU in the specified list of zones.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly capabilities?: ResourceSkuCapabilities[];
}
/** Describes The SKU capabilities object. */
export interface ResourceSkuCapabilities {
/**
* An invariant to describe the feature.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly name?: string;
/**
* An invariant if the feature is measured by quantity.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly value?: string;
}
/** Describes metadata for retrieving price info. */
export interface ResourceSkuCosts {
/**
* Used for querying price from commerce.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly meterID?: string;
/**
* The multiplier is needed to extend the base metered cost.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly quantity?: number;
/**
* An invariant to show the extended unit.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly extendedUnit?: string;
}
/** Describes scaling information of a SKU. */
export interface ResourceSkuRestrictions {
/**
* The type of restrictions.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly type?: ResourceSkuRestrictionsType;
/**
* The value of restrictions. If the restriction type is set to location. This would be different locations where the SKU is restricted.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly values?: string[];
/**
* The information about the restriction where the SKU cannot be used.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly restrictionInfo?: ResourceSkuRestrictionInfo;
/**
* The reason for restriction.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly reasonCode?: ResourceSkuRestrictionsReasonCode;
}
/** Describes an available Compute SKU Restriction Information. */
export interface ResourceSkuRestrictionInfo {
/**
* Locations where the SKU is restricted
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly locations?: string[];
/**
* List of availability zones where the SKU is restricted.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly zones?: 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. */
error?: ErrorDetail;
}
/** The error detail. */
export interface ErrorDetail {
/**
* The error code.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly code?: string;
/**
* The error message.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly message?: string;
/**
* The error target.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly target?: string;
/**
* The error details.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly details?: ErrorDetail[];
/**
* The error additional info.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly additionalInfo?: ErrorAdditionalInfo[];
}
/** The resource management error additional info. */
export interface ErrorAdditionalInfo {
/**
* The additional info type.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly type?: string;
/**
* The additional info.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly info?: any;
}
/** The List Galleries operation response. */
export interface GalleryList {
/** A list of galleries. */
value: Gallery[];
/** The uri to fetch the next page of galleries. Call ListNext() with this to fetch the next page of galleries. */
nextLink?: string;
/** The security profile of a gallery image version */
securityProfile?: ImageVersionSecurityProfile;
}
/** Describes the gallery unique name. */
export interface GalleryIdentifier {
/**
* The unique name of the Shared Image Gallery. This name is generated automatically by Azure.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly uniqueName?: string;
}
/** Profile for gallery sharing to subscription or tenant */
export interface SharingProfile {
/** This property allows you to specify the permission of sharing gallery. Possible values are: **Private,** **Groups,** **Community.** */
permissions?: GallerySharingPermissionTypes;
/**
* A list of sharing profile groups.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly groups?: SharingProfileGroup[];
/** Information of community gallery if current gallery is shared to community. */
communityGalleryInfo?: CommunityGalleryInfo;
}
/** Group of the gallery sharing profile */
export interface SharingProfileGroup {
/** This property allows you to specify the type of sharing group. Possible values are: **Subscriptions,** **AADTenants.** */
type?: SharingProfileGroupTypes;
/** A list of subscription/tenant ids the gallery is aimed to be shared to. */
ids?: string[];
}
/** Information of community gallery if current gallery is shared to community */
export interface CommunityGalleryInfo {
/** The link to the publisher website. Visible to all users. */
publisherUri?: string;
/** Community gallery publisher support email. The email address of the publisher. Visible to all users. */
publisherContact?: string;
/** End-user license agreement for community gallery image. */
eula?: string;
/** The prefix of the gallery name that will be displayed publicly. Visible to all users. */
publicNamePrefix?: string;
/**
* Contains info about whether community gallery sharing is enabled.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly communityGalleryEnabled?: boolean;
/**
* Community gallery public name list.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly publicNames?: string[];
}
/** Contains information about the soft deletion policy of the gallery. */
export interface SoftDeletePolicy {
/** Enables soft-deletion for resources in this gallery, allowing them to be recovered within retention time. */
isSoftDeleteEnabled?: boolean;
}
/** Sharing status of current gallery. */
export interface SharingStatus {
/**
* Aggregated sharing state of current gallery.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly aggregatedState?: SharingState;
/** Summary of all regional sharing status. */
summary?: RegionalSharingStatus[];
}
/** Gallery regional sharing status */
export interface RegionalSharingStatus {
/** Region name */
region?: string;
/**
* Gallery sharing state in current region
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly state?: SharingState;
/** Details of gallery regional sharing failure. */
details?: string;
}
/** Identity for the virtual machine. */
export interface GalleryIdentity {
/**
* The principal id of the gallery identity. This property will only be provided for a system assigned identity.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly principalId?: string;
/**
* The AAD tenant id of the gallery identity. This property will only be provided for a system assigned identity.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly tenantId?: string;
/** The type of identity used for the gallery. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove all identities from the gallery. */
type?: ResourceIdentityType;
/** The list of user identities associated with the gallery. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. */
userAssignedIdentities?: {
[propertyName: string]: UserAssignedIdentitiesValue;
};
}
/** The security profile of a gallery image version */
export interface ImageVersionSecurityProfile {
/** Contains UEFI settings for the image version. */
uefiSettings?: GalleryImageVersionUefiSettings;
}
/** Contains UEFI settings for the image version. */
export interface GalleryImageVersionUefiSettings {
/** The name of the template(s) that contains default UEFI key signatures that will be added to the image. */
signatureTemplateNames?: UefiSignatureTemplateName[];
/** Additional UEFI key signatures that will be added to the image in addition to the signature templates */
additionalSignatures?: UefiKeySignatures;
}
/** Additional UEFI key signatures that will be added to the image in addition to the signature templates */
export interface UefiKeySignatures {
/** The Platform Key of this image version. */
pk?: UefiKey;
/** The Key Encryption Keys of this image version. */
kek?: UefiKey[];
/** The database of UEFI keys for this image version. */
db?: UefiKey[];
/** The database of revoked UEFI keys for this image version. */
dbx?: UefiKey[];
}
/** A UEFI key signature. */
export interface UefiKey {
/** The type of key signature. */
type?: UefiKeyType;
/** The value of the key signature. */
value?: string[];
}
/** The metadata of community gallery. */
export interface CommunityGalleryMetadata {
/** The publisher URI of this community gallery. */
publisherUri?: string;
/** The publisher email id of this community gallery. */
publisherContact: string;
/** The end-user license agreement for this community gallery. */
eula?: string;
/** A list of public names the gallery has. */
publicNames: string[];
/** The link for the privacy statement of this community gallery from the gallery publisher. */
privacyStatementUri?: string;
}
/** Base information about the community gallery resource in azure compute gallery. */
export interface PirCommunityGalleryResource {
/**
* Resource name
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly name?: string;
/**
* Resource location
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly location?: string;
/**
* Resource type
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly type?: string;
/** The unique id of this community gallery. */
uniqueId?: string;
}
/** The List Community Gallery Images operation response. */
export interface CommunityGalleryImageList {
/** A list of community gallery images. */
value: CommunityGalleryImage[];
/** The link to the next page of items */
nextLink?: string;
}
/** This is the community gallery image definition identifier. */
export interface CommunityGalleryImageIdentifier {
/** The name of the gallery image definition publisher. */
publisher?: string;
/** The name of the gallery image definition offer. */
offer?: string;
/** The name of the gallery image definition SKU. */
sku?: string;
}
/** The properties describe the recommended machine configuration for this Image Definition. These properties are updatable. */
export interface RecommendedMachineConfiguration {
/** Describes the resource range. */
vCPUs?: ResourceRange;
/** Describes the resource range. */
memory?: ResourceRange;
}
/** Describes the resource range. */
export interface ResourceRange {
/** The minimum number of the resource. */
min?: number;
/** The maximum number of the resource. */
max?: number;
}
/** Describes the disallowed disk types. */
export interface Disallowed {
/** A list of disk types. */
diskTypes?: string[];
}
/** A feature for gallery image. */
export interface GalleryImageFeature {
/** The name of the gallery image feature. */
name?: string;
/** The value of the gallery image feature. */
value?: string;
/** The minimum gallery image version which supports this feature. */
startsAtVersion?: string;
}
/** Describes the gallery image definition purchase plan. This is used by marketplace images. */
export interface ImagePurchasePlan {
/** The plan ID. */
name?: string;
/** The publisher ID. */
publisher?: string;
/** The product ID. */
product?: string;
}
/** The List Community Gallery Image versions operation response. */
export interface CommunityGalleryImageVersionList {
/** A list of community gallery image versions. */
value: CommunityGalleryImageVersion[];
/** The URI to fetch the next page of community gallery image versions. Call ListNext() with this to fetch the next page of community gallery image versions. */
nextLink?: string;
}
/** This is the storage profile of a Gallery Image Version. */
export interface SharedGalleryImageVersionStorageProfile {
/** This is the OS disk image. */
osDiskImage?: SharedGalleryOSDiskImage;
/** A list of data disk images. */
dataDiskImages?: SharedGalleryDataDiskImage[];
}
/** This is the disk image base class. */
export interface SharedGalleryDiskImage {
/**
* This property indicates the size of the VHD to be created.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly diskSizeGB?: number;
/** The host caching of the disk. Valid values are 'None', 'ReadOnly', and 'ReadWrite' */
hostCaching?: SharedGalleryHostCaching;
}
/** The List Shared Galleries operation response. */
export interface SharedGalleryList {
/** A list of shared galleries. */
value: SharedGallery[];
/** The uri to fetch the next page of shared galleries. Call ListNext() with this to fetch the next page of shared galleries. */
nextLink?: string;
}
/** The Resource model definition. */
export interface PirResource {
/**
* Resource name
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly name?: string;
/**
* Resource location
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly location?: string;
}
/** The List Shared Gallery Images operation response. */
export interface SharedGalleryImageList {
/** A list of shared gallery images. */
value: SharedGalleryImage[];
/** The uri to fetch the next page of shared gallery images. Call ListNext() with this to fetch the next page of shared gallery images. */
nextLink?: string;
}
/** This is the gallery image definition identifier. */
export interface GalleryImageIdentifier {
/** The name of the gallery image definition publisher. */
publisher: string;
/** The name of the gallery image definition offer. */
offer: string;
/** The name of the gallery image definition SKU. */
sku: string;
}
/** The List Shared Gallery Image versions operation response. */
export interface SharedGalleryImageVersionList {
/** The SharedGalleryImageVersion items on this page */
value: SharedGalleryImageVersion[];
/** The link to the next page of items */
nextLink?: string;
}
/** The Update Resource model definition. */
export interface UpdateResourceDefinition {
/**
* Resource Id
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly id?: string;
/**
* Resource name
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly name?: string;
/**
* Resource type
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly type?: string;
/** Resource tags */
tags?: {
[propertyName: string]: string;
};
}
/** The List Gallery Applications operation response. */
export interface GalleryApplicationList {
/** The GalleryApplication items on this page */
value: GalleryApplication[];
/** The link to the next page of items */
nextLink?: string;
}
/** A custom action that can be performed with a Gallery Application Version. */
export interface GalleryApplicationCustomAction {
/** The name of the custom action. Must be unique within the Gallery Application Version. */
name: string;
/** The script to run when executing this custom action. */
script: string;
/** Description to help the users understand what this custom action does. */
description?: string;
/** The parameters that this custom action uses */
parameters?: GalleryApplicationCustomActionParameter[];
}
/** The definition of a parameter that can be passed to a custom action of a Gallery Application Version. */
export interface GalleryApplicationCustomActionParameter {
/** The name of the custom action. Must be unique within the Gallery Application Version. */
name: string;
/** Indicates whether this parameter must be passed when running the custom action. */
required?: boolean;
/** Specifies the type of the custom action parameter. Possible values are: String, ConfigurationDataBlob or LogOutputBlob */
type?: GalleryApplicationCustomActionParameterType;
/** The default value of the parameter. Only applies to string types */
defaultValue?: string;
/** A description to help users understand what this parameter means */
description?: string;
}
/** The List Gallery Application version operation response. */
export interface GalleryApplicationVersionList {
/** A list of gallery Application Versions. */
value: GalleryApplicationVersion[];
/** The uri to fetch the next page of gallery Application Versions. Call ListNext() with this to fetch the next page of gallery Application Versions. */
nextLink?: string;
}
/** The source image from which the Image Version is going to be created. */
export interface UserArtifactSource {
/** Required. The mediaLink of the artifact, must be a readable storage page blob. */
mediaLink: string;
/** Optional. The defaultConfigurationLink of the artifact, must be a readable storage page blob. */
defaultConfigurationLink?: string;
}
export interface UserArtifactManage {
/** Required. The path and arguments to install the gallery application. This is limited to 4096 characters. */
install: string;
/** Required. The path and arguments to remove the gallery application. This is limited to 4096 characters. */
remove: string;
/** Optional. The path and arguments to update the gallery application. If not present, then update operation will invoke remove command on the previous version and install command on the current version of the gallery application. This is limited to 4096 characters. */
update?: string;
}
/** Additional settings for the VM app that contains the target package and config file name when it is deployed to target VM or VM scale set. */
export interface UserArtifactSettings {
/** Optional. The name to assign the downloaded package file on the VM. This is limited to 4096 characters. If not specified, the package file will be named the same as the Gallery Application name. */
packageFileName?: string;
/** Optional. The name to assign the downloaded config file on the VM. This is limited to 4096 characters. If not specified, the config file will be named the Gallery Application name appended with "_config". */
configFileName?: string;
/** Optional. The action to be taken with regards to install/update/remove of the gallery application in the event of a reboot. */
scriptBehaviorAfterReboot?: GalleryApplicationScriptRebootBehavior;
}
/** Describes the basic gallery artifact publishing profile. */
export interface GalleryArtifactPublishingProfileBase {
/** The target regions where the Image Version is going to be replicated to. This property is updatable. */
targetRegions?: TargetRegion[];
/** The number of replicas of the Image Version to be created per region. This property would take effect for a region when regionalReplicaCount is not specified. This property is updatable. */
replicaCount?: number;
/** If set to true, Virtual Machines deployed from the latest version of the Image Definition won't use this Image Version. */
excludeFromLatest?: boolean;
/**
* The timestamp for when the gallery image version is published.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly publishedDate?: Date;
/** The end of life date of the gallery image version. This property can be used for decommissioning purposes. This property is updatable. */
endOfLifeDate?: Date;
/** Specifies the storage account type to be used to store the image. This property is not updatable. */
storageAccountType?: StorageAccountType;
/** Optional parameter which specifies the mode to be used for replication. This property is not updatable. */
replicationMode?: ReplicationMode;
/** The target extended locations where the Image Version is going to be replicated to. This property is updatable. */
targetExtendedLocations?: GalleryTargetExtendedLocation[];
}
/** Describes the target region information. */
export interface TargetRegion {
/** The name of the region. */
name: string;
/** The number of replicas of the Image Version to be created per region. This property is updatable. */
regionalReplicaCount?: number;
/** Specifies the storage account type to be used to store the image. This property is not updatable. */
storageAccountType?: StorageAccountType;
/** Optional. Allows users to provide customer managed keys for encrypting the OS and data disks in the gallery artifact. */
encryption?: EncryptionImages;
/** Contains the flag setting to hide an image when users specify version='latest' */
excludeFromLatest?: boolean;
/** List of storage sku with replica count to create direct drive replicas. */
additionalReplicaSets?: AdditionalReplicaSet[];
}
/** Optional. Allows users to provide customer managed keys for encrypting the OS and data disks in the gallery artifact. */
export interface EncryptionImages {
/** Contains encryption settings for an OS disk image. */
osDiskImage?: OSDiskImageEncryption;
/** A list of encryption specifications for data disk images. */
dataDiskImages?: DataDiskImageEncryption[];
}
/** Contains security profile for an OS disk image. */
export interface OSDiskImageSecurityProfile {
/** confidential VM encryption types */
confidentialVMEncryptionType?: ConfidentialVMEncryptionType;
/** secure VM disk encryption set id */
secureVMDiskEncryptionSetId?: string;
}
/** This is the disk image encryption base class. */
export interface DiskImageEncryption {
/** A relative URI containing the resource ID of the disk encryption set. */
diskEncryptionSetId?: string;
}
/** Describes the additional replica set information. */
export interface AdditionalReplicaSet {
/** Specifies the storage account type to be used to create the direct drive replicas */
storageAccountType?: StorageAccountType;
/** The number of direct drive replicas of the Image Version to be created.This Property is updatable */
regionalReplicaCount?: number;
}
export interface GalleryTargetExtendedLocation {
/** The name of the region. */
name?: string;
/** The name of the extended location. */
extendedLocation?: GalleryExtendedLocation;
/** The number of replicas of the Image Version to be created per extended location. This property is updatable. */
extendedLocationReplicaCount?: number;
/** Specifies the storage account type to be used to store the image. This property is not updatable. */
storageAccountType?: EdgeZoneStorageAccountType;
/** Optional. Allows users to provide customer managed keys for encrypting the OS and data disks in the gallery artifact. */
encryption?: EncryptionImages;
}
/** The name of the extended location. */
export interface GalleryExtendedLocation {
name?: string;
/** It is type of the extended location. */
type?: GalleryExtendedLocationType;
}
/** This is the safety profile of the Gallery Artifact Version. */
export interface GalleryArtifactSafetyProfileBase {
/** Indicates whether or not removing this Gallery Image Version from replicated regions is allowed. */
allowDeletionOfReplicatedLocations?: boolean;
}
/** This is the replication status of the gallery image version. */
export interface ReplicationStatus {
/**
* This is the aggregated replication status based on all the regional replication status flags.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly aggregatedState?: AggregatedReplicationState;
/**
* This is a summary of replication status for each region.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly summary?: RegionalReplicationStatus[];
}
/** This is the regional replication status. */
export interface RegionalReplicationStatus {
/**
* The region to which the gallery image version is being replicated to.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly region?: string;
/**
* This is the regional replication state.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly state?: ReplicationState;
/**
* The details of the replication status.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly details?: string;
/**
* It indicates progress of the replication job.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly progress?: number;
}
/** The List Gallery Images operation response. */
export interface GalleryImageList {
/** A list of Shared Image Gallery images. */
value: GalleryImage[];
/** The uri to fetch the next page of Image Definitions in the Shared Image Gallery. Call ListNext() with this to fetch the next page of gallery image definitions. */
nextLink?: string;
}
/** The List Gallery Image version operation response. */
export interface GalleryImageVersionList {
/** A list of gallery image versions. */
value: GalleryImageVersion[];
/** The uri to fetch the next page of gallery image versions. Call ListNext() with this to fetch the next page of gallery image versions. */
nextLink?: string;
}
/** This is the storage profile of a Gallery Image Version. */
export interface GalleryImageVersionStorageProfile {
/** The source of the gallery artifact version. */
source?: GalleryArtifactVersionFullSource;
/** This is the OS disk image. */
osDiskImage?: GalleryOSDiskImage;
/** A list of data disk images. */
dataDiskImages?: GalleryDataDiskImage[];
}
/** The gallery artifact version source. */
export interface GalleryArtifactVersionSource {
/** The id of the gallery artifact version source. */
id?: string;
}
/** This is the disk image base class. */
export interface GalleryDiskImage {
/**
* This property indicates the size of the VHD to be created.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly sizeInGB?: number;
/** The host caching of the disk. Valid values are 'None', 'ReadOnly', and 'ReadWrite' */
hostCaching?: HostCaching;
/** The source for the disk image. */
source?: GalleryDiskImageSource;
}
/** A policy violation reported against a gallery artifact. */
export interface PolicyViolation {
/** Describes the nature of the policy violation. */
category?: PolicyViolationCategory;
/** Describes specific details about why this policy violation was reported. */
details?: string;
}
/** This is the validations profile of a Gallery Image Version. */
export interface ValidationsProfile {
/** The published time of the image version */
validationEtag?: string;
executedValidations?: ExecutedValidation[];
/** This specifies the pub, offer, sku and version of the image version metadata */
platformAttributes?: PlatformAttribute[];
}
/** This is the executed Validation. */
export interface ExecutedValidation {
/** This property specifies the type of image version validation. */
type?: string;
/** This property specifies the status of the validationProfile of the image version. */
status?: ValidationStatus;
/** This property specifies the valid version of the validation. */
version?: string;
/** This property specifies the starting timestamp. */
executionTime?: Date;
}
/** This is the platform attribute of the image version. */
export interface PlatformAttribute {
/**
* This property specifies the name of the platformAttribute. It is read-only.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly name?: string;
/**
* This property specifies the value of the corresponding name property. It is read-only.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly value?: string;
}
/** The List Gallery InVMAccessControlProfiles operation response. */
export interface GalleryInVMAccessControlProfileList {
/** The GalleryInVMAccessControlProfile items on this page */
value: GalleryInVMAccessControlProfile[];
/** The link to the next page of items */
nextLink?: string;
}
/** The properties of a gallery ResourceProfile. */
export interface GalleryResourceProfilePropertiesBase {
/**
* The provisioning state, which only appears in the response.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly provisioningState?: GalleryProvisioningState;
}
/** The List Gallery InVMAccessControlProfile Versions operation response. */
export interface GalleryInVMAccessControlProfileVersionList {
/** The GalleryInVMAccessControlProfileVersion items on this page */
value: GalleryInVMAccessControlProfileVersion[];
/** The link to the next page of items */
nextLink?: string;
}
/** This is the Access Control Rules specification for an inVMAccessControlProfile version. */
export interface AccessControlRules {
/** A list of privileges. */
privileges?: AccessControlRulesPrivilege[];
/** A list of roles. */
roles?: AccessControlRulesRole[];
/** A list of identities. */
identities?: AccessControlRulesIdentity[];
/** A list of role assignments. */
roleAssignments?: AccessControlRulesRoleAssignment[];
}
/** The properties of an Access Control Rule Privilege. */
export interface AccessControlRulesPrivilege {
/** The name of the privilege. */
name: string;
/** The HTTP path corresponding to the privilege. */
path: string;
/** The query parameters to match in the path. */
queryParameters?: {
[propertyName: string]: string;
};
}
/** The properties of an Access Control Rule Role. */
export interface AccessControlRulesRole {
/** The name of the role. */
name: string;
/** A list of privileges needed by this role. */
privileges: string[];
}
/** The properties of an Access Control Rule Identity. */
export interface AccessControlRulesIdentity {
/** The name of the identity. */
name: string;
/** The username corresponding to this identity. */
userName?: string;
/** The groupName corresponding to this identity. */
groupName?: string;
/** The path to the executable. */
exePath?: string;
/** The process name of the executable. */
processName?: string;
}
/** The properties of an Access Control Rule RoleAssignment. */
export interface AccessControlRulesRoleAssignment {
/** The name of the role. */
role: string;
/** A list of identities that can access the privileges defined by the role. */
identities: string[];
}
/** The properties of a gallery ResourceProfile version. */
export interface GalleryResourceProfileVersionPropertiesBase {
/** The target regions where the Resource Profile version is going to be replicated to. This property is updatable. */
targetLocations?: TargetRegion[];
/** If set to true, Virtual Machines deployed from the latest version of the Resource Profile won't use this Profile version. */
excludeFromLatest?: boolean;
/**
* The timestamp for when the Resource Profile Version is published.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly publishedDate?: Date;
/**
* The provisioning state, which only appears in the response.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly provisioningState?: GalleryProvisioningState;
/**
* This is the replication status of the gallery image version.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly replicationStatus?: ReplicationStatus;
}
/** Specifies information about the gallery sharing profile update. */
export interface SharingUpdate {
/** This property allows you to specify the operation type of gallery sharing update. Possible values are: **Add,** **Remove,** **Reset.** */
operationType: SharingUpdateOperationTypes;
/** A list of sharing profile groups. */
groups?: SharingProfileGroup[];
}
/** The List Soft-deleted Resources operation response. */
export interface GallerySoftDeletedResourceList {
/** The GallerySoftDeletedResource items on this page */
value: GallerySoftDeletedResource[];
/** The link to the next page of items */
nextLink?: string;
}
/** Describes the cloud service role instance. */
export interface RoleInstance {
/**
* Resource Id
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly id?: string;
/**
* Resource Name.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly name?: string;
/**
* Resource Type.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly type?: string;
/**
* Resource Location.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly location?: string;
/**
* Resource tags.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly tags?: {
[propertyName: string]: string;
};
/** The role instance SKU. */
sku?: InstanceSku;
/** Role instance properties. */
properties?: RoleInstanceProperties;
}
/** The role instance SKU. */
export interface InstanceSku {
/**
* The sku name.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly name?: string;
/**
* The tier of the cloud service role instance.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly tier?: string;
}
/** Role instance properties. */
export interface RoleInstanceProperties {
/** Describes the network profile for the role instance. */
networkProfile?: RoleInstanceNetworkProfile;
/** The instance view of the role instance. */
instanceView?: RoleInstanceView;
}
/** Describes the network profile for the role instance. */
export interface RoleInstanceNetworkProfile {
/**
* Specifies the list of resource Ids for the network interfaces associated with the role instance.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly networkInterfaces?: SubResource[];
}
/** The instance view of the role instance. */
export interface RoleInstanceView {
/**
* The Update Domain.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly platformUpdateDomain?: number;
/**
* The Fault Domain.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly platformFaultDomain?: number;
/**
* Specifies a unique identifier generated internally for the cloud service associated with this role instance. NOTE: If you are using Azure Diagnostics extension, this property can be used as 'DeploymentId' for querying details.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly privateId?: string;
/** NOTE: This property will not be serialized. It can only be populated by the server. */
readonly statuses?: ResourceInstanceViewStatus[];
}
/** Instance view status. */
export interface ResourceInstanceViewStatus {
/**
* The status code.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly code?: string;
/**
* The short localizable label for the status.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly displayStatus?: string;
/**
* The detailed status message, including for alerts and error messages.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly message?: string;
/**
* The time of the status.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly time?: Date;
/** The level code. */
level?: StatusLevelTypes;
}
/** The list operation result. */
export interface RoleInstanceListResult {
/** The list of resources. */
value: RoleInstance[];
/** The URI to fetch the next page of resources. Use this to get the next page of resources. Do this till nextLink is null to fetch all the resources. */
nextLink?: string;
}
/** Describes a role of the cloud service. */
export interface CloudServiceRole {
/**
* Resource id
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly id?: string;
/**
* Resource name
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly name?: string;
/**
* Resource type
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly type?: string;
/**
* Resource location
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly location?: string;
/** Describes the cloud service role sku. */
sku?: CloudServiceRoleSku;
/** The cloud service role properties. */
properties?: CloudServiceRoleProperties;
}
/** Describes the cloud service role sku. */
export interface CloudServiceRoleSku {
/** The sku name. NOTE: If the new SKU is not supported on the hardware the cloud service is currently on, you need to delete and recreate the cloud service or move back to the old sku. */
name?: string;
/** Specifies the tier of the cloud service. Possible Values are **Standard** **Basic** */
tier?: string;
/** Specifies the number of role instances in the cloud service. */
capacity?: number;
}
/** The cloud service role properties. */
export interface CloudServiceRoleProperties {
/**
* Specifies the ID which uniquely identifies a cloud service role.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly uniqueId?: string;
}
/** The list operation result. */
export interface CloudServiceRoleListResult {
/** The list of resources. */
value: CloudServiceRole[];
/** The URI to fetch the next page of resources. Use this to get the next page of resources. Do this till nextLink is null to fetch all the resources. */
nextLink?: string;
}
/** Describes the cloud service. */
export interface CloudService {
/**
* Resource Id.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly id?: string;
/**
* Resource name.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly name?: string;
/**
* Resource type.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly type?: string;
/** Resource location. */
location: string;
/** Resource tags. */
tags?: {
[propertyName: string]: string;
};
/** Cloud service properties */
properties?: CloudServiceProperties;
/**
* 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;
/** List of logical availability zone of the resource. List should contain only 1 zone where cloud service should be provisioned. This field is optional. */
zones?: string[];
}
/** Cloud service properties */
export interface CloudServiceProperties {
/**
* Specifies a URL that refers to the location of the service package in the Blob service. The service package URL can be Shared Access Signature (SAS) URI from any storage account.
* This is a write-only property and is not returned in GET calls.
*/
packageUrl?: string;
/** Specifies the XML service configuration (.cscfg) for the cloud service. */
configuration?: string;
/**
* Specifies a URL that refers to the location of the service configuration in the Blob service. The service package URL can be Shared Access Signature (SAS) URI from any storage account.
* This is a write-only property and is not returned in GET calls.
*/
configurationUrl?: string;
/**
* (Optional) Indicates whether to start the cloud service immediately after it is created. The default value is `true`.
* If false, the service model is still deployed, but the code is not run immediately. Instead, the service is PoweredOff until you call Start, at which time the service will be started. A deployed service still incurs charges, even if it is poweredoff.
*/
startCloudService?: boolean;
/**
* (Optional) Indicates whether the role sku properties (roleProfile.roles.sku) specified in the model/template should override the role instance count and vm size specified in the .cscfg and .csdef respectively.
* The default value is `false`.
*/
allowModelOverride?: boolean;
/**
* Update mode for the cloud service. Role instances are allocated to update domains when the service is deployed. Updates can be initiated manually in each update domain or initiated automatically in all update domains.
* Possible Values are **Auto** **Manual** **Simultaneous** 
* If not specified, the default value is Auto. If set to Manual, PUT UpdateDomain must be called to apply the update. If set to Auto, the update is automatically applied to each update domain in sequence.
*/
upgradeMode?: CloudServiceUpgradeMode;
/** Describes the role profile for the cloud service. */
roleProfile?: CloudServiceRoleProfile;
/** Describes the OS profile for the cloud service. */
osProfile?: CloudServiceOsProfile;
/** Network Profile for the cloud service. */
networkProfile?: CloudServiceNetworkProfile;
/** Describes a cloud service extension profile. */
extensionProfile?: CloudServiceExtensionProfile;
/**
* The provisioning state, which only appears in the response.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly provisioningState?: string;
/**
* The unique identifier for the cloud service.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly uniqueId?: string;
}
/** Describes the role profile for the cloud service. */
export interface CloudServiceRoleProfile {
/** List of roles for the cloud service. */
roles?: CloudServiceRoleProfileProperties[];
}
/** Describes the role properties. */
export interface CloudServiceRoleProfileProperties {
/** Resource name. */
name?: string;
/** Describes the cloud service role sku. */
sku?: CloudServiceRoleSku;
}
/** Describes the OS profile for the cloud service. */
export interface CloudServiceOsProfile {
/** Specifies set of certificates that should be installed onto the role instances. */
secrets?: CloudServiceVaultSecretGroup[];
}
/** Describes a set of certificates which are all in the same Key Vault. */
export interface CloudServiceVaultSecretGroup {
/** The relative URL of the Key Vault containing all of the certificates in VaultCertificates. */
sourceVault?: SubResource;
/** The list of key vault references in SourceVault which contain certificates. */
vaultCertificates?: CloudServiceVaultCertificate[];
}
/** Describes a single certificate reference in a Key Vault, and where the certificate should reside on the role instance. */
export interface CloudServiceVaultCertificate {
/** This is the URL of a certificate that has been uploaded to Key Vault as a secret. */
certificateUrl?: string;
/** Flag indicating if the certificate provided is a bootstrap certificate to be used by the Key Vault Extension to fetch the remaining certificates. */
isBootstrapCertificate?: boolean;
}
/** Network Profile for the cloud service. */
export interface CloudServiceNetworkProfile {
/** List of Load balancer configurations. Cloud service can have up to two load balancer configurations, corresponding to a Public Load Balancer and an Internal Load Balancer. */
loadBalancerConfigurations?: LoadBalancerConfiguration[];
/**
* Slot type for the cloud service.
* Possible values are **Production** **Staging** 
* If not specified, the default value is Production.
*/
slotType?: CloudServiceSlotType;
/** The id reference of the cloud service containing the target IP with which the subject cloud service can perform a swap. This property cannot be updated once it is set. The swappable cloud service referred by this id must be present otherwise an error will be thrown. */
swappableCloudService?: SubResource;
}
/** Describes the load balancer configuration. */
export interface LoadBalancerConfiguration {
/** Resource Id */
id?: string;
/** The name of the Load balancer */
name: string;
/** Properties of the load balancer configuration. */
properties: LoadBalancerConfigurationProperties;
}
/** Describes the properties of the load balancer configuration. */
export interface LoadBalancerConfigurationProperties {
/** Specifies the frontend IP to be used for the load balancer. Only IPv4 frontend IP address is supported. Each load balancer configuration must have exactly one frontend IP configuration. */
frontendIpConfigurations: LoadBalancerFrontendIpConfiguration[];
}
/** Specifies the frontend IP to be used for the load balancer. Only IPv4 frontend IP address is supported. Each load balancer configuration must have exactly one frontend IP configuration. */
export interface LoadBalancerFrontendIpConfiguration {
/** The name of the resource that is unique within the set of frontend IP configurations used by the load balancer. This name can be used to access the resource. */
name: string;
/** Properties of load balancer frontend ip configuration. */
properties: LoadBalancerFrontendIpConfigurationProperties;
}
/** Describes a cloud service IP Configuration */
export interface LoadBalancerFrontendIpConfigurationProperties {
/** The reference to the public ip address resource. */
publicIPAddress?: SubResource;
/** The reference to the virtual network subnet resource. */
subnet?: SubResource;
/** The virtual network private IP address of the IP configuration. */
privateIPAddress?: string;
}
/** Describes a cloud service extension profile. */
export interface CloudServiceExtensionProfile {
/** List of extensions for the cloud service. */
extensions?: Extension[];
}
/** Describes a cloud service Extension. */
export interface Extension {
/** The name of the extension. */
name?: string;
/** Extension Properties. */
properties?: CloudServiceExtensionProperties;
}
/** Extension Properties. */
export interface CloudServiceExtensionProperties {
/** The name of the extension handler publisher. */
publisher?: string;
/** Specifies the type of the extension. */
type?: string;
/** Specifies the version of the extension. Specifies the version of the extension. If this element is not specified or an asterisk (*) is used as the value, the latest version of the extension is used. If the value is specified with a major version number and an asterisk as the minor version number (X.), the latest minor version of the specified major version is selected. If a major version number and a minor version number are specified (X.Y), the specific extension version is selected. If a version is specified, an auto-upgrade is performed on the role instance. */
typeHandlerVersion?: string;
/** Explicitly specify whether platform can automatically upgrade typeHandlerVersion to higher minor versions when they become available. */
autoUpgradeMinorVersion?: boolean;
/** Public settings for the extension. For JSON extensions, this is the JSON settings for the extension. For XML Extension (like RDP), this is the XML setting for the extension. */
settings?: any;
/** Protected settings for the extension which are encrypted before sent to the role instance. */
protectedSettings?: any;
/** Protected settings for the extension, referenced using KeyVault which are encrypted before sent to the role instance. */
protectedSettingsFromKeyVault?: CloudServiceVaultAndSecretReference;
/**
* Tag to force apply the provided public and protected settings.
* Changing the tag value allows for re-running the extension without changing any of the public or protected settings.
* If forceUpdateTag is not changed, updates to public or protected settings would still be applied by the handler.
* If neither forceUpdateTag nor any of public or protected settings change, extension would flow to the role instance with the same sequence-number, and
* it is up to handler implementation whether to re-run it or not
*/
forceUpdateTag?: string;
/**
* The provisioning state, which only appears in the response.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly provisioningState?: string;
/** Optional list of roles to apply this extension. If property is not specified or '*' is specified, extension is applied to all roles in the cloud service. */
rolesAppliedTo?: string[];
}
/** Protected settings for the extension, referenced using KeyVault which are encrypted before sent to the role instance. */
export interface CloudServiceVaultAndSecretReference {
/** The ARM Resource ID of the Key Vault */
sourceVault?: SubResource;
/** Secret URL which contains the protected settings of the extension */
secretUrl?: string;
}
export interface CloudServiceUpdate {
/** Resource tags */
tags?: {
[propertyName: string]: string;
};
}
/** InstanceView of CloudService as a whole */
export interface CloudServiceInstanceView {
/** Instance view statuses. */
roleInstance?: InstanceViewStatusesSummary;
/**
* The version of the SDK that was used to generate the package for the cloud service.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly sdkVersion?: string;
/**
* Specifies a list of unique identifiers generated internally for the cloud service. NOTE: If you are using Azure Diagnostics extension, this property can be used as 'DeploymentId' for querying details.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly privateIds?: string[];
/** NOTE: This property will not be serialized. It can only be populated by the server. */
readonly statuses?: ResourceInstanceViewStatus[];
}
/** Instance view statuses. */
export interface InstanceViewStatusesSummary {
/**
* The summary.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly statusesSummary?: StatusCodeCount[];
}
/** The status code and count of the cloud service instance view statuses */
export interface StatusCodeCount {
/**
* The instance view status code
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly code?: string;
/**
* Number of instances having this status code
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly count?: number;
}
/** The list operation result. */
export interface CloudServiceListResult {
/** The list of resources. */
value: CloudService[];
/** The URI to fetch the next page of resources. Use this to get the next page of resources. Do this till nextLink is null to fetch all the resources. */
nextLink?: string;
}
/** Specifies a list of role instances from the cloud service. */
export interface RoleInstances {
/** List of cloud service role instance names. Value of '*' will signify all role instances of the cloud service. */
roleInstances: string[];
}
/** Defines an update domain for the cloud service. */
export interface UpdateDomain {
/**
* Resource Id
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly id?: string;
/**
* Resource Name
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly name?: string;
}
/** The list operation result. */
export interface UpdateDomainListResult {
/** The list of resources. */
value: UpdateDomain[];
/** The URI to fetch the next page of resources. Use this to get the next page of resources. Do this till nextLink is null to fetch all the resources. */
nextLink?: string;
}
/** Describes a cloud service OS version. */
export interface OSVersion {
/**
* Resource Id.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly id?: string;
/**
* Resource name.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly name?: string;
/**
* Resource type.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly type?: string;
/**
* Resource location.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly location?: string;
/** OS version properties. */
properties?: OSVersionProperties;
}
/** OS version properties. */
export interface OSVersionProperties {
/**
* The family of this OS version.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly family?: string;
/**
* The family label of this OS version.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly familyLabel?: string;
/**
* The OS version.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly version?: string;
/**
* The OS version label.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly label?: string;
/**
* Specifies whether this is the default OS version for its family.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly isDefault?: boolean;
/**
* Specifies whether this OS version is active.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly isActive?: boolean;
}
/** The list operation result. */
export interface OSVersionListResult {
/** The list of resources. */
value: OSVersion[];
/** The URI to fetch the next page of resources. Use this to get the next page of resources. Do this till nextLink is null to fetch all the resources. */
nextLink?: string;
}
/** Describes a cloud service OS family. */
export interface OSFamily {
/**
* Resource Id.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly id?: string;
/**
* Resource name.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly name?: string;
/**
* Resource type.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly type?: string;
/**
* Resource location.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly location?: string;
/** OS family properties. */
properties?: OSFamilyProperties;
}
/** OS family properties. */
export interface OSFamilyProperties {
/**
* The OS family name.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly name?: string;
/**
* The OS family label.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly label?: string;
/**
* List of OS versions belonging to this family.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly versions?: OSVersionPropertiesBase[];
}
/** Configuration view of an OS version. */
export interface OSVersionPropertiesBase {
/**
* The OS version.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly version?: string;
/**
* The OS version label.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly label?: string;
/**
* Specifies whether this is the default OS version for its family.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly isDefault?: boolean;
/**
* Specifies whether this OS version is active.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly isActive?: boolean;
}
/** The list operation result. */
export interface OSFamilyListResult {
/** The list of resources. */
value: OSFamily[];
/** The URI to fetch the next page of resources. Use this to get the next page of resources. Do this till nextLink is null to fetch all the resources. */
nextLink?: string;
}
/** The Resource model definition with location property as optional. */
export interface ResourceWithOptionalLocation {
/** Resource location */
location?: string;
/**
* Resource Id
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly id?: string;
/**
* Resource name
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly name?: string;
/**
* Resource type
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly type?: string;
/** Resource tags */
tags?: {
[propertyName: string]: string;
};
}
/** Describes the parameter of customer managed disk encryption set resource id that can be specified for disk. **Note:** The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details. */
export interface DiskEncryptionSetParameters extends SubResource {
}
/** Virtual machine image resource information. */
export interface VirtualMachineImageResource extends SubResource {
/** The name of the resource. */
name: string;
/** The supported Azure location of the resource. */
location: string;
/** Specifies the tags that are assigned to the virtual machine. For more information about using tags, see [Using tags to organize your Azure resources](https://docs.microsoft.com/azure/azure-resource-manager/resource-group-using-tags.md). */
tags?: {
[propertyName: string]: string;
};
/** The extended location of the Virtual Machine. */
extendedLocation?: ExtendedLocation;
}
/** Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. NOTE: Image reference publisher and offer can only be set when you create the scale set. */
export interface ImageReference extends SubResource {
/** The image publisher. */
publisher?: string;
/** Specifies the offer of the platform image or marketplace image used to create the virtual machine. */
offer?: string;
/** The image SKU. */
sku?: string;
/** Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal numbers. Specify 'latest' to use the latest version of an image available at deploy time. Even if you use 'latest', the VM image will not automatically update after deploy time even if a new version becomes available. Please do not use field 'version' for gallery image deployment, gallery image should always use 'id' field for deployment, to use 'latest' version of gallery image, just set '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}' in the 'id' field without version input. */
version?: string;
/**
* Specifies in decimal numbers, the version of platform image or marketplace image used to create the virtual machine. This readonly field differs from 'version', only if the value specified in 'version' field is 'latest'.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly exactVersion?: string;
/** Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call. */
sharedGalleryImageId?: string;
/** Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call. */
communityGalleryImageId?: string;
}
/** The parameters of a managed disk. */
export interface ManagedDiskParameters extends SubResource {
/** Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk. */
storageAccountType?: StorageAccountTypes;
/** Specifies the customer managed disk encryption set resource id for the managed disk. */
diskEncryptionSet?: DiskEncryptionSetParameters;
/** Specifies the security profile for the managed disk. */
securityProfile?: VMDiskSecurityProfile;
}
/** Describes a network interface reference. */
export interface NetworkInterfaceReference extends SubResource {
/** Specifies the primary network interface in case the virtual machine has more than 1 network interface. */
primary?: boolean;
/** Specify what happens to the network interface when the VM is deleted */
deleteOption?: DeleteOptions;
}
export interface SubResourceWithColocationStatus extends SubResource {
/** Describes colocation status of a resource in the Proximity Placement Group. */
colocationStatus?: InstanceViewStatus;
}
/** Output of virtual machine capture operation. */
export interface VirtualMachineCaptureResult extends SubResource {
/**
* the schema of the captured virtual machine
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly schema?: string;
/**
* the version of the content
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly contentVersion?: string;
/**
* parameters of the captured virtual machine
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly parameters?: any;
/**
* a list of resource items of the captured virtual machine
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly resources?: any[];
}
/** The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location' */
export interface TrackedResource extends Resource {
/** Resource tags. */
tags?: {
[propertyName: string]: string;
};
/** The geo-location where the resource lives */
location: 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 {
}
/** Describes a Virtual Machine Scale Set Extension. */
export interface VirtualMachineScaleSetExtension extends SubResourceReadOnly {
/**
* Resource type
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly type?: string;
/** Resource name */
name?: string;
/** If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed. */
forceUpdateTag?: string;
/** The name of the extension handler publisher. */
publisher?: string;
/** Specifies the type of the extension; an example is "CustomScriptExtension". */
typePropertiesType?: string;
/** Specifies the version of the script handler. */
typeHandlerVersion?: string;
/** Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. */
autoUpgradeMinorVersion?: boolean;
/** Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. */
enableAutomaticUpgrade?: boolean;
/** Json formatted public settings for the extension. */
settings?: any;
/** The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. */
protectedSettings?: any;
/**
* The provisioning state, which only appears in the response.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly provisioningState?: string;
/** Collection of extension names after which this extension needs to be provisioned. */
provisionAfterExtensions?: string[];
/** Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false. */
suppressFailures?: boolean;
/** The extensions protected settings that are passed by reference, and consumed from key vault */
protectedSettingsFromKeyVault?: KeyVaultSecretReference;
}
/** Disk Restore Point details. */
export interface DiskRestorePointAttributes extends SubResourceReadOnly {
/** Encryption at rest settings for disk restore point. It is an optional property that can be specified in the input while creating a restore point. */
encryption?: RestorePointEncryption;
/** Resource Id of the source disk restore point. */
sourceDiskRestorePoint?: ApiEntityReference;
}
/** Describes a Virtual Machine Scale Set Extension. */
export interface VirtualMachineScaleSetExtensionUpdate extends SubResourceReadOnly {
/**
* The name of the extension.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly name?: string;
/**
* Resource type
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly type?: string;
/** If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed. */
forceUpdateTag?: string;
/** The name of the extension handler publisher. */
publisher?: string;
/** Specifies the type of the extension; an example is "CustomScriptExtension". */
typePropertiesType?: string;
/** Specifies the version of the script handler. */
typeHandlerVersion?: string;
/** Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. */
autoUpgradeMinorVersion?: boolean;
/** Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. */
enableAutomaticUpgrade?: boolean;
/** Json formatted public settings for the extension. */
settings?: any;
/** The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. */
protectedSettings?: any;
/**
* The provisioning state, which only appears in the response.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly provisioningState?: string;
/** Collection of extension names after which this extension needs to be provisioned. */
provisionAfterExtensions?: string[];
/** Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false. */
suppressFailures?: boolean;
/** The extensions protected settings that are passed by reference, and consumed from key vault */
protectedSettingsFromKeyVault?: KeyVaultSecretReference;
}
/** Describes a VMSS VM Extension. */
export interface VirtualMachineScaleSetVMExtension extends SubResourceReadOnly {
/** The location of the extension. */
location?: string;
/**
* Resource type
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly type?: string;
/**
* Resource name
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly name?: string;
/** How the extension handler should be forced to update even if the extension configuration has not changed. */
forceUpdateTag?: string;
/** The name of the extension handler publisher. */
publisher?: string;
/** Specifies the type of the extension; an example is "CustomScriptExtension". */
typePropertiesType?: string;
/** Specifies the version of the script handler. */
typeHandlerVersion?: string;
/** Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. */
autoUpgradeMinorVersion?: boolean;
/** Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. */
enableAutomaticUpgrade?: boolean;
/** Json formatted public settings for the extension. */
settings?: any;
/** The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. */
protectedSettings?: any;
/**
* The provisioning state, which only appears in the response.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly provisioningState?: string;
/** The virtual machine extension instance view. */
instanceView?: VirtualMachineExtensionInstanceView;
/** Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false. */
suppressFailures?: boolean;
/** The extensions protected settings that are passed by reference, and consumed from key vault */
protectedSettingsFromKeyVault?: KeyVaultSecretReference;
/** Collection of extension names after which this extension needs to be provisioned. */
provisionAfterExtensions?: string[];
}
/** Describes a VMSS VM Extension. */
export interface VirtualMachineScaleSetVMExtensionUpdate extends SubResourceReadOnly {
/**
* The name of the extension.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly name?: string;
/**
* Resource type
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly type?: string;
/** How the extension handler should be forced to update even if the extension configuration has not changed. */
forceUpdateTag?: string;
/** The name of the extension handler publisher. */
publisher?: string;
/** Specifies the type of the extension; an example is "CustomScriptExtension". */
typePropertiesType?: string;
/** Specifies the version of the script handler. */
typeHandlerVersion?: string;
/** Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. */
autoUpgradeMinorVersion?: boolean;
/** Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. */
enableAutomaticUpgrade?: boolean;
/** Json formatted public settings for the extension. */
settings?: any;
/** The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. */
protectedSettings?: any;
/** Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false. */
suppressFailures?: boolean;
/** The extensions protected settings that are passed by reference, and consumed from key vault */
protectedSettingsFromKeyVault?: KeyVaultSecretReference;
}
/** The instance view of a capacity reservation that includes the name of the capacity reservation. It is used for the response to the instance view of a capacity reservation group. */
export interface CapacityReservationInstanceViewWithName extends CapacityReservationInstanceView {
/**
* The name of the capacity reservation.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly name?: string;
}
/** The instance view of a dedicated host that includes the name of the dedicated host. It is used for the response to the instance view of a dedicated host group. */
export interface DedicatedHostInstanceViewWithName extends DedicatedHostInstanceView {
/**
* The name of the dedicated host.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly name?: string;
}
/** Describes an Operating System disk. */
export interface ImageOSDisk extends ImageDisk {
/** This property allows you to specify the type of the OS that is included in the disk if creating a VM from a custom image. Possible values are: **Windows,** **Linux.** */
osType: OperatingSystemTypes;
/** The OS State. For managed images, use Generalized. */
osState: OperatingSystemStateTypes;
}
/** Describes a data disk. */
export interface ImageDataDisk extends ImageDisk {
/** Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM. */
lun: number;
}
/** Api request input for LogAnalytics getRequestRateByInterval Api. */
export interface RequestRateByIntervalInput extends LogAnalyticsInputBase {
/** Interval value in minutes used to create LogAnalytics call rate logs. */
intervalLength: IntervalInMins;
}
/** Api request input for LogAnalytics getThrottledRequests Api. */
export interface ThrottledRequestsInput extends LogAnalyticsInputBase {
}
/** Describes the properties of a Run Command. */
export interface RunCommandDocument extends RunCommandDocumentBase {
/** The script to be executed. */
script: string[];
/** The parameters used by the script. */
parameters?: RunCommandParameterDefinition[];
}
/** Specifies information about the availability set that the virtual machine should be assigned to. Only tags may be updated. */
export interface AvailabilitySetUpdate extends UpdateResource {
/** Sku of the availability set */
sku?: Sku;
/** Update Domain count. */
platformUpdateDomainCount?: number;
/** Fault Domain count. */
platformFaultDomainCount?: number;
/** A list of references to all virtual machines in the availability set. */
virtualMachines?: SubResource[];
/** Specifies information about the proximity placement group that the availability set should be assigned to. Minimum api-version: 2018-04-01. */
proximityPlacementGroup?: SubResource;
/**
* The resource status information.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly statuses?: InstanceViewStatus[];
/** Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations for the availability set. */
scheduledEventsPolicy?: ScheduledEventsPolicy;
/**
* Describes the migration properties on the Availability Set.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly virtualMachineScaleSetMigrationInfo?: VirtualMachineScaleSetMigrationInfo;
}
/** Specifies information about the capacity reservation group. Only tags can be updated. */
export interface CapacityReservationGroupUpdate extends UpdateResource {
/**
* A list of all capacity reservation resource ids that belong to capacity reservation group.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly capacityReservations?: SubResourceReadOnly[];
/**
* A list of references to all virtual machines associated to the capacity reservation group.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly virtualMachinesAssociated?: SubResourceReadOnly[];
/**
* The capacity reservation group instance view which has the list of instance views for all the capacity reservations that belong to the capacity reservation group.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly instanceView?: CapacityReservationGroupInstanceView;
/** Specifies the settings to enable sharing across subscriptions for the capacity reservation group resource. The capacity reservation group resource can generally be shared across subscriptions belonging to a single Azure AAD tenant or across AAD tenants if there is a trust relationship established between the tenants. Block capacity reservation does not support sharing across subscriptions. **Note:** Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details. */
sharingProfile?: ResourceSharingProfile;
/** Indicates the type of capacity reservation. Allowed values are 'Block' for block capacity reservations and 'Targeted' for reservations that enable a VM to consume a specific capacity reservation when a capacity reservation group is provided. The reservation type is immutable and cannot be changed after it is assigned. */
reservationType?: ReservationType;
}
/** Specifies information about the capacity reservation. sku.capacity cannot be updated for Block Capacity Reservation. Tags can be update for all Capacity Reservation Types. */
export interface CapacityReservationUpdate extends UpdateResource {
/** SKU of the resource for which capacity needs be reserved. The SKU name and capacity is required to be set. Currently VM Skus with the capability called 'CapacityReservationSupported' set to true are supported. When 'CapacityReservationSupported' is true, the SKU capability also specifies the 'SupportedCapacityReservationTypes', which lists the types of capacity reservations (such as Targeted or Block) that the SKU supports. Refer to List Microsoft.Compute SKUs in a region (https://docs.microsoft.com/rest/api/compute/resourceskus/list) for supported values. **Note:** The SKU name and capacity cannot be updated for Block capacity reservations. */
sku?: Sku;
/**
* A unique id generated and assigned to the capacity reservation by the platform which does not change throughout the lifetime of the resource.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly reservationId?: string;
/**
* Specifies the value of fault domain count that Capacity Reservation supports for requested VM size. **Note:** The fault domain count specified for a resource (like virtual machines scale set) must be less than or equal to this value if it deploys using capacity reservation. Minimum api-version: 2022-08-01.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly platformFaultDomainCount?: number;
/**
* A list of all virtual machine resource ids that are associated with the capacity reservation.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly virtualMachinesAssociated?: SubResourceReadOnly[];
/**
* The date time when the capacity reservation was last updated.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly provisioningTime?: Date;
/**
* The provisioning state, which only appears in the response.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly provisioningState?: string;
/**
* The Capacity reservation instance view.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly instanceView?: CapacityReservationInstanceView;
/**
* Specifies the time at which the Capacity Reservation resource was created. Minimum api-version: 2021-11-01.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly timeCreated?: Date;
/** Defines the schedule for Block-type capacity reservations. Specifies the schedule during which capacity reservation is active and VM or VMSS resource can be allocated using reservation. This property is required and only supported when the capacity reservation group type is 'Block'. The scheduleProfile, start, and end fields are immutable after creation. Minimum API version: 2025-04-01. Please refer to https://aka.ms/blockcapacityreservation for more details. */
scheduleProfile?: ScheduleProfile;
}
/** Specifies information about the dedicated host group that the dedicated host should be assigned to. Only tags may be updated. */
export interface DedicatedHostGroupUpdate extends UpdateResource {
/** Availability Zone to use for this host group. Only single zone is supported. The zone can be assigned only during creation. If not provided, the group supports all zones in the region. If provided, enforces each host in the group to be in the same zone. */
zones?: string[];
/** Number of fault domains that the host group can span. */
platformFaultDomainCount?: number;
/**
* A list of references to all dedicated hosts in the dedicated host group.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly hosts?: SubResourceReadOnly[];
/**
* The dedicated host group instance view, which has the list of instance view of the dedicated hosts under the dedicated host group.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly instanceView?: DedicatedHostGroupInstanceView;
/** Specifies whether virtual machines or virtual machine scale sets can be placed automatically on the dedicated host group. Automatic placement means resources are allocated on dedicated hosts, that are chosen by Azure, under the dedicated host group. The value is defaulted to 'false' when not provided. Minimum api-version: 2020-06-01. */
supportAutomaticPlacement?: boolean;
/** Enables or disables a capability on the dedicated host group. Minimum api-version: 2022-03-01. */
additionalCapabilities?: DedicatedHostGroupPropertiesAdditionalCapabilities;
}
/** Specifies information about the dedicated host. Only tags, autoReplaceOnFailure and licenseType may be updated. */
export interface DedicatedHostUpdate extends UpdateResource {
/** [List all available dedicated host sizes for resizing] (https://docs.microsoft.com/rest/api/compute/dedicated-hosts/listavailablesizes). Resizing can be only used to scale up DedicatedHost. Only name is required to be set. */
sku?: Sku;
/** Fault domain of the dedicated host within a dedicated host group. */
platformFaultDomain?: number;
/** Specifies whether the dedicated host should be replaced automatically in case of a failure. The value is defaulted to 'true' when not provided. */
autoReplaceOnFailure?: boolean;
/**
* A unique id generated and assigned to the dedicated host by the platform. Does not change throughout the lifetime of the host.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly hostId?: string;
/**
* A list of references to all virtual machines in the Dedicated Host.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly virtualMachines?: SubResourceReadOnly[];
/** Specifies the software license type that will be applied to the VMs deployed on the dedicated host. Possible values are: **None,** **Windows_Server_Hybrid,** **Windows_Server_Perpetual.** The default value is: **None.** */
licenseType?: DedicatedHostLicenseTypes;
/**
* The date when the host was first provisioned.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly provisioningTime?: Date;
/**
* The provisioning state, which only appears in the response.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly provisioningState?: string;
/**
* The dedicated host instance view.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly instanceView?: DedicatedHostInstanceView;
/**
* Specifies the time at which the Dedicated Host resource was created. Minimum api-version: 2021-11-01.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly timeCreated?: Date;
}
/** The source user image virtual hard disk. Only tags may be updated. */
export interface ImageUpdate extends UpdateResource {
/** The source virtual machine from which Image is created. */
sourceVirtualMachine?: SubResource;
/** Specifies the storage settings for the virtual machine disks. */
storageProfile?: ImageStorageProfile;
/**
* The provisioning state.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly provisioningState?: string;
/** Specifies the HyperVGenerationType of the VirtualMachine created from the image. From API Version 2019-03-01 if the image source is a blob, then we need the user to specify the value, if the source is managed resource like disk or snapshot, we may require the user to specify the property if we cannot deduce it from the source managed resource. */
hyperVGeneration?: HyperVGenerationTypes;
}
/** Specifies information about the proximity placement group. */
export interface ProximityPlacementGroupUpdate extends UpdateResource {
}
/** Update Restore Point collection parameters. */
export interface RestorePointCollectionUpdate extends UpdateResource {
/** The properties of the source resource that this restore point collection is created from. */
source?: RestorePointCollectionSourceProperties;
/**
* The provisioning state of the restore point collection.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly provisioningState?: string;
/**
* The unique id of the restore point collection.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly restorePointCollectionId?: string;
/**
* A list containing all restore points created under this restore point collection.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly restorePoints?: RestorePoint[];
/** This property determines whether instant access snapshot is enabled for restore points created under this restore point collection for Premium SSD v2 or Ultra disk. Instant access snapshot for Premium SSD v2 or Ultra disk is instantaneously available for restoring disk with fast restore performance. */
instantAccess?: boolean;
}
/** Specifies information about the SSH public key. */
export interface SshPublicKeyUpdateResource extends UpdateResource {
/** SSH public key used to authenticate to a virtual machine through ssh. If this property is not initially provided when the resource is created, the publicKey property will be populated when generateKeyPair is called. If the public key is provided upon resource creation, the provided public key needs to be at least 2048-bit and in ssh-rsa format. */
publicKey?: string;
}
/** Describes a Virtual Machine Scale Set. */
export interface VirtualMachineScaleSetUpdate extends UpdateResource {
/** The virtual machine scale set sku. */
sku?: Sku;
/** The purchase plan when deploying a virtual machine scale set from VM Marketplace images. */
plan?: Plan;
/** The identity of the virtual machine scale set, if configured. */
identity?: VirtualMachineScaleSetIdentity;
/** The virtual machine scale set zones. */
zones?: string[];
/** The upgrade policy. */
upgradePolicy?: UpgradePolicy;
/** Policy for automatic repairs. */
automaticRepairsPolicy?: AutomaticRepairsPolicy;
/** The virtual machine profile. */
virtualMachineProfile?: VirtualMachineScaleSetUpdateVMProfile;
/** Specifies whether the Virtual Machine Scale Set should be overprovisioned. */
overprovision?: boolean;
/** When Overprovision is enabled, extensions are launched only on the requested number of VMs which are finally kept. This property will hence ensure that the extensions do not run on the extra overprovisioned VMs. */
doNotRunExtensionsOnOverprovisionedVMs?: boolean;
/** When true this limits the scale set to a single placement group, of max size 100 virtual machines. NOTE: If singlePlacementGroup is true, it may be modified to false. However, if singlePlacementGroup is false, it may not be modified to true. */
singlePlacementGroup?: boolean;
/** Specifies additional capabilities enabled or disabled on the Virtual Machines in the Virtual Machine Scale Set. For instance: whether the Virtual Machines have the capability to support attaching managed data disks with UltraSSD_LRS storage account type. */
additionalCapabilities?: AdditionalCapabilities;
/** Specifies the policies applied when scaling in Virtual Machines in the Virtual Machine Scale Set. */
scaleInPolicy?: ScaleInPolicy;
/** Specifies information about the proximity placement group that the virtual machine scale set should be assigned to. Minimum api-version: 2018-04-01. */
proximityPlacementGroup?: SubResource;
/** Specifies the desired targets for mixing Spot and Regular priority VMs within the same VMSS Flex instance. */
priorityMixPolicy?: PriorityMixPolicy;
/** Specifies the Spot Restore properties for the virtual machine scale set. */
spotRestorePolicy?: SpotRestorePolicy;
/** Policy for Resiliency */
resiliencyPolicy?: ResiliencyPolicy;
/** Specifies the align mode between Virtual Machine Scale Set compute and storage Fault Domain count. */
zonalPlatformFaultDomainAlignMode?: ZonalPlatformFaultDomainAlignMode;
/** Specifies the sku profile for the virtual machine scale set. */
skuProfile?: SkuProfile;
}
/** Describes a Virtual Machine run command. */
export interface VirtualMachineRunCommandUpdate extends UpdateResource {
/** The source of the run command script. */
source?: VirtualMachineRunCommandScriptSource;
/** The parameters used by the script. */
parameters?: RunCommandInputParameter[];
/** The parameters used by the script. */
protectedParameters?: RunCommandInputParameter[];
/** Optional. If set to true, provisioning will complete as soon as the script starts and will not wait for script to complete. */
asyncExecution?: boolean;
/** Specifies the user account on the VM when executing the run command. */
runAsUser?: string;
/** Specifies the user account password on the VM when executing the run command. */
runAsPassword?: string;
/** The timeout in seconds to execute the run command. */
timeoutInSeconds?: number;
/** Specifies the Azure storage blob where script output stream will be uploaded. Use a SAS URI with read, append, create, write access OR use managed identity to provide the VM access to the blob. Refer outputBlobManagedIdentity parameter. */
outputBlobUri?: string;
/** Specifies the Azure storage blob where script error stream will be uploaded. Use a SAS URI with read, append, create, write access OR use managed identity to provide the VM access to the blob. Refer errorBlobManagedIdentity parameter. */
errorBlobUri?: string;
/** User-assigned managed identity that has access to outputBlobUri storage blob. Use an empty object in case of system-assigned identity. Make sure managed identity has been given access to blob's container with 'Storage Blob Data Contributor' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged */
outputBlobManagedIdentity?: RunCommandManagedIdentity;
/** User-assigned managed identity that has access to errorBlobUri storage blob. Use an empty object in case of system-assigned identity. Make sure managed identity has been given access to blob's container with 'Storage Blob Data Contributor' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged */
errorBlobManagedIdentity?: RunCommandManagedIdentity;
/**
* The provisioning state, which only appears in the response. If treatFailureAsDeploymentFailure set to true, any failure in the script will fail the deployment and ProvisioningState will be marked as Failed. If treatFailureAsDeploymentFailure set to false, ProvisioningState would only reflect whether the run command was run or not by the extensions platform, it would not indicate whether script failed in case of script failures. See instance view of run command in case of script failures to see executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly provisioningState?: string;
/**
* The virtual machine run command instance view.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly instanceView?: VirtualMachineRunCommandInstanceView;
/** Optional. If set to true, any failure in the script will fail the deployment and ProvisioningState will be marked as Failed. If set to false, ProvisioningState would only reflect whether the run command was run or not by the extensions platform, it would not indicate whether script failed in case of script failures. See instance view of run command in case of script failures to see executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results */
treatFailureAsDeploymentFailure?: boolean;
}
/** Describes a Virtual Machine Update. */
export interface VirtualMachineUpdate extends UpdateResource {
/** Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**. */
plan?: Plan;
/** The identity of the virtual machine, if configured. */
identity?: VirtualMachineIdentity;
/** The virtual machine zones. */
zones?: string[];
/** Specifies the hardware settings for the virtual machine. */
hardwareProfile?: HardwareProfile;
/** Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations for the virtual machine. */
scheduledEventsPolicy?: ScheduledEventsPolicy;
/** Specifies the storage settings for the virtual machine disks. */
storageProfile?: StorageProfile;
/** Specifies additional capabilities enabled or disabled on the virtual machine. */
additionalCapabilities?: AdditionalCapabilities;
/** Specifies the operating system settings used while creating the virtual machine. Some of the settings cannot be changed once VM is provisioned. */
osProfile?: OSProfile;
/** Specifies the network interfaces of the virtual machine. */
networkProfile?: NetworkProfile;
/** Specifies the Security related profile settings for the virtual machine. */
securityProfile?: SecurityProfile;
/** Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15. */
diagnosticsProfile?: DiagnosticsProfile;
/** Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Availability sets overview](https://docs.microsoft.com/azure/virtual-machines/availability-set-overview). For more information on Azure planned maintenance, see [Maintenance and updates for Virtual Machines in Azure](https://docs.microsoft.com/azure/virtual-machines/maintenance-and-updates). Currently, a VM can only be added to availability set at creation time. The availability set to which the VM is being added should be under the same resource group as the availability set resource. An existing VM cannot be added to an availability set. This property cannot exist along with a non-null properties.virtualMachineScaleSet reference. */
availabilitySet?: SubResource;
/** Specifies information about the virtual machine scale set that the virtual machine should be assigned to. Virtual machines specified in the same virtual machine scale set are allocated to different nodes to maximize availability. Currently, a VM can only be added to virtual machine scale set at creation time. An existing VM cannot be added to a virtual machine scale set. This property cannot exist along with a non-null properties.availabilitySet reference. Minimum api‐version: 2019‐03‐01. */
virtualMachineScaleSet?: SubResource;
/** Specifies information about the proximity placement group that the virtual machine should be assigned to. Minimum api-version: 2018-04-01. */
proximityPlacementGroup?: SubResource;
/** Specifies the priority for the virtual machine. Minimum api-version: 2019-03-01 */
priority?: VirtualMachinePriorityTypes;
/** Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set. For Azure Spot virtual machines, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2019-03-01. For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview. */
evictionPolicy?: VirtualMachineEvictionPolicyTypes;
/** Specifies the billing related details of a Azure Spot virtual machine. Minimum api-version: 2019-03-01. */
billingProfile?: BillingProfile;
/** Specifies information about the dedicated host that the virtual machine resides in. Minimum api-version: 2018-10-01. */
host?: SubResource;
/** Specifies information about the dedicated host group that the virtual machine resides in. **Note:** User cannot specify both host and hostGroup properties. Minimum api-version: 2020-06-01. */
hostGroup?: SubResource;
/**
* The provisioning state, which only appears in the response.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly provisioningState?: string;
/**
* The virtual machine instance view.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly instanceView?: VirtualMachineInstanceView;
/** Specifies that the image or disk that is being used was licensed on-premises. Possible values for Windows Server operating system are: Windows_Client Windows_Server Possible values for Linux Server operating system are: RHEL_BYOS (for RHEL) SLES_BYOS (for SUSE) For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing) [Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux) Minimum api-version: 2015-06-15 */
licenseType?: string;
/**
* Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly vmId?: string;
/** Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M). Minimum api-version: 2020-06-01. */
extensionsTimeBudget?: string;
/** Specifies the scale set logical fault domain into which the Virtual Machine will be created. By default, the Virtual Machine will by automatically assigned to a fault domain that best maintains balance across available fault domains. This is applicable only if the 'virtualMachineScaleSet' property of this Virtual Machine is set. The Virtual Machine Scale Set that is referenced, must have 'platformFaultDomainCount' greater than 1. This property cannot be updated once the Virtual Machine is created. Fault domain assignment can be viewed in the Virtual Machine Instance View. Minimum api‐version: 2020‐12‐01. */
platformFaultDomain?: number;
/** Specifies Scheduled Event related configurations. */
scheduledEventsProfile?: ScheduledEventsProfile;
/** UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01. */
userData?: string;
/** Specifies information about the capacity reservation that is used to allocate virtual machine. Minimum api-version: 2021-04-01. */
capacityReservation?: CapacityReservationProfile;
/** Specifies the gallery applications that should be made available to the VM/VMSS. */
applicationProfile?: ApplicationProfile;
/**
* Specifies the time at which the Virtual Machine resource was created. Minimum api-version: 2021-11-01.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly timeCreated?: Date;
}
/** Describes a Virtual Machine Extension. */
export interface VirtualMachineExtensionUpdate extends UpdateResource {
/** How the extension handler should be forced to update even if the extension configuration has not changed. */
forceUpdateTag?: string;
/** The name of the extension handler publisher. */
publisher?: string;
/** Specifies the type of the extension; an example is "CustomScriptExtension". */
type?: string;
/** Specifies the version of the script handler. */
typeHandlerVersion?: string;
/** Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. */
autoUpgradeMinorVersion?: boolean;
/** Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. */
enableAutomaticUpgrade?: boolean;
/** Json formatted public settings for the extension. */
settings?: any;
/** The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. */
protectedSettings?: any;
/** Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false. */
suppressFailures?: boolean;
/** The extensions protected settings that are passed by reference, and consumed from key vault */
protectedSettingsFromKeyVault?: KeyVaultSecretReference;
}
/** Describes a Virtual Machine Scale Set VM Reimage Parameters. */
export interface VirtualMachineScaleSetVMReimageParameters extends VirtualMachineReimageParameters {
/** Parameter to force update ephemeral OS disk for a virtual machine scale set VM */
forceUpdateOSDiskForEphemeral?: boolean;
}
/** Specifies information about the Community Gallery that you want to create or update. */
export interface CommunityGallery extends PirCommunityGalleryResource {
/** The disclaimer for a community gallery resource. */
disclaimer?: string;
/** The artifact tags of a community gallery resource. */
artifactTags?: {
[propertyName: string]: string;
};
/** The metadata of community gallery. */
communityMetadata?: CommunityGalleryMetadata;
}
/** Specifies information about the gallery image definition that you want to create or update. */
export interface CommunityGalleryImage extends PirCommunityGalleryResource {
/** This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image. Possible values are: **Windows,** **Linux.** */
osType?: OperatingSystemTypes;
/** This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'. */
osState?: OperatingSystemStateTypes;
/** The end of life date of the gallery image definition. This property can be used for decommissioning purposes. This property is updatable. */
endOfLifeDate?: Date;
/** This is the community gallery image definition identifier. */
identifier?: CommunityGalleryImageIdentifier;
/** The properties describe the recommended machine configuration for this Image Definition. These properties are updatable. */
recommended?: RecommendedMachineConfiguration;
/** Describes the disallowed disk types. */
disallowed?: Disallowed;
/** The hypervisor generation of the Virtual Machine. Applicable to OS disks only. */
hyperVGeneration?: HyperVGeneration;
/** A list of gallery image features. */
features?: GalleryImageFeature[];
/** Describes the gallery image definition purchase plan. This is used by marketplace images. */
purchasePlan?: ImagePurchasePlan;
/** The architecture of the image. Applicable to OS disks only. */
architecture?: Architecture;
/** Privacy statement URI for the current community gallery image. */
privacyStatementUri?: string;
/** The end-user license agreement for the current community gallery image. */
eula?: string;
/** The disclaimer for a community gallery resource. */
disclaimer?: string;
/** The artifact tags of a community gallery resource. */
artifactTags?: {
[propertyName: string]: string;
};
}
/** Specifies information about the gallery image version that you want to create or update. */
export interface CommunityGalleryImageVersion extends PirCommunityGalleryResource {
/** The published date of the gallery image version Definition. This property can be used for decommissioning purposes. This property is updatable. */
publishedDate?: Date;
/** The end of life date of the gallery image version Definition. This property can be used for decommissioning purposes. This property is updatable. */
endOfLifeDate?: Date;
/** If set to true, Virtual Machines deployed from the latest version of the Image Definition won't use this Image Version. */
excludeFromLatest?: boolean;
/** Describes the storage profile of the image version. */
storageProfile?: SharedGalleryImageVersionStorageProfile;
/** The disclaimer for a community gallery resource. */
disclaimer?: string;
/** The artifact tags of a community gallery resource. */
artifactTags?: {
[propertyName: string]: string;
};
}
/** This is the OS disk image. */
export interface SharedGalleryOSDiskImage extends SharedGalleryDiskImage {
}
/** This is the data disk image. */
export interface SharedGalleryDataDiskImage extends SharedGalleryDiskImage {
/** This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine. */
lun: number;
}
/** Base information about the shared gallery resource in pir. */
export interface PirSharedGalleryResource extends PirResource {
/** The unique id of this shared gallery. */
uniqueId?: string;
}
/** Specifies information about the Shared Image Gallery that you want to update. */
export interface GalleryUpdate extends UpdateResourceDefinition {
/** The identity of the gallery, if configured. */
identity?: GalleryIdentity;
/** The description of this Shared Image Gallery resource. This property is updatable. */
description?: string;
/** Describes the gallery unique name. */
identifier?: GalleryIdentifier;
/**
* The provisioning state, which only appears in the response.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly provisioningState?: GalleryProvisioningState;
/** Profile for gallery sharing to subscription or tenant */
sharingProfile?: SharingProfile;
/** Contains information about the soft deletion policy of the gallery. */
softDeletePolicy?: SoftDeletePolicy;
/**
* Sharing status of current gallery.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly sharingStatus?: SharingStatus;
}
/** Specifies information about the gallery Application Definition that you want to update. */
export interface GalleryApplicationUpdate extends UpdateResourceDefinition {
/** The description of this gallery Application Definition resource. This property is updatable. */
description?: string;
/** The Eula agreement for the gallery Application Definition. */
eula?: string;
/** The privacy statement uri. */
privacyStatementUri?: string;
/** The release note uri. */
releaseNoteUri?: string;
/** The end of life date of the gallery Application Definition. This property can be used for decommissioning purposes. This property is updatable. */
endOfLifeDate?: Date;
/** This property allows you to specify the supported type of the OS that application is built for. Possible values are: **Windows,** **Linux.** */
supportedOSType?: OperatingSystemTypes;
/** A list of custom actions that can be performed with all of the Gallery Application Versions within this Gallery Application. */
customActions?: GalleryApplicationCustomAction[];
}
/** Specifies information about the gallery Application Version that you want to update. */
export interface GalleryApplicationVersionUpdate extends UpdateResourceDefinition {
/** The publishing profile of a gallery image version. */
publishingProfile?: GalleryApplicationVersionPublishingProfile;
/** The safety profile of the Gallery Application Version. */
safetyProfile?: GalleryApplicationVersionSafetyProfile;
/**
* The provisioning state, which only appears in the response.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly provisioningState?: GalleryProvisioningState;
/**
* This is the replication status of the gallery image version.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly replicationStatus?: ReplicationStatus;
}
/** Specifies information about the gallery image definition that you want to update. */
export interface GalleryImageUpdate extends UpdateResourceDefinition {
/** The description of this gallery image definition resource. This property is updatable. */
description?: string;
/** The Eula agreement for the gallery image definition. */
eula?: string;
/** The privacy statement uri. */
privacyStatementUri?: string;
/** The release note uri. */
releaseNoteUri?: string;
/** This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image. Possible values are: **Windows,** **Linux.** */
osType?: OperatingSystemTypes;
/** This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'. */
osState?: OperatingSystemStateTypes;
/** The hypervisor generation of the Virtual Machine. Applicable to OS disks only. */
hyperVGeneration?: HyperVGeneration;
/** The end of life date of the gallery image definition. This property can be used for decommissioning purposes. This property is updatable. */
endOfLifeDate?: Date;
/** This is the gallery image definition identifier. */
identifier?: GalleryImageIdentifier;
/** The properties describe the recommended machine configuration for this Image Definition. These properties are updatable. */
recommended?: RecommendedMachineConfiguration;
/** Describes the disallowed disk types. */
disallowed?: Disallowed;
/** Describes the gallery image definition purchase plan. This is used by marketplace images. */
purchasePlan?: ImagePurchasePlan;
/**
* The provisioning state, which only appears in the response.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly provisioningState?: GalleryProvisioningState;
/** A list of gallery image features. */
features?: GalleryImageFeature[];
/** The architecture of the image. Applicable to OS disks only. */
architecture?: Architecture;
/** Optional. Must be set to true if the gallery image features are being updated. */
allowUpdateImage?: boolean;
}
/** Specifies information about the gallery image version that you want to update. */
export interface GalleryImageVersionUpdate extends UpdateResourceDefinition {
/** The publishing profile of a gallery image Version. */
publishingProfile?: GalleryImageVersionPublishingProfile;
/**
* The provisioning state, which only appears in the response.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly provisioningState?: GalleryProvisioningState;
/** This is the storage profile of a Gallery Image Version. */
storageProfile?: GalleryImageVersionStorageProfile;
/** This is the safety profile of the Gallery Image Version. */
safetyProfile?: GalleryImageVersionSafetyProfile;
/**
* This is the replication status of the gallery image version.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly replicationStatus?: ReplicationStatus;
/** The security profile of a gallery image version */
securityProfile?: ImageVersionSecurityProfile;
/** Indicates if this is a soft-delete resource restoration request. */
restore?: boolean;
/**
* This is the validations profile of a Gallery Image Version.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly validationsProfile?: ValidationsProfile;
}
/** Specifies information about the gallery inVMAccessControlProfile that you want to update. */
export interface GalleryInVMAccessControlProfileUpdate extends UpdateResourceDefinition {
/** Describes the properties of a gallery inVMAccessControlProfile. */
properties?: GalleryInVMAccessControlProfileProperties;
}
/** Specifies information about the gallery inVMAccessControlProfile version that you want to update. */
export interface GalleryInVMAccessControlProfileVersionUpdate extends UpdateResourceDefinition {
/** The target regions where the Resource Profile version is going to be replicated to. This property is updatable. */
targetLocations?: TargetRegion[];
/** If set to true, Virtual Machines deployed from the latest version of the Resource Profile won't use this Profile version. */
excludeFromLatest?: boolean;
/**
* The timestamp for when the Resource Profile Version is published.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly publishedDate?: Date;
/**
* The provisioning state, which only appears in the response.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly provisioningState?: GalleryProvisioningState;
/**
* This is the replication status of the gallery image version.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly replicationStatus?: ReplicationStatus;
/** This property allows you to specify whether the access control rules are in Audit mode, in Enforce mode or Disabled. Possible values are: 'Audit', 'Enforce' or 'Disabled'. */
mode?: AccessControlRulesMode;
/** This property allows you to specify if the requests will be allowed to access the host endpoints. Possible values are: 'Allow', 'Deny'. */
defaultAccess?: EndpointAccess;
/** This is the Access Control Rules specification for an inVMAccessControlProfile version. */
rules?: AccessControlRules;
}
/** The publishing profile of a gallery image version. */
export interface GalleryApplicationVersionPublishingProfile extends GalleryArtifactPublishingProfileBase {
/** The source image from which the Image Version is going to be created. */
source: UserArtifactSource;
manageActions?: UserArtifactManage;
/** Additional settings for the VM app that contains the target package and config file name when it is deployed to target VM or VM scale set. */
settings?: UserArtifactSettings;
/** Optional. Additional settings to pass to the vm-application-manager extension. For advanced use only. */
advancedSettings?: {
[propertyName: string]: string;
};
/** Optional. Whether or not this application reports health. */
enableHealthCheck?: boolean;
/** A list of custom actions that can be performed with this Gallery Application Version. */
customActions?: GalleryApplicationCustomAction[];
}
/** The publishing profile of a gallery image Version. */
export interface GalleryImageVersionPublishingProfile extends GalleryArtifactPublishingProfileBase {
}
/** Contains encryption settings for an OS disk image. */
export interface OSDiskImageEncryption extends DiskImageEncryption {
/** This property specifies the security profile of an OS disk image. */
securityProfile?: OSDiskImageSecurityProfile;
}
/** Contains encryption settings for a data disk image. */
export interface DataDiskImageEncryption extends DiskImageEncryption {
/** This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine. */
lun: number;
}
/** The safety profile of the Gallery Application Version. */
export interface GalleryApplicationVersionSafetyProfile extends GalleryArtifactSafetyProfileBase {
}
/** This is the safety profile of the Gallery Image Version. */
export interface GalleryImageVersionSafetyProfile extends GalleryArtifactSafetyProfileBase {
/**
* Indicates whether this image has been reported as violating Microsoft's policies.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly reportedForPolicyViolation?: boolean;
/**
* A list of Policy Violations that have been reported for this Gallery Image Version.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly policyViolations?: PolicyViolation[];
/** Indicates whether or not the deletion is blocked for this Gallery Image Version if its End Of Life has not expired. */
blockDeletionBeforeEndOfLife?: boolean;
}
/** The source of the gallery artifact version. */
export interface GalleryArtifactVersionFullSource extends GalleryArtifactVersionSource {
/** The resource Id of the source Community Gallery Image. Only required when using Community Gallery Image as a source. */
communityGalleryImageId?: string;
/** The resource Id of the source virtual machine. Only required when capturing a virtual machine to source this Gallery Image Version. */
virtualMachineId?: string;
}
/** The source for the disk image. */
export interface GalleryDiskImageSource extends GalleryArtifactVersionSource {
/** The uri of the gallery artifact version source. Currently used to specify vhd/blob source. */
uri?: string;
/** The Storage Account Id that contains the vhd blob being used as a source for this artifact version. */
storageAccountId?: string;
}
/** This is the OS disk image. */
export interface GalleryOSDiskImage extends GalleryDiskImage {
}
/** This is the data disk image. */
export interface GalleryDataDiskImage extends GalleryDiskImage {
/** This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine. */
lun: number;
}
/** Describes the properties of a gallery inVMAccessControlProfile. */
export interface GalleryInVMAccessControlProfileProperties extends GalleryResourceProfilePropertiesBase {
/** The description of this gallery inVMAccessControlProfile resources. This property is updatable. */
description?: string;
/** This property allows you to specify the OS type of the VMs/VMSS for which this profile can be used against. Possible values are: 'Windows' or 'Linux' */
osType: OperatingSystemTypes;
/** This property allows you to specify the Endpoint type for which this profile is defining the access control for. Possible values are: 'WireServer' or 'IMDS' */
applicableHostEndpoint: EndpointTypes;
}
/** Describes the properties of an inVMAccessControlProfile version. */
export interface GalleryInVMAccessControlProfileVersionProperties extends GalleryResourceProfileVersionPropertiesBase {
/** This property allows you to specify whether the access control rules are in Audit mode, in Enforce mode or Disabled. Possible values are: 'Audit', 'Enforce' or 'Disabled'. */
mode: AccessControlRulesMode;
/** This property allows you to specify if the requests will be allowed to access the host endpoints. Possible values are: 'Allow', 'Deny'. */
defaultAccess: EndpointAccess;
/** This is the Access Control Rules specification for an inVMAccessControlProfile version. */
rules?: AccessControlRules;
}
/** Describes a Virtual Machine Image. */
export interface VirtualMachineImage extends VirtualMachineImageResource {
/** Used for establishing the purchase context of any 3rd Party artifact through MarketPlace. */
plan?: PurchasePlan;
/** Contains the os disk image information. */
osDiskImage?: OSDiskImage;
/** The list of data disk images information. */
dataDiskImages?: DataDiskImage[];
/** Describes automatic OS upgrade properties on the image. */
automaticOSUpgradeProperties?: AutomaticOSUpgradeProperties;
/** Specifies the HyperVGeneration Type */
hyperVGeneration?: HyperVGenerationTypes;
/** Specifies disallowed configuration for the VirtualMachine created from the image */
disallowed?: DisallowedConfiguration;
features?: VirtualMachineImageFeature[];
/** Specifies the Architecture Type */
architecture?: ArchitectureTypes;
/** Describes image deprecation status properties on the image. */
imageDeprecationStatus?: ImageDeprecationStatus;
}
/** Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Availability sets overview](https://docs.microsoft.com/azure/virtual-machines/availability-set-overview). For more information on Azure planned maintenance, see [Maintenance and updates for Virtual Machines in Azure](https://docs.microsoft.com/azure/virtual-machines/maintenance-and-updates). Currently, a VM can only be added to an availability set at creation time. An existing VM cannot be added to an availability set. */
export interface AvailabilitySet extends TrackedResource {
/** Sku of the availability set, only name is required to be set. See AvailabilitySetSkuTypes for possible set of values. Use 'Aligned' for virtual machines with managed disks and 'Classic' for virtual machines with unmanaged disks. Default value is 'Classic'. */
sku?: Sku;
/** Update Domain count. */
platformUpdateDomainCount?: number;
/** Fault Domain count. */
platformFaultDomainCount?: number;
/** A list of references to all virtual machines in the availability set. */
virtualMachines?: SubResource[];
/** Specifies information about the proximity placement group that the availability set should be assigned to. Minimum api-version: 2018-04-01. */
proximityPlacementGroup?: SubResource;
/**
* The resource status information.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly statuses?: InstanceViewStatus[];
/** Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations for the availability set. */
scheduledEventsPolicy?: ScheduledEventsPolicy;
/**
* Describes the migration properties on the Availability Set.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly virtualMachineScaleSetMigrationInfo?: VirtualMachineScaleSetMigrationInfo;
}
/** Specifies information about the capacity reservation group that the capacity reservations should be assigned to. Currently, a capacity reservation can only be added to a capacity reservation group at creation time. An existing capacity reservation cannot be added or moved to another capacity reservation group. */
export interface CapacityReservationGroup extends TrackedResource {
/** The availability zones. */
zones?: string[];
/**
* A list of all capacity reservation resource ids that belong to capacity reservation group.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly capacityReservations?: SubResourceReadOnly[];
/**
* A list of references to all virtual machines associated to the capacity reservation group.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly virtualMachinesAssociated?: SubResourceReadOnly[];
/**
* The capacity reservation group instance view which has the list of instance views for all the capacity reservations that belong to the capacity reservation group.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly instanceView?: CapacityReservationGroupInstanceView;
/** Specifies the settings to enable sharing across subscriptions for the capacity reservation group resource. The capacity reservation group resource can generally be shared across subscriptions belonging to a single Azure AAD tenant or across AAD tenants if there is a trust relationship established between the tenants. Block capacity reservation does not support sharing across subscriptions. **Note:** Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details. */
sharingProfile?: ResourceSharingProfile;
/** Indicates the type of capacity reservation. Allowed values are 'Block' for block capacity reservations and 'Targeted' for reservations that enable a VM to consume a specific capacity reservation when a capacity reservation group is provided. The reservation type is immutable and cannot be changed after it is assigned. */
reservationType?: ReservationType;
}
/** Specifies information about the dedicated host group that the dedicated hosts should be assigned to. Currently, a dedicated host can only be added to a dedicated host group at creation time. An existing dedicated host cannot be added to another dedicated host group. */
export interface DedicatedHostGroup extends TrackedResource {
/** The availability zones. */
zones?: string[];
/** Number of fault domains that the host group can span. */
platformFaultDomainCount?: number;
/**
* A list of references to all dedicated hosts in the dedicated host group.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly hosts?: SubResourceReadOnly[];
/**
* The dedicated host group instance view, which has the list of instance view of the dedicated hosts under the dedicated host group.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly instanceView?: DedicatedHostGroupInstanceView;
/** Specifies whether virtual machines or virtual machine scale sets can be placed automatically on the dedicated host group. Automatic placement means resources are allocated on dedicated hosts, that are chosen by Azure, under the dedicated host group. The value is defaulted to 'false' when not provided. Minimum api-version: 2020-06-01. */
supportAutomaticPlacement?: boolean;
/** Enables or disables a capability on the dedicated host group. Minimum api-version: 2022-03-01. */
additionalCapabilities?: DedicatedHostGroupPropertiesAdditionalCapabilities;
}
/** The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist. */
export interface Image extends TrackedResource {
/** The extended location of the Image. */
extendedLocation?: ExtendedLocation;
/** The source virtual machine from which Image is created. */
sourceVirtualMachine?: SubResource;
/** Specifies the storage settings for the virtual machine disks. */
storageProfile?: ImageStorageProfile;
/**
* The provisioning state.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly provisioningState?: string;
/** Specifies the HyperVGenerationType of the VirtualMachine created from the image. From API Version 2019-03-01 if the image source is a blob, then we need the user to specify the value, if the source is managed resource like disk or snapshot, we may require the user to specify the property if we cannot deduce it from the source managed resource. */
hyperVGeneration?: HyperVGenerationTypes;
}
/** Describes a Virtual Machine Extension Image. */
export interface VirtualMachineExtensionImage extends TrackedResource {
/** The operating system this extension supports. */
operatingSystem?: string;
/** The type of role (IaaS or PaaS) this extension supports. */
computeRole?: string;
/** The schema defined by publisher, where extension consumers should provide settings in a matching schema. */
handlerSchema?: string;
/** Whether the extension can be used on xRP VMScaleSets. By default existing extensions are usable on scalesets, but there might be cases where a publisher wants to explicitly indicate the extension is only enabled for CRP VMs but not VMSS. */
vmScaleSetEnabled?: boolean;
/** Whether the handler can support multiple extensions. */
supportsMultipleExtensions?: boolean;
}
/** Describes a Virtual Machine Scale Set. */
export interface VirtualMachineScaleSet extends TrackedResource {
/** The virtual machine scale set sku. */
sku?: Sku;
/** Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**. */
plan?: Plan;
/** The identity of the virtual machine scale set, if configured. */
identity?: VirtualMachineScaleSetIdentity;
/** The availability zones. */
zones?: string[];
/** The extended location of the Virtual Machine Scale Set. */
extendedLocation?: ExtendedLocation;
/**
* Etag is property returned in Create/Update/Get response of the VMSS, so that customer can supply it in the header to ensure optimistic updates
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly etag?: string;
/** Placement section specifies the user-defined constraints for virtual machine scale set hardware placement. This property cannot be changed once VMSS is provisioned. Minimum api-version: 2025-04-01. */
placement?: Placement;
/** The upgrade policy. */
upgradePolicy?: UpgradePolicy;
/** The ScheduledEventsPolicy. */
scheduledEventsPolicy?: ScheduledEventsPolicy;
/** Policy for automatic repairs. */
automaticRepairsPolicy?: AutomaticRepairsPolicy;
/** The virtual machine profile. */
virtualMachineProfile?: VirtualMachineScaleSetVMProfile;
/**
* The provisioning state, which only appears in the response.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly provisioningState?: string;
/** Specifies whether the Virtual Machine Scale Set should be overprovisioned. */
overprovision?: boolean;
/** When Overprovision is enabled, extensions are launched only on the requested number of VMs which are finally kept. This property will hence ensure that the extensions do not run on the extra overprovisioned VMs. */
doNotRunExtensionsOnOverprovisionedVMs?: boolean;
/**
* Specifies the ID which uniquely identifies a Virtual Machine Scale Set.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly uniqueId?: string;
/** When true this limits the scale set to a single placement group, of max size 100 virtual machines. NOTE: If singlePlacementGroup is true, it may be modified to false. However, if singlePlacementGroup is false, it may not be modified to true. */
singlePlacementGroup?: boolean;
/** Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage. zoneBalance property can only be set if the zones property of the scale set contains more than one zone. If there are no zones or only one zone specified, then zoneBalance property should not be set. */
zoneBalance?: boolean;
/** Fault Domain count for each placement group. */
platformFaultDomainCount?: number;
/** Specifies information about the proximity placement group that the virtual machine scale set should be assigned to. Minimum api-version: 2018-04-01. */
proximityPlacementGroup?: SubResource;
/** Specifies information about the dedicated host group that the virtual machine scale set resides in. Minimum api-version: 2020-06-01. */
hostGroup?: SubResource;
/** Specifies additional capabilities enabled or disabled on the Virtual Machines in the Virtual Machine Scale Set. For instance: whether the Virtual Machines have the capability to support attaching managed data disks with UltraSSD_LRS storage account type. */
additionalCapabilities?: AdditionalCapabilities;
/** Specifies the policies applied when scaling in Virtual Machines in the Virtual Machine Scale Set. */
scaleInPolicy?: ScaleInPolicy;
/** Specifies the orchestration mode for the virtual machine scale set. */
orchestrationMode?: OrchestrationMode;
/** Specifies the Spot Restore properties for the virtual machine scale set. */
spotRestorePolicy?: SpotRestorePolicy;
/** Specifies the desired targets for mixing Spot and Regular priority VMs within the same VMSS Flex instance. */
priorityMixPolicy?: PriorityMixPolicy;
/**
* Specifies the time at which the Virtual Machine Scale Set resource was created. Minimum api-version: 2021-11-01.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly timeCreated?: Date;
/** Optional property which must either be set to True or omitted. */
constrainedMaximumCapacity?: boolean;
/** Policy for Resiliency */
resiliencyPolicy?: ResiliencyPolicy;
/** Specifies the align mode between Virtual Machine Scale Set compute and storage Fault Domain count. */
zonalPlatformFaultDomainAlignMode?: ZonalPlatformFaultDomainAlignMode;
/** Specifies the sku profile for the virtual machine scale set. */
skuProfile?: SkuProfile;
/** Specifies the high speed interconnect placement for the virtual machine scale set. */
highSpeedInterconnectPlacement?: HighSpeedInterconnectPlacement;
}
/** Describes a Virtual Machine Extension. */
export interface VirtualMachineExtension extends TrackedResource {
/** How the extension handler should be forced to update even if the extension configuration has not changed. */
forceUpdateTag?: string;
/** The name of the extension handler publisher. */
publisher?: string;
/** Specifies the type of the extension; an example is "CustomScriptExtension". */
typePropertiesType?: string;
/** Specifies the version of the script handler. */
typeHandlerVersion?: string;
/** Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. */
autoUpgradeMinorVersion?: boolean;
/** Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. */
enableAutomaticUpgrade?: boolean;
/** Json formatted public settings for the extension. */
settings?: any;
/** The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. */
protectedSettings?: any;
/**
* The provisioning state, which only appears in the response.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly provisioningState?: string;
/** The virtual machine extension instance view. */
instanceView?: VirtualMachineExtensionInstanceView;
/** Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false. */
suppressFailures?: boolean;
/** The extensions protected settings that are passed by reference, and consumed from key vault */
protectedSettingsFromKeyVault?: KeyVaultSecretReference;
/** Collection of extension names after which this extension needs to be provisioned. */
provisionAfterExtensions?: string[];
}
/** Describes a Virtual Machine. */
export interface VirtualMachine extends TrackedResource {
/** Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**. */
plan?: Plan;
/**
* The virtual machine child extension resources.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly resources?: VirtualMachineExtension[];
/** The identity of the virtual machine, if configured. */
identity?: VirtualMachineIdentity;
/** The availability zones. */
zones?: string[];
/** The extended location of the Virtual Machine. */
extendedLocation?: ExtendedLocation;
/**
* ManagedBy is set to Virtual Machine Scale Set(VMSS) flex ARM resourceID, if the VM is part of the VMSS. This property is used by platform for internal resource group delete optimization.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly managedBy?: string;
/**
* Etag is property returned in Create/Update/Get response of the VM, so that customer can supply it in the header to ensure optimistic updates.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly etag?: string;
/** Placement section specifies the user-defined constraints for virtual machine hardware placement. This property cannot be changed once VM is provisioned. Minimum api-version: 2024-11-01. */
placement?: Placement;
/** Specifies the hardware settings for the virtual machine. */
hardwareProfile?: HardwareProfile;
/** Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations for the virtual machine. */
scheduledEventsPolicy?: ScheduledEventsPolicy;
/** Specifies the storage settings for the virtual machine disks. */
storageProfile?: StorageProfile;
/** Specifies additional capabilities enabled or disabled on the virtual machine. */
additionalCapabilities?: AdditionalCapabilities;
/** Specifies the operating system settings used while creating the virtual machine. Some of the settings cannot be changed once VM is provisioned. */
osProfile?: OSProfile;
/** Specifies the network interfaces of the virtual machine. */
networkProfile?: NetworkProfile;
/** Specifies the Security related profile settings for the virtual machine. */
securityProfile?: SecurityProfile;
/** Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15. */
diagnosticsProfile?: DiagnosticsProfile;
/** Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Availability sets overview](https://docs.microsoft.com/azure/virtual-machines/availability-set-overview). For more information on Azure planned maintenance, see [Maintenance and updates for Virtual Machines in Azure](https://docs.microsoft.com/azure/virtual-machines/maintenance-and-updates). Currently, a VM can only be added to availability set at creation time. The availability set to which the VM is being added should be under the same resource group as the availability set resource. An existing VM cannot be added to an availability set. This property cannot exist along with a non-null properties.virtualMachineScaleSet reference. */
availabilitySet?: SubResource;
/** Specifies information about the virtual machine scale set that the virtual machine should be assigned to. Virtual machines specified in the same virtual machine scale set are allocated to different nodes to maximize availability. Currently, a VM can only be added to virtual machine scale set at creation time. An existing VM cannot be added to a virtual machine scale set. This property cannot exist along with a non-null properties.availabilitySet reference. Minimum api‐version: 2019‐03‐01. */
virtualMachineScaleSet?: SubResource;
/** Specifies information about the proximity placement group that the virtual machine should be assigned to. Minimum api-version: 2018-04-01. */
proximityPlacementGroup?: SubResource;
/** Specifies the priority for the virtual machine. Minimum api-version: 2019-03-01 */
priority?: VirtualMachinePriorityTypes;
/** Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set. For Azure Spot virtual machines, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2019-03-01. For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview. */
evictionPolicy?: VirtualMachineEvictionPolicyTypes;
/** Specifies the billing related details of a Azure Spot virtual machine. Minimum api-version: 2019-03-01. */
billingProfile?: BillingProfile;
/** Specifies information about the dedicated host that the virtual machine resides in. Minimum api-version: 2018-10-01. */
host?: SubResource;
/** Specifies information about the dedicated host group that the virtual machine resides in. **Note:** User cannot specify both host and hostGroup properties. Minimum api-version: 2020-06-01. */
hostGroup?: SubResource;
/**
* The provisioning state, which only appears in the response.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly provisioningState?: string;
/**
* The virtual machine instance view.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly instanceView?: VirtualMachineInstanceView;
/** Specifies that the image or disk that is being used was licensed on-premises. Possible values for Windows Server operating system are: Windows_Client Windows_Server Possible values for Linux Server operating system are: RHEL_BYOS (for RHEL) SLES_BYOS (for SUSE) For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing) [Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux) Minimum api-version: 2015-06-15 */
licenseType?: string;
/**
* Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly vmId?: string;
/** Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M). Minimum api-version: 2020-06-01. */
extensionsTimeBudget?: string;
/** Specifies the scale set logical fault domain into which the Virtual Machine will be created. By default, the Virtual Machine will by automatically assigned to a fault domain that best maintains balance across available fault domains. This is applicable only if the 'virtualMachineScaleSet' property of this Virtual Machine is set. The Virtual Machine Scale Set that is referenced, must have 'platformFaultDomainCount' greater than 1. This property cannot be updated once the Virtual Machine is created. Fault domain assignment can be viewed in the Virtual Machine Instance View. Minimum api‐version: 2020‐12‐01. */
platformFaultDomain?: number;
/** Specifies Scheduled Event related configurations. */
scheduledEventsProfile?: ScheduledEventsProfile;
/** UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01. */
userData?: string;
/** Specifies information about the capacity reservation that is used to allocate virtual machine. Minimum api-version: 2021-04-01. */
capacityReservation?: CapacityReservationProfile;
/** Specifies the gallery applications that should be made available to the VM/VMSS. */
applicationProfile?: ApplicationProfile;
/**
* Specifies the time at which the Virtual Machine resource was created. Minimum api-version: 2021-11-01.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly timeCreated?: Date;
}
/** Specifies information about the proximity placement group. */
export interface ProximityPlacementGroup extends TrackedResource {
/** The availability zones. */
zones?: string[];
/** Specifies the type of the proximity placement group. Possible values are: **Standard** : Co-locate resources within an Azure region or Availability Zone. **Ultra** : For future use. */
proximityPlacementGroupType?: ProximityPlacementGroupType;
/**
* A list of references to all virtual machines in the proximity placement group.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly virtualMachines?: SubResourceWithColocationStatus[];
/**
* A list of references to all virtual machine scale sets in the proximity placement group.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly virtualMachineScaleSets?: SubResourceWithColocationStatus[];
/**
* A list of references to all availability sets in the proximity placement group.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly availabilitySets?: SubResourceWithColocationStatus[];
/** Describes colocation status of the Proximity Placement Group. */
colocationStatus?: InstanceViewStatus;
/** Specifies the user intent of the proximity placement group. */
intent?: ProximityPlacementGroupPropertiesIntent;
}
/** Create or update Restore Point collection parameters. */
export interface RestorePointCollection extends TrackedResource {
/** The properties of the source resource that this restore point collection is created from. */
source?: RestorePointCollectionSourceProperties;
/**
* The provisioning state of the restore point collection.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly provisioningState?: string;
/**
* The unique id of the restore point collection.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly restorePointCollectionId?: string;
/**
* A list containing all restore points created under this restore point collection.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly restorePoints?: RestorePoint[];
/** This property determines whether instant access snapshot is enabled for restore points created under this restore point collection for Premium SSD v2 or Ultra disk. Instant access snapshot for Premium SSD v2 or Ultra disk is instantaneously available for restoring disk with fast restore performance. */
instantAccess?: boolean;
}
/** Specifies information about the SSH public key. */
export interface SshPublicKeyResource extends TrackedResource {
/** SSH public key used to authenticate to a virtual machine through ssh. If this property is not initially provided when the resource is created, the publicKey property will be populated when generateKeyPair is called. If the public key is provided upon resource creation, the provided public key needs to be at least 2048-bit and in ssh-rsa format. */
publicKey?: string;
}
/** Specifies information about the capacity reservation. */
export interface CapacityReservation extends TrackedResource {
/** SKU of the resource for which capacity needs be reserved. The SKU name and capacity is required to be set. For Block capacity reservations, sku.capacity can only accept values 1, 2, 4, 8, 16, 32, 64. Currently VM Skus with the capability called 'CapacityReservationSupported' set to true are supported. When 'CapacityReservationSupported' is true, the SKU capability also specifies the 'SupportedCapacityReservationTypes', which lists the types of capacity reservations (such as Targeted or Block) that the SKU supports. Refer to List Microsoft.Compute SKUs in a region (https://docs.microsoft.com/rest/api/compute/resourceskus/list) for supported values. */
sku: Sku;
/** The availability zones. */
zones?: string[];
/**
* A unique id generated and assigned to the capacity reservation by the platform which does not change throughout the lifetime of the resource.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly reservationId?: string;
/**
* Specifies the value of fault domain count that Capacity Reservation supports for requested VM size. **Note:** The fault domain count specified for a resource (like virtual machines scale set) must be less than or equal to this value if it deploys using capacity reservation. Minimum api-version: 2022-08-01.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly platformFaultDomainCount?: number;
/**
* A list of all virtual machine resource ids that are associated with the capacity reservation.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly virtualMachinesAssociated?: SubResourceReadOnly[];
/**
* The date time when the capacity reservation was last updated.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly provisioningTime?: Date;
/**
* The provisioning state, which only appears in the response.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly provisioningState?: string;
/**
* The Capacity reservation instance view.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly instanceView?: CapacityReservationInstanceView;
/**
* Specifies the time at which the Capacity Reservation resource was created. Minimum api-version: 2021-11-01.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly timeCreated?: Date;
/** Defines the schedule for Block-type capacity reservations. Specifies the schedule during which capacity reservation is active and VM or VMSS resource can be allocated using reservation. This property is required and only supported when the capacity reservation group type is 'Block'. The scheduleProfile, start, and end fields are immutable after creation. Minimum API version: 2025-04-01. Please refer to https://aka.ms/blockcapacityreservation for more details. */
scheduleProfile?: ScheduleProfile;
}
/** Specifies information about the Dedicated host. */
export interface DedicatedHost extends TrackedResource {
/** SKU of the dedicated host for Hardware Generation and VM family. Only name is required to be set. List Microsoft.Compute SKUs for a list of possible values. */
sku: Sku;
/** Fault domain of the dedicated host within a dedicated host group. */
platformFaultDomain?: number;
/** Specifies whether the dedicated host should be replaced automatically in case of a failure. The value is defaulted to 'true' when not provided. */
autoReplaceOnFailure?: boolean;
/**
* A unique id generated and assigned to the dedicated host by the platform. Does not change throughout the lifetime of the host.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly hostId?: string;
/**
* A list of references to all virtual machines in the Dedicated Host.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly virtualMachines?: SubResourceReadOnly[];
/** Specifies the software license type that will be applied to the VMs deployed on the dedicated host. Possible values are: **None,** **Windows_Server_Hybrid,** **Windows_Server_Perpetual.** The default value is: **None.** */
licenseType?: DedicatedHostLicenseTypes;
/**
* The date when the host was first provisioned.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly provisioningTime?: Date;
/**
* The provisioning state, which only appears in the response.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly provisioningState?: string;
/**
* The dedicated host instance view.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly instanceView?: DedicatedHostInstanceView;
/**
* Specifies the time at which the Dedicated Host resource was created. Minimum api-version: 2021-11-01.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly timeCreated?: Date;
}
/** The status of the latest virtual machine scale set rolling upgrade. */
export interface RollingUpgradeStatusInfo extends TrackedResource {
/**
* The rolling upgrade policies applied for this upgrade.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly policy?: RollingUpgradePolicy;
/**
* Information about the current running state of the overall upgrade.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly runningStatus?: RollingUpgradeRunningStatus;
/**
* Information about the number of virtual machine instances in each upgrade state.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly progress?: RollingUpgradeProgressInfo;
/**
* Error details for this upgrade, if there are any.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly error?: ApiError;
}
/** Describes a virtual machine scale set virtual machine. */
export interface VirtualMachineScaleSetVM extends TrackedResource {
/**
* The virtual machine instance ID.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly instanceId?: string;
/**
* The virtual machine SKU.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly sku?: Sku;
/** Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**. */
plan?: Plan;
/**
* The virtual machine child extension resources.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly resources?: VirtualMachineExtension[];
/**
* The virtual machine zones.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly zones?: string[];
/** The identity of the virtual machine, if configured. */
identity?: VirtualMachineIdentity;
/**
* Etag is property returned in Update/Get response of the VMSS VM, so that customer can supply it in the header to ensure optimistic updates.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly etag?: string;
/**
* Specifies whether the latest model has been applied to the virtual machine.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly latestModelApplied?: boolean;
/**
* Azure VM unique ID.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly vmId?: string;
/**
* The virtual machine instance view.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly instanceView?: VirtualMachineScaleSetVMInstanceView;
/** Specifies the hardware settings for the virtual machine. */
hardwareProfile?: HardwareProfile;
/** Specifies the resilient VM deletion status for the virtual machine. */
resilientVMDeletionStatus?: ResilientVMDeletionStatus;
/** Specifies the storage settings for the virtual machine disks. */
storageProfile?: StorageProfile;
/** Specifies additional capabilities enabled or disabled on the virtual machine in the scale set. For instance: whether the virtual machine has the capability to support attaching managed data disks with UltraSSD_LRS storage account type. */
additionalCapabilities?: AdditionalCapabilities;
/** Specifies the operating system settings for the virtual machine. */
osProfile?: OSProfile;
/** Specifies the Security related profile settings for the virtual machine. */
securityProfile?: SecurityProfile;
/** Specifies the network interfaces of the virtual machine. */
networkProfile?: NetworkProfile;
/** Specifies the network profile configuration of the virtual machine. */
networkProfileConfiguration?: VirtualMachineScaleSetVMNetworkProfileConfiguration;
/** Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15. */
diagnosticsProfile?: DiagnosticsProfile;
/** Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Availability sets overview](https://docs.microsoft.com/azure/virtual-machines/availability-set-overview). For more information on Azure planned maintenance, see [Maintenance and updates for Virtual Machines in Azure](https://docs.microsoft.com/azure/virtual-machines/maintenance-and-updates). Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set. */
availabilitySet?: SubResource;
/**
* The provisioning state, which only appears in the response.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly provisioningState?: string;
/** Specifies that the image or disk that is being used was licensed on-premises. Possible values for Windows Server operating system are: Windows_Client Windows_Server Possible values for Linux Server operating system are: RHEL_BYOS (for RHEL) SLES_BYOS (for SUSE) For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing) [Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux) Minimum api-version: 2015-06-15 */
licenseType?: string;
/**
* Specifies whether the model applied to the virtual machine is the model of the virtual machine scale set or the customized model for the virtual machine.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly modelDefinitionApplied?: string;
/** Specifies the protection policy of the virtual machine. */
protectionPolicy?: VirtualMachineScaleSetVMProtectionPolicy;
/** UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01 */
userData?: string;
/**
* Specifies the time at which the Virtual Machine resource was created. Minimum api-version: 2021-11-01.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly timeCreated?: Date;
}
/** Describes a Virtual Machine run command. */
export interface VirtualMachineRunCommand extends TrackedResource {
/** The source of the run command script. */
source?: VirtualMachineRunCommandScriptSource;
/** The parameters used by the script. */
parameters?: RunCommandInputParameter[];
/** The parameters used by the script. */
protectedParameters?: RunCommandInputParameter[];
/** Optional. If set to true, provisioning will complete as soon as the script starts and will not wait for script to complete. */
asyncExecution?: boolean;
/** Specifies the user account on the VM when executing the run command. */
runAsUser?: string;
/** Specifies the user account password on the VM when executing the run command. */
runAsPassword?: string;
/** The timeout in seconds to execute the run command. */
timeoutInSeconds?: number;
/** Specifies the Azure storage blob where script output stream will be uploaded. Use a SAS URI with read, append, create, write access OR use managed identity to provide the VM access to the blob. Refer outputBlobManagedIdentity parameter. */
outputBlobUri?: string;
/** Specifies the Azure storage blob where script error stream will be uploaded. Use a SAS URI with read, append, create, write access OR use managed identity to provide the VM access to the blob. Refer errorBlobManagedIdentity parameter. */
errorBlobUri?: string;
/** User-assigned managed identity that has access to outputBlobUri storage blob. Use an empty object in case of system-assigned identity. Make sure managed identity has been given access to blob's container with 'Storage Blob Data Contributor' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged */
outputBlobManagedIdentity?: RunCommandManagedIdentity;
/** User-assigned managed identity that has access to errorBlobUri storage blob. Use an empty object in case of system-assigned identity. Make sure managed identity has been given access to blob's container with 'Storage Blob Data Contributor' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged */
errorBlobManagedIdentity?: RunCommandManagedIdentity;
/**
* The provisioning state, which only appears in the response. If treatFailureAsDeploymentFailure set to true, any failure in the script will fail the deployment and ProvisioningState will be marked as Failed. If treatFailureAsDeploymentFailure set to false, ProvisioningState would only reflect whether the run command was run or not by the extensions platform, it would not indicate whether script failed in case of script failures. See instance view of run command in case of script failures to see executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly provisioningState?: string;
/**
* The virtual machine run command instance view.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly instanceView?: VirtualMachineRunCommandInstanceView;
/** Optional. If set to true, any failure in the script will fail the deployment and ProvisioningState will be marked as Failed. If set to false, ProvisioningState would only reflect whether the run command was run or not by the extensions platform, it would not indicate whether script failed in case of script failures. See instance view of run command in case of script failures to see executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results */
treatFailureAsDeploymentFailure?: boolean;
}
/** disk access resource. */
export interface DiskAccess extends TrackedResource {
/** The extended location where the disk access will be created. Extended location cannot be changed. */
extendedLocation?: ExtendedLocation;
/**
* A readonly collection of private endpoint connections created on the disk. Currently only one endpoint connection is supported.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly privateEndpointConnections?: PrivateEndpointConnection[];
/**
* The disk access resource provisioning state.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly provisioningState?: string;
/**
* The time when the disk access was created.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly timeCreated?: Date;
}
/** disk encryption set resource. */
export interface DiskEncryptionSet extends TrackedResource {
/** The managed identity for the disk encryption set. It should be given permission on the key vault before it can be used to encrypt disks. */
identity?: EncryptionSetIdentity;
/** The type of key used to encrypt the data of the disk. */
encryptionType?: DiskEncryptionSetType;
/** The key vault key which is currently used by this disk encryption set. */
activeKey?: KeyForDiskEncryptionSet;
/**
* A readonly collection of key vault keys previously used by this disk encryption set while a key rotation is in progress. It will be empty if there is no ongoing key rotation.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly previousKeys?: KeyForDiskEncryptionSet[];
/**
* The disk encryption set provisioning state.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly provisioningState?: string;
/** Set this flag to true to enable auto-updating of this disk encryption set to the latest key version. */
rotationToLatestKeyVersionEnabled?: boolean;
/**
* The time when the active key of this disk encryption set was updated.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly lastKeyRotationTimestamp?: Date;
/**
* The error that was encountered during auto-key rotation. If an error is present, then auto-key rotation will not be attempted until the error on this disk encryption set is fixed.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly autoKeyRotationError?: ApiError;
/** Multi-tenant application client id to access key vault in a different tenant. Setting the value to 'None' will clear the property. */
federatedClientId?: string;
}
/** Disk resource. */
export interface Disk extends TrackedResource {
/**
* A relative URI containing the ID of the VM that has the disk attached.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly managedBy?: string;
/**
* List of relative URIs containing the IDs of the VMs that have the disk attached. maxShares should be set to a value greater than one for disks to allow attaching them to multiple VMs.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly managedByExtended?: string[];
/** The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, UltraSSD_LRS, Premium_ZRS, StandardSSD_ZRS, or PremiumV2_LRS. */
sku?: DiskSku;
/** The Logical zone list for Disk. */
zones?: string[];
/** The extended location where the disk will be created. Extended location cannot be changed. */
extendedLocation?: ExtendedLocation;
/**
* The time when the disk was created.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly timeCreated?: Date;
/** The Operating System type. */
osType?: OperatingSystemTypes;
/** The hypervisor generation of the Virtual Machine. Applicable to OS disks only. */
hyperVGeneration?: HyperVGeneration;
/** Purchase plan information for the the image from which the OS disk was created. E.g. - {name: 2019-Datacenter, publisher: MicrosoftWindowsServer, product: WindowsServer} */
purchasePlan?: DiskPurchasePlan;
/** List of supported capabilities for the image from which the OS disk was created. */
supportedCapabilities?: SupportedCapabilities;
/** Disk source information. CreationData information cannot be changed after the disk has been created. */
creationData?: CreationData;
/** If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size. */
diskSizeGB?: number;
/**
* The size of the disk in bytes. This field is read only.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly diskSizeBytes?: number;
/**
* Unique Guid identifying the resource.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly uniqueId?: string;
/** Encryption settings collection used for Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot. */
encryptionSettingsCollection?: EncryptionSettingsCollection;
/**
* The disk provisioning state.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly provisioningState?: string;
/** The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes. */
diskIopsReadWrite?: number;
/** The bandwidth allowed for this disk; only settable for UltraSSD disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10. */
diskMBpsReadWrite?: number;
/** The total number of IOPS that will be allowed across all VMs mounting the shared disk as ReadOnly. One operation can transfer between 4k and 256k bytes. */
diskIopsReadOnly?: number;
/** The total throughput (MBps) that will be allowed across all VMs mounting the shared disk as ReadOnly. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10. */
diskMBpsReadOnly?: number;
/**
* The state of the disk.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly diskState?: DiskState;
/** Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys. */
encryption?: Encryption;
/** The maximum number of VMs that can attach to the disk at the same time. Value greater than one indicates a disk that can be mounted on multiple VMs at the same time. */
maxShares?: number;
/**
* Details of the list of all VMs that have the disk attached. maxShares should be set to a value greater than one for disks to allow attaching them to multiple VMs.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly shareInfo?: ShareInfoElement[];
/** Policy for accessing the disk via network. */
networkAccessPolicy?: NetworkAccessPolicy;
/** ARM id of the DiskAccess resource for using private endpoints on disks. */
diskAccessId?: string;
/**
* Latest time when bursting was last enabled on a disk.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly burstingEnabledTime?: Date;
/** Performance tier of the disk (e.g, P4, S10) as described here: https://azure.microsoft.com/en-us/pricing/details/managed-disks/. Does not apply to Ultra disks. */
tier?: string;
/** Set to true to enable bursting beyond the provisioned performance target of the disk. Bursting is disabled by default. Does not apply to Ultra disks. */
burstingEnabled?: boolean;
/**
* Properties of the disk for which update is pending.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly propertyUpdatesInProgress?: PropertyUpdatesInProgress;
/** Indicates the OS on a disk supports hibernation. */
supportsHibernation?: boolean;
/** Contains the security related information for the resource. */
securityProfile?: DiskSecurityProfile;
/** Percentage complete for the background copy when a resource is created via the CopyStart operation. */
completionPercent?: number;
/** Policy for controlling export on the disk. */
publicNetworkAccess?: PublicNetworkAccess;
/** Additional authentication requirements when exporting or uploading to a disk or snapshot. */
dataAccessAuthMode?: DataAccessAuthMode;
/** Setting this property to true improves reliability and performance of data disks that are frequently (more than 5 times a day) by detached from one virtual machine and attached to another. This property should not be set for disks that are not detached and attached frequently as it causes the disks to not align with the fault domain of the virtual machine. */
optimizedForFrequentAttach?: boolean;
/**
* The UTC time when the ownership state of the disk was last changed i.e., the time the disk was last attached or detached from a VM or the time when the VM to which the disk was attached was deallocated or started.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly lastOwnershipUpdateTime?: Date;
/** Determines how platform treats disk failures */
availabilityPolicy?: AvailabilityPolicy;
}
/** Snapshot resource. */
export interface Snapshot extends TrackedResource {
/**
* Unused. Always Null.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly managedBy?: string;
/** The snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS. This is an optional parameter for incremental snapshot and the default behavior is the SKU will be set to the same sku as the previous snapshot */
sku?: SnapshotSku;
/** The extended location where the snapshot will be created. Extended location cannot be changed. */
extendedLocation?: ExtendedLocation;
/**
* The time when the snapshot was created.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly timeCreated?: Date;
/** The Operating System type. */
osType?: OperatingSystemTypes;
/** The hypervisor generation of the Virtual Machine. Applicable to OS disks only. */
hyperVGeneration?: HyperVGeneration;
/** Purchase plan information for the image from which the source disk for the snapshot was originally created. */
purchasePlan?: DiskPurchasePlan;
/** List of supported capabilities for the image from which the source disk from the snapshot was originally created. */
supportedCapabilities?: SupportedCapabilities;
/** Disk source information. CreationData information cannot be changed after the disk has been created. */
creationData?: CreationData;
/** If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size. */
diskSizeGB?: number;
/**
* The size of the disk in bytes. This field is read only.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly diskSizeBytes?: number;
/**
* The state of the snapshot.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly diskState?: DiskState;
/**
* Unique Guid identifying the resource.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly uniqueId?: string;
/** Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot. */
encryptionSettingsCollection?: EncryptionSettingsCollection;
/**
* The disk provisioning state.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly provisioningState?: string;
/** Whether a snapshot is incremental. Incremental snapshots on the same disk occupy less space than full snapshots and can be diffed. */
incremental?: boolean;
/**
* Incremental snapshots for a disk share an incremental snapshot family id. The Get Page Range Diff API can only be called on incremental snapshots with the same family id.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly incrementalSnapshotFamilyId?: string;
/** Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys. */
encryption?: Encryption;
/** Policy for accessing the disk via network. */
networkAccessPolicy?: NetworkAccessPolicy;
/** ARM id of the DiskAccess resource for using private endpoints on disks. */
diskAccessId?: string;
/** Contains the security related information for the resource. */
securityProfile?: DiskSecurityProfile;
/** Indicates the OS on a snapshot supports hibernation. */
supportsHibernation?: boolean;
/** Policy for controlling export on the disk. */
publicNetworkAccess?: PublicNetworkAccess;
/** Percentage complete for the background copy when a resource is created via the CopyStart operation. */
completionPercent?: number;
/** Indicates the error details if the background copy of a resource created via the CopyStart operation fails. */
copyCompletionError?: CopyCompletionError;
/** Additional authentication requirements when exporting or uploading to a disk or snapshot. */
dataAccessAuthMode?: DataAccessAuthMode;
/**
* The state of snapshot which determines the access availability of the snapshot.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly snapshotAccessState?: SnapshotAccessState;
}
/** Specifies information about the Shared Image Gallery that you want to create or update. */
export interface Gallery extends TrackedResource {
/** The identity of the gallery, if configured. */
identity?: GalleryIdentity;
/** The description of this Shared Image Gallery resource. This property is updatable. */
description?: string;
/** Describes the gallery unique name. */
identifier?: GalleryIdentifier;
/**
* The provisioning state, which only appears in the response.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly provisioningState?: GalleryProvisioningState;
/** Profile for gallery sharing to subscription or tenant */
sharingProfile?: SharingProfile;
/** Contains information about the soft deletion policy of the gallery. */
softDeletePolicy?: SoftDeletePolicy;
/**
* Sharing status of current gallery.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly sharingStatus?: SharingStatus;
}
/** Specifies information about the gallery Application Definition that you want to create or update. */
export interface GalleryApplication extends TrackedResource {
/** The description of this gallery Application Definition resource. This property is updatable. */
description?: string;
/** The Eula agreement for the gallery Application Definition. */
eula?: string;
/** The privacy statement uri. */
privacyStatementUri?: string;
/** The release note uri. */
releaseNoteUri?: string;
/** The end of life date of the gallery Application Definition. This property can be used for decommissioning purposes. This property is updatable. */
endOfLifeDate?: Date;
/** This property allows you to specify the supported type of the OS that application is built for. Possible values are: **Windows,** **Linux.** */
supportedOSType?: OperatingSystemTypes;
/** A list of custom actions that can be performed with all of the Gallery Application Versions within this Gallery Application. */
customActions?: GalleryApplicationCustomAction[];
}
/** Specifies information about the gallery Application Version that you want to create or update. */
export interface GalleryApplicationVersion extends TrackedResource {
/** The publishing profile of a gallery image version. */
publishingProfile?: GalleryApplicationVersionPublishingProfile;
/** The safety profile of the Gallery Application Version. */
safetyProfile?: GalleryApplicationVersionSafetyProfile;
/**
* The provisioning state, which only appears in the response.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly provisioningState?: GalleryProvisioningState;
/**
* This is the replication status of the gallery image version.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly replicationStatus?: ReplicationStatus;
}
/** Specifies information about the gallery image definition that you want to create or update. */
export interface GalleryImage extends TrackedResource {
/** The description of this gallery image definition resource. This property is updatable. */
description?: string;
/** The Eula agreement for the gallery image definition. */
eula?: string;
/** The privacy statement uri. */
privacyStatementUri?: string;
/** The release note uri. */
releaseNoteUri?: string;
/** This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image. Possible values are: **Windows,** **Linux.** */
osType?: OperatingSystemTypes;
/** This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'. */
osState?: OperatingSystemStateTypes;
/** The hypervisor generation of the Virtual Machine. Applicable to OS disks only. */
hyperVGeneration?: HyperVGeneration;
/** The end of life date of the gallery image definition. This property can be used for decommissioning purposes. This property is updatable. */
endOfLifeDate?: Date;
/** This is the gallery image definition identifier. */
identifier?: GalleryImageIdentifier;
/** The properties describe the recommended machine configuration for this Image Definition. These properties are updatable. */
recommended?: RecommendedMachineConfiguration;
/** Describes the disallowed disk types. */
disallowed?: Disallowed;
/** Describes the gallery image definition purchase plan. This is used by marketplace images. */
purchasePlan?: ImagePurchasePlan;
/**
* The provisioning state, which only appears in the response.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly provisioningState?: GalleryProvisioningState;
/** A list of gallery image features. */
features?: GalleryImageFeature[];
/** The architecture of the image. Applicable to OS disks only. */
architecture?: Architecture;
/** Optional. Must be set to true if the gallery image features are being updated. */
allowUpdateImage?: boolean;
}
/** Specifies information about the gallery image version that you want to create or update. */
export interface GalleryImageVersion extends TrackedResource {
/** The publishing profile of a gallery image Version. */
publishingProfile?: GalleryImageVersionPublishingProfile;
/**
* The provisioning state, which only appears in the response.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly provisioningState?: GalleryProvisioningState;
/** This is the storage profile of a Gallery Image Version. */
storageProfile?: GalleryImageVersionStorageProfile;
/** This is the safety profile of the Gallery Image Version. */
safetyProfile?: GalleryImageVersionSafetyProfile;
/**
* This is the replication status of the gallery image version.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly replicationStatus?: ReplicationStatus;
/** The security profile of a gallery image version */
securityProfile?: ImageVersionSecurityProfile;
/** Indicates if this is a soft-delete resource restoration request. */
restore?: boolean;
/**
* This is the validations profile of a Gallery Image Version.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly validationsProfile?: ValidationsProfile;
}
/** Specifies information about the gallery inVMAccessControlProfile that you want to create or update. */
export interface GalleryInVMAccessControlProfile extends TrackedResource {
/** Describes the properties of a gallery inVMAccessControlProfile. */
properties?: GalleryInVMAccessControlProfileProperties;
}
/** Specifies information about the gallery inVMAccessControlProfile version that you want to create or update. */
export interface GalleryInVMAccessControlProfileVersion extends TrackedResource {
/** The target regions where the Resource Profile version is going to be replicated to. This property is updatable. */
targetLocations?: TargetRegion[];
/** If set to true, Virtual Machines deployed from the latest version of the Resource Profile won't use this Profile version. */
excludeFromLatest?: boolean;
/**
* The timestamp for when the Resource Profile Version is published.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly publishedDate?: Date;
/**
* The provisioning state, which only appears in the response.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly provisioningState?: GalleryProvisioningState;
/**
* This is the replication status of the gallery image version.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly replicationStatus?: ReplicationStatus;
/** This property allows you to specify whether the access control rules are in Audit mode, in Enforce mode or Disabled. Possible values are: 'Audit', 'Enforce' or 'Disabled'. */
mode?: AccessControlRulesMode;
/** This property allows you to specify if the requests will be allowed to access the host endpoints. Possible values are: 'Allow', 'Deny'. */
defaultAccess?: EndpointAccess;
/** This is the Access Control Rules specification for an inVMAccessControlProfile version. */
rules?: AccessControlRules;
}
/** The details information of soft-deleted resource. */
export interface GallerySoftDeletedResource extends TrackedResource {
/** arm id of the soft-deleted resource */
resourceArmId?: string;
/** artifact type of the soft-deleted resource */
softDeletedArtifactType?: SoftDeletedArtifactTypes;
/** The timestamp for when the resource is soft-deleted. In dateTime offset format. */
softDeletedTime?: string;
}
/** Restore Point details. */
export interface RestorePoint extends ProxyResource {
/** List of disk resource ids that the customer wishes to exclude from the restore point. If no disks are specified, all disks will be included. */
excludeDisks?: ApiEntityReference[];
/** Gets the details of the VM captured at the time of the restore point creation. */
sourceMetadata?: RestorePointSourceMetadata;
/**
* Gets the provisioning state of the restore point.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly provisioningState?: string;
/** ConsistencyMode of the RestorePoint. Can be specified in the input while creating a restore point. For now, only CrashConsistent is accepted as a valid input. Please refer to https://aka.ms/RestorePoints for more details. */
consistencyMode?: ConsistencyModeTypes;
/** Gets the creation time of the restore point. */
timeCreated?: Date;
/** Resource Id of the source restore point from which a copy needs to be created. */
sourceRestorePoint?: ApiEntityReference;
/**
* The restore point instance view.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly instanceView?: RestorePointInstanceView;
/** This property determines the time in minutes the snapshot is retained as instant access for restoring Premium SSD v2 or Ultra disk with fast restore performance in this restore point. */
instantAccessDurationMinutes?: number;
}
/** The Private Endpoint Connection resource. */
export interface PrivateEndpointConnection extends ProxyResource {
/**
* The resource of private end point.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly privateEndpoint?: PrivateEndpoint;
/** A collection of information about the state of the connection between DiskAccess and Virtual Network. */
privateLinkServiceConnectionState?: PrivateLinkServiceConnectionState;
/**
* The provisioning state of the private endpoint connection resource.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly provisioningState?: PrivateEndpointConnectionProvisioningState;
}
/** Properties of disk restore point */
export interface DiskRestorePoint extends ProxyResource {
/**
* The timestamp of restorePoint creation
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly timeCreated?: Date;
/**
* arm id of source disk or source disk restore point.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly sourceResourceId?: string;
/**
* The Operating System type.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly osType?: OperatingSystemTypes;
/** The hypervisor generation of the Virtual Machine. Applicable to OS disks only. */
hyperVGeneration?: HyperVGeneration;
/** Purchase plan information for the the image from which the OS disk was created. */
purchasePlan?: DiskPurchasePlan;
/** List of supported capabilities for the image from which the OS disk was created. */
supportedCapabilities?: SupportedCapabilities;
/**
* id of the backing snapshot's MIS family
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly familyId?: string;
/**
* unique incarnation id of the source disk
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly sourceUniqueId?: string;
/**
* Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly encryption?: Encryption;
/** Indicates the OS on a disk supports hibernation. */
supportsHibernation?: boolean;
/** Policy for accessing the disk via network. */
networkAccessPolicy?: NetworkAccessPolicy;
/** Policy for controlling export on the disk. */
publicNetworkAccess?: PublicNetworkAccess;
/** ARM id of the DiskAccess resource for using private endpoints on disks. */
diskAccessId?: string;
/** Percentage complete for the background copy of disk restore point when source resource is from a different region. */
completionPercent?: number;
/**
* Replication state of disk restore point when source resource is from a different region.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly replicationState?: string;
/**
* Location of source disk or source disk restore point when source resource is from a different region.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly sourceResourceLocation?: string;
/** Contains the security related information for the resource. */
securityProfile?: DiskSecurityProfile;
/**
* Logical sector size in bytes for disk restore points of UltraSSD_LRS and PremiumV2_LRS disks. Supported values are 512 and 4096. 4096 is the default.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly logicalSectorSize?: number;
}
/** Describes a Virtual Machine Scale Set VM Reimage Parameters. */
export interface VirtualMachineScaleSetReimageParameters extends VirtualMachineScaleSetVMReimageParameters {
/** The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set. */
instanceIds?: string[];
}
/** Specifies information about the Shared Gallery that you want to create or update. */
export interface SharedGallery extends PirSharedGalleryResource {
/**
* The artifact tags of a shared gallery resource.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly artifactTags?: {
[propertyName: string]: string;
};
}
/** Specifies information about the gallery image definition that you want to create or update. */
export interface SharedGalleryImage extends PirSharedGalleryResource {
/** This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image. Possible values are: **Windows,** **Linux.** */
osType?: OperatingSystemTypes;
/** This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'. */
osState?: OperatingSystemStateTypes;
/** The end of life date of the gallery image definition. This property can be used for decommissioning purposes. This property is updatable. */
endOfLifeDate?: Date;
/** This is the gallery image definition identifier. */
identifier?: GalleryImageIdentifier;
/** The properties describe the recommended machine configuration for this Image Definition. These properties are updatable. */
recommended?: RecommendedMachineConfiguration;
/** Describes the disallowed disk types. */
disallowed?: Disallowed;
/** The hypervisor generation of the Virtual Machine. Applicable to OS disks only. */
hyperVGeneration?: HyperVGeneration;
/** A list of gallery image features. */
features?: GalleryImageFeature[];
/** Describes the gallery image definition purchase plan. This is used by marketplace images. */
purchasePlan?: ImagePurchasePlan;
/** The architecture of the image. Applicable to OS disks only. */
architecture?: Architecture;
/** Privacy statement uri for the current community gallery image. */
privacyStatementUri?: string;
/** End-user license agreement for the current community gallery image. */
eula?: string;
/** The artifact tags of a shared gallery resource. */
artifactTags?: {
[propertyName: string]: string;
};
}
/** Specifies information about the gallery image version that you want to create or update. */
export interface SharedGalleryImageVersion extends PirSharedGalleryResource {
/** The published date of the gallery image version Definition. This property can be used for decommissioning purposes. This property is updatable. */
publishedDate?: Date;
/** The end of life date of the gallery image version Definition. This property can be used for decommissioning purposes. This property is updatable. */
endOfLifeDate?: Date;
/** If set to true, Virtual Machines deployed from the latest version of the Image Definition won't use this Image Version. */
excludeFromLatest?: boolean;
/** Describes the storage profile of the image version. */
storageProfile?: SharedGalleryImageVersionStorageProfile;
/** The artifact tags of a shared gallery resource. */
artifactTags?: {
[propertyName: string]: string;
};
}
/** Defines headers for AvailabilitySets_convertToVirtualMachineScaleSet operation. */
export interface AvailabilitySetsConvertToVirtualMachineScaleSetHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for Images_createOrUpdate operation. */
export interface ImagesCreateOrUpdateHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for Images_update operation. */
export interface ImagesUpdateHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for Images_delete operation. */
export interface ImagesDeleteHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for LogAnalytics_exportRequestRateByInterval operation. */
export interface LogAnalyticsExportRequestRateByIntervalHeaders {
/** A link to the status monitor */
azureAsyncOperation?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for LogAnalytics_exportThrottledRequests operation. */
export interface LogAnalyticsExportThrottledRequestsHeaders {
/** A link to the status monitor */
azureAsyncOperation?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for VirtualMachineRunCommands_createOrUpdate operation. */
export interface VirtualMachineRunCommandsCreateOrUpdateHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for VirtualMachineRunCommands_update operation. */
export interface VirtualMachineRunCommandsUpdateHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for VirtualMachineRunCommands_delete operation. */
export interface VirtualMachineRunCommandsDeleteHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for VirtualMachineScaleSets_createOrUpdate operation. */
export interface VirtualMachineScaleSetsCreateOrUpdateHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for VirtualMachineScaleSets_update operation. */
export interface VirtualMachineScaleSetsUpdateHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for VirtualMachineScaleSets_delete operation. */
export interface VirtualMachineScaleSetsDeleteHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for VirtualMachineScaleSets_approveRollingUpgrade operation. */
export interface VirtualMachineScaleSetsApproveRollingUpgradeHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for VirtualMachineScaleSets_deallocate operation. */
export interface VirtualMachineScaleSetsDeallocateHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for VirtualMachineScaleSets_deleteInstances operation. */
export interface VirtualMachineScaleSetsDeleteInstancesHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for VirtualMachineScaleSets_updateInstances operation. */
export interface VirtualMachineScaleSetsUpdateInstancesHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for VirtualMachineScaleSets_performMaintenance operation. */
export interface VirtualMachineScaleSetsPerformMaintenanceHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for VirtualMachineScaleSets_powerOff operation. */
export interface VirtualMachineScaleSetsPowerOffHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for VirtualMachineScaleSets_reapply operation. */
export interface VirtualMachineScaleSetsReapplyHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for VirtualMachineScaleSets_redeploy operation. */
export interface VirtualMachineScaleSetsRedeployHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for VirtualMachineScaleSets_reimage operation. */
export interface VirtualMachineScaleSetsReimageHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for VirtualMachineScaleSets_reimageAll operation. */
export interface VirtualMachineScaleSetsReimageAllHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for VirtualMachineScaleSets_restart operation. */
export interface VirtualMachineScaleSetsRestartHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for VirtualMachineScaleSets_scaleOut operation. */
export interface VirtualMachineScaleSetsScaleOutHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for VirtualMachineScaleSets_setOrchestrationServiceState operation. */
export interface VirtualMachineScaleSetsSetOrchestrationServiceStateHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for VirtualMachineScaleSets_start operation. */
export interface VirtualMachineScaleSetsStartHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for VirtualMachines_createOrUpdate operation. */
export interface VirtualMachinesCreateOrUpdateHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for VirtualMachines_update operation. */
export interface VirtualMachinesUpdateHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for VirtualMachines_delete operation. */
export interface VirtualMachinesDeleteHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for VirtualMachines_assessPatches operation. */
export interface VirtualMachinesAssessPatchesHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for VirtualMachines_attachDetachDataDisks operation. */
export interface VirtualMachinesAttachDetachDataDisksHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for VirtualMachines_capture operation. */
export interface VirtualMachinesCaptureHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for VirtualMachines_convertToManagedDisks operation. */
export interface VirtualMachinesConvertToManagedDisksHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for VirtualMachines_deallocate operation. */
export interface VirtualMachinesDeallocateHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for VirtualMachines_installPatches operation. */
export interface VirtualMachinesInstallPatchesHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for VirtualMachines_migrateToVMScaleSet operation. */
export interface VirtualMachinesMigrateToVMScaleSetHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for VirtualMachines_performMaintenance operation. */
export interface VirtualMachinesPerformMaintenanceHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for VirtualMachines_powerOff operation. */
export interface VirtualMachinesPowerOffHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for VirtualMachines_reapply operation. */
export interface VirtualMachinesReapplyHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for VirtualMachines_redeploy operation. */
export interface VirtualMachinesRedeployHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for VirtualMachines_reimage operation. */
export interface VirtualMachinesReimageHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for VirtualMachines_restart operation. */
export interface VirtualMachinesRestartHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for VirtualMachines_runCommand operation. */
export interface VirtualMachinesRunCommandHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for VirtualMachines_start operation. */
export interface VirtualMachinesStartHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for RestorePointCollections_delete operation. */
export interface RestorePointCollectionsDeleteHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for CapacityReservations_createOrUpdate operation. */
export interface CapacityReservationsCreateOrUpdateHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for CapacityReservations_update operation. */
export interface CapacityReservationsUpdateHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for CapacityReservations_delete operation. */
export interface CapacityReservationsDeleteHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for DedicatedHosts_createOrUpdate operation. */
export interface DedicatedHostsCreateOrUpdateHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for DedicatedHosts_update operation. */
export interface DedicatedHostsUpdateHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for DedicatedHosts_delete operation. */
export interface DedicatedHostsDeleteHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for DedicatedHosts_redeploy operation. */
export interface DedicatedHostsRedeployHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for DedicatedHosts_restart operation. */
export interface DedicatedHostsRestartHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for RestorePoints_create operation. */
export interface RestorePointsCreateHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for RestorePoints_delete operation. */
export interface RestorePointsDeleteHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for VirtualMachineScaleSetRollingUpgrades_startExtensionUpgrade operation. */
export interface VirtualMachineScaleSetRollingUpgradesStartExtensionUpgradeHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for VirtualMachineScaleSetRollingUpgrades_startOSUpgrade operation. */
export interface VirtualMachineScaleSetRollingUpgradesStartOSUpgradeHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for VirtualMachineScaleSetRollingUpgrades_cancel operation. */
export interface VirtualMachineScaleSetRollingUpgradesCancelHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for VirtualMachineScaleSetExtensions_createOrUpdate operation. */
export interface VirtualMachineScaleSetExtensionsCreateOrUpdateHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for VirtualMachineScaleSetExtensions_update operation. */
export interface VirtualMachineScaleSetExtensionsUpdateHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for VirtualMachineScaleSetExtensions_delete operation. */
export interface VirtualMachineScaleSetExtensionsDeleteHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for VirtualMachineScaleSetVMs_update operation. */
export interface VirtualMachineScaleSetVMsUpdateHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for VirtualMachineScaleSetVMs_delete operation. */
export interface VirtualMachineScaleSetVMsDeleteHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for VirtualMachineScaleSetVMs_approveRollingUpgrade operation. */
export interface VirtualMachineScaleSetVMsApproveRollingUpgradeHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for VirtualMachineScaleSetVMs_attachDetachDataDisks operation. */
export interface VirtualMachineScaleSetVMsAttachDetachDataDisksHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for VirtualMachineScaleSetVMs_deallocate operation. */
export interface VirtualMachineScaleSetVMsDeallocateHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for VirtualMachineScaleSetVMs_performMaintenance operation. */
export interface VirtualMachineScaleSetVMsPerformMaintenanceHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for VirtualMachineScaleSetVMs_powerOff operation. */
export interface VirtualMachineScaleSetVMsPowerOffHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for VirtualMachineScaleSetVMs_redeploy operation. */
export interface VirtualMachineScaleSetVMsRedeployHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for VirtualMachineScaleSetVMs_reimage operation. */
export interface VirtualMachineScaleSetVMsReimageHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for VirtualMachineScaleSetVMs_reimageAll operation. */
export interface VirtualMachineScaleSetVMsReimageAllHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for VirtualMachineScaleSetVMs_restart operation. */
export interface VirtualMachineScaleSetVMsRestartHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for VirtualMachineScaleSetVMs_runCommand operation. */
export interface VirtualMachineScaleSetVMsRunCommandHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for VirtualMachineScaleSetVMs_start operation. */
export interface VirtualMachineScaleSetVMsStartHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for VirtualMachineScaleSetVMExtensions_createOrUpdate operation. */
export interface VirtualMachineScaleSetVMExtensionsCreateOrUpdateHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for VirtualMachineScaleSetVMExtensions_update operation. */
export interface VirtualMachineScaleSetVMExtensionsUpdateHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for VirtualMachineScaleSetVMExtensions_delete operation. */
export interface VirtualMachineScaleSetVMExtensionsDeleteHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for VirtualMachineScaleSetVMRunCommands_createOrUpdate operation. */
export interface VirtualMachineScaleSetVMRunCommandsCreateOrUpdateHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for VirtualMachineScaleSetVMRunCommands_update operation. */
export interface VirtualMachineScaleSetVMRunCommandsUpdateHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for VirtualMachineScaleSetVMRunCommands_delete operation. */
export interface VirtualMachineScaleSetVMRunCommandsDeleteHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for VirtualMachineExtensions_createOrUpdate operation. */
export interface VirtualMachineExtensionsCreateOrUpdateHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for VirtualMachineExtensions_update operation. */
export interface VirtualMachineExtensionsUpdateHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for VirtualMachineExtensions_delete operation. */
export interface VirtualMachineExtensionsDeleteHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for DiskAccesses_createOrUpdate operation. */
export interface DiskAccessesCreateOrUpdateHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for DiskAccesses_update operation. */
export interface DiskAccessesUpdateHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for DiskAccesses_delete operation. */
export interface DiskAccessesDeleteHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for DiskAccesses_updateAPrivateEndpointConnection operation. */
export interface DiskAccessesUpdateAPrivateEndpointConnectionHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for DiskAccesses_deleteAPrivateEndpointConnection operation. */
export interface DiskAccessesDeleteAPrivateEndpointConnectionHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for DiskEncryptionSets_createOrUpdate operation. */
export interface DiskEncryptionSetsCreateOrUpdateHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for DiskEncryptionSets_update operation. */
export interface DiskEncryptionSetsUpdateHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for DiskEncryptionSets_delete operation. */
export interface DiskEncryptionSetsDeleteHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for Disks_createOrUpdate operation. */
export interface DisksCreateOrUpdateHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for Disks_update operation. */
export interface DisksUpdateHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for Disks_delete operation. */
export interface DisksDeleteHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for Disks_grantAccess operation. */
export interface DisksGrantAccessHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for Disks_revokeAccess operation. */
export interface DisksRevokeAccessHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for Snapshots_createOrUpdate operation. */
export interface SnapshotsCreateOrUpdateHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for Snapshots_update operation. */
export interface SnapshotsUpdateHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for Snapshots_delete operation. */
export interface SnapshotsDeleteHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for Snapshots_grantAccess operation. */
export interface SnapshotsGrantAccessHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for Snapshots_revokeAccess operation. */
export interface SnapshotsRevokeAccessHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for DiskRestorePoint_grantAccess operation. */
export interface DiskRestorePointGrantAccessHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for DiskRestorePoint_revokeAccess operation. */
export interface DiskRestorePointRevokeAccessHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for Galleries_createOrUpdate operation. */
export interface GalleriesCreateOrUpdateHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for Galleries_update operation. */
export interface GalleriesUpdateHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for Galleries_delete operation. */
export interface GalleriesDeleteHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for GalleryApplications_createOrUpdate operation. */
export interface GalleryApplicationsCreateOrUpdateHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for GalleryApplications_update operation. */
export interface GalleryApplicationsUpdateHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for GalleryApplications_delete operation. */
export interface GalleryApplicationsDeleteHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for GalleryApplicationVersions_createOrUpdate operation. */
export interface GalleryApplicationVersionsCreateOrUpdateHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for GalleryApplicationVersions_update operation. */
export interface GalleryApplicationVersionsUpdateHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for GalleryApplicationVersions_delete operation. */
export interface GalleryApplicationVersionsDeleteHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for GalleryImages_createOrUpdate operation. */
export interface GalleryImagesCreateOrUpdateHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for GalleryImages_update operation. */
export interface GalleryImagesUpdateHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for GalleryImages_delete operation. */
export interface GalleryImagesDeleteHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for GalleryImageVersions_createOrUpdate operation. */
export interface GalleryImageVersionsCreateOrUpdateHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for GalleryImageVersions_update operation. */
export interface GalleryImageVersionsUpdateHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for GalleryImageVersions_delete operation. */
export interface GalleryImageVersionsDeleteHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for GalleryInVMAccessControlProfiles_createOrUpdate operation. */
export interface GalleryInVMAccessControlProfilesCreateOrUpdateHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for GalleryInVMAccessControlProfiles_update operation. */
export interface GalleryInVMAccessControlProfilesUpdateHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for GalleryInVMAccessControlProfiles_delete operation. */
export interface GalleryInVMAccessControlProfilesDeleteHeaders {
/** A link to the status monitor */
azureAsyncOperation?: string;
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
}
/** Defines headers for GalleryInVMAccessControlProfileVersions_createOrUpdate operation. */
export interface GalleryInVMAccessControlProfileVersionsCreateOrUpdateHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for GalleryInVMAccessControlProfileVersions_update operation. */
export interface GalleryInVMAccessControlProfileVersionsUpdateHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Defines headers for GalleryInVMAccessControlProfileVersions_delete operation. */
export interface GalleryInVMAccessControlProfileVersionsDeleteHeaders {
/** A link to the status monitor */
azureAsyncOperation?: string;
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
}
/** Defines headers for GallerySharingProfile_update operation. */
export interface GallerySharingProfileUpdateHeaders {
/** The Location header contains the URL where the status of the long running operation can be checked. */
location?: string;
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
retryAfter?: number;
}
/** Known values of {@link Origin} that the service accepts. */
export declare enum KnownOrigin {
/** User */
User = "user",
/** System */
System = "system",
/** UserSystem */
UserSystem = "user,system"
}
/**
* Defines values for Origin. \
* {@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** \
* **system** \
* **user,system**
*/
export type Origin = string;
/** Known values of {@link ActionType} that the service accepts. */
export declare enum KnownActionType {
/** Internal */
Internal = "Internal"
}
/**
* Defines values for ActionType. \
* {@link KnownActionType} can be used interchangeably with ActionType,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **Internal**
*/
export type ActionType = string;
/** Known values of {@link CreatedByType} that the service accepts. */
export declare enum KnownCreatedByType {
/** User */
User = "User",
/** Application */
Application = "Application",
/** ManagedIdentity */
ManagedIdentity = "ManagedIdentity",
/** Key */
Key = "Key"
}
/**
* Defines values for CreatedByType. \
* {@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** \
* **Application** \
* **ManagedIdentity** \
* **Key**
*/
export type CreatedByType = string;
/** Known values of {@link ExpandTypesForGetCapacityReservationGroups} that the service accepts. */
export declare enum KnownExpandTypesForGetCapacityReservationGroups {
/** VirtualMachineScaleSetVMsRef */
VirtualMachineScaleSetVMsRef = "virtualMachineScaleSetVMs/$ref",
/** VirtualMachinesRef */
VirtualMachinesRef = "virtualMachines/$ref"
}
/**
* Defines values for ExpandTypesForGetCapacityReservationGroups. \
* {@link KnownExpandTypesForGetCapacityReservationGroups} can be used interchangeably with ExpandTypesForGetCapacityReservationGroups,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **virtualMachineScaleSetVMs\/$ref** \
* **virtualMachines\/$ref**
*/
export type ExpandTypesForGetCapacityReservationGroups = string;
/** Known values of {@link ResourceIdOptionsForGetCapacityReservationGroups} that the service accepts. */
export declare enum KnownResourceIdOptionsForGetCapacityReservationGroups {
/** CreatedInSubscription */
CreatedInSubscription = "CreatedInSubscription",
/** SharedWithSubscription */
SharedWithSubscription = "SharedWithSubscription",
/** All */
All = "All"
}
/**
* Defines values for ResourceIdOptionsForGetCapacityReservationGroups. \
* {@link KnownResourceIdOptionsForGetCapacityReservationGroups} can be used interchangeably with ResourceIdOptionsForGetCapacityReservationGroups,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **CreatedInSubscription** \
* **SharedWithSubscription** \
* **All**
*/
export type ResourceIdOptionsForGetCapacityReservationGroups = string;
/** Known values of {@link ReservationType} that the service accepts. */
export declare enum KnownReservationType {
/** To consume on demand allocated capacity reservation when a capacity reservation group is provided. */
Targeted = "Targeted",
/** To consume scheduled allocated block capacity reservation when a capacity reservation group is provided. */
Block = "Block"
}
/**
* Defines values for ReservationType. \
* {@link KnownReservationType} can be used interchangeably with ReservationType,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **Targeted**: To consume on demand allocated capacity reservation when a capacity reservation group is provided. \
* **Block**: To consume scheduled allocated block capacity reservation when a capacity reservation group is provided.
*/
export type ReservationType = string;
/** Known values of {@link StorageAccountTypes} that the service accepts. */
export declare enum KnownStorageAccountTypes {
/** StandardLRS */
StandardLRS = "Standard_LRS",
/** PremiumLRS */
PremiumLRS = "Premium_LRS",
/** StandardSSDLRS */
StandardSSDLRS = "StandardSSD_LRS",
/** UltraSSDLRS */
UltraSSDLRS = "UltraSSD_LRS",
/** PremiumZRS */
PremiumZRS = "Premium_ZRS",
/** StandardSSDZRS */
StandardSSDZRS = "StandardSSD_ZRS",
/** PremiumV2LRS */
PremiumV2LRS = "PremiumV2_LRS"
}
/**
* Defines values for StorageAccountTypes. \
* {@link KnownStorageAccountTypes} can be used interchangeably with StorageAccountTypes,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **Standard_LRS** \
* **Premium_LRS** \
* **StandardSSD_LRS** \
* **UltraSSD_LRS** \
* **Premium_ZRS** \
* **StandardSSD_ZRS** \
* **PremiumV2_LRS**
*/
export type StorageAccountTypes = string;
/** Known values of {@link HyperVGenerationTypes} that the service accepts. */
export declare enum KnownHyperVGenerationTypes {
/** V1 */
V1 = "V1",
/** V2 */
V2 = "V2"
}
/**
* Defines values for HyperVGenerationTypes. \
* {@link KnownHyperVGenerationTypes} can be used interchangeably with HyperVGenerationTypes,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **V1** \
* **V2**
*/
export type HyperVGenerationTypes = string;
/** Known values of {@link ExtendedLocationTypes} that the service accepts. */
export declare enum KnownExtendedLocationTypes {
/** EdgeZone */
EdgeZone = "EdgeZone"
}
/**
* Defines values for ExtendedLocationTypes. \
* {@link KnownExtendedLocationTypes} can be used interchangeably with ExtendedLocationTypes,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **EdgeZone**
*/
export type ExtendedLocationTypes = string;
/** Known values of {@link VmDiskTypes} that the service accepts. */
export declare enum KnownVmDiskTypes {
/** None */
None = "None",
/** Unmanaged */
Unmanaged = "Unmanaged"
}
/**
* Defines values for VmDiskTypes. \
* {@link KnownVmDiskTypes} can be used interchangeably with VmDiskTypes,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **None** \
* **Unmanaged**
*/
export type VmDiskTypes = string;
/** Known values of {@link ArchitectureTypes} that the service accepts. */
export declare enum KnownArchitectureTypes {
/** X64 */
X64 = "x64",
/** Arm64 */
Arm64 = "Arm64"
}
/**
* Defines values for ArchitectureTypes. \
* {@link KnownArchitectureTypes} can be used interchangeably with ArchitectureTypes,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **x64** \
* **Arm64**
*/
export type ArchitectureTypes = string;
/** Known values of {@link ImageState} that the service accepts. */
export declare enum KnownImageState {
/** Active */
Active = "Active",
/** ScheduledForDeprecation */
ScheduledForDeprecation = "ScheduledForDeprecation",
/** Deprecated */
Deprecated = "Deprecated"
}
/**
* Defines values for ImageState. \
* {@link KnownImageState} can be used interchangeably with ImageState,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **Active** \
* **ScheduledForDeprecation** \
* **Deprecated**
*/
export type ImageState = string;
/** Known values of {@link AlternativeType} that the service accepts. */
export declare enum KnownAlternativeType {
/** None */
None = "None",
/** Offer */
Offer = "Offer",
/** Plan */
Plan = "Plan"
}
/**
* Defines values for AlternativeType. \
* {@link KnownAlternativeType} can be used interchangeably with AlternativeType,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **None** \
* **Offer** \
* **Plan**
*/
export type AlternativeType = string;
/** Known values of {@link RepairAction} that the service accepts. */
export declare enum KnownRepairAction {
/** Replace */
Replace = "Replace",
/** Restart */
Restart = "Restart",
/** Reimage */
Reimage = "Reimage"
}
/**
* Defines values for RepairAction. \
* {@link KnownRepairAction} can be used interchangeably with RepairAction,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **Replace** \
* **Restart** \
* **Reimage**
*/
export type RepairAction = string;
/** Known values of {@link WindowsVMGuestPatchMode} that the service accepts. */
export declare enum KnownWindowsVMGuestPatchMode {
/** Manual */
Manual = "Manual",
/** AutomaticByOS */
AutomaticByOS = "AutomaticByOS",
/** AutomaticByPlatform */
AutomaticByPlatform = "AutomaticByPlatform"
}
/**
* Defines values for WindowsVMGuestPatchMode. \
* {@link KnownWindowsVMGuestPatchMode} can be used interchangeably with WindowsVMGuestPatchMode,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **Manual** \
* **AutomaticByOS** \
* **AutomaticByPlatform**
*/
export type WindowsVMGuestPatchMode = string;
/** Known values of {@link WindowsPatchAssessmentMode} that the service accepts. */
export declare enum KnownWindowsPatchAssessmentMode {
/** ImageDefault */
ImageDefault = "ImageDefault",
/** AutomaticByPlatform */
AutomaticByPlatform = "AutomaticByPlatform"
}
/**
* Defines values for WindowsPatchAssessmentMode. \
* {@link KnownWindowsPatchAssessmentMode} can be used interchangeably with WindowsPatchAssessmentMode,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **ImageDefault** \
* **AutomaticByPlatform**
*/
export type WindowsPatchAssessmentMode = string;
/** Known values of {@link WindowsVMGuestPatchAutomaticByPlatformRebootSetting} that the service accepts. */
export declare enum KnownWindowsVMGuestPatchAutomaticByPlatformRebootSetting {
/** Unknown */
Unknown = "Unknown",
/** IfRequired */
IfRequired = "IfRequired",
/** Never */
Never = "Never",
/** Always */
Always = "Always"
}
/**
* Defines values for WindowsVMGuestPatchAutomaticByPlatformRebootSetting. \
* {@link KnownWindowsVMGuestPatchAutomaticByPlatformRebootSetting} can be used interchangeably with WindowsVMGuestPatchAutomaticByPlatformRebootSetting,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **Unknown** \
* **IfRequired** \
* **Never** \
* **Always**
*/
export type WindowsVMGuestPatchAutomaticByPlatformRebootSetting = string;
/** Known values of {@link LinuxVMGuestPatchMode} that the service accepts. */
export declare enum KnownLinuxVMGuestPatchMode {
/** ImageDefault */
ImageDefault = "ImageDefault",
/** AutomaticByPlatform */
AutomaticByPlatform = "AutomaticByPlatform"
}
/**
* Defines values for LinuxVMGuestPatchMode. \
* {@link KnownLinuxVMGuestPatchMode} can be used interchangeably with LinuxVMGuestPatchMode,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **ImageDefault** \
* **AutomaticByPlatform**
*/
export type LinuxVMGuestPatchMode = string;
/** Known values of {@link LinuxPatchAssessmentMode} that the service accepts. */
export declare enum KnownLinuxPatchAssessmentMode {
/** ImageDefault */
ImageDefault = "ImageDefault",
/** AutomaticByPlatform */
AutomaticByPlatform = "AutomaticByPlatform"
}
/**
* Defines values for LinuxPatchAssessmentMode. \
* {@link KnownLinuxPatchAssessmentMode} can be used interchangeably with LinuxPatchAssessmentMode,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **ImageDefault** \
* **AutomaticByPlatform**
*/
export type LinuxPatchAssessmentMode = string;
/** Known values of {@link LinuxVMGuestPatchAutomaticByPlatformRebootSetting} that the service accepts. */
export declare enum KnownLinuxVMGuestPatchAutomaticByPlatformRebootSetting {
/** Unknown */
Unknown = "Unknown",
/** IfRequired */
IfRequired = "IfRequired",
/** Never */
Never = "Never",
/** Always */
Always = "Always"
}
/**
* Defines values for LinuxVMGuestPatchAutomaticByPlatformRebootSetting. \
* {@link KnownLinuxVMGuestPatchAutomaticByPlatformRebootSetting} can be used interchangeably with LinuxVMGuestPatchAutomaticByPlatformRebootSetting,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **Unknown** \
* **IfRequired** \
* **Never** \
* **Always**
*/
export type LinuxVMGuestPatchAutomaticByPlatformRebootSetting = string;
/** Known values of {@link DiskCreateOptionTypes} that the service accepts. */
export declare enum KnownDiskCreateOptionTypes {
/** FromImage */
FromImage = "FromImage",
/** Empty */
Empty = "Empty",
/** Attach */
Attach = "Attach",
/** Copy */
Copy = "Copy",
/** Restore */
Restore = "Restore"
}
/**
* Defines values for DiskCreateOptionTypes. \
* {@link KnownDiskCreateOptionTypes} can be used interchangeably with DiskCreateOptionTypes,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **FromImage** \
* **Empty** \
* **Attach** \
* **Copy** \
* **Restore**
*/
export type DiskCreateOptionTypes = string;
/** Known values of {@link DiffDiskOptions} that the service accepts. */
export declare enum KnownDiffDiskOptions {
/** Local */
Local = "Local"
}
/**
* Defines values for DiffDiskOptions. \
* {@link KnownDiffDiskOptions} can be used interchangeably with DiffDiskOptions,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **Local**
*/
export type DiffDiskOptions = string;
/** Known values of {@link DiffDiskPlacement} that the service accepts. */
export declare enum KnownDiffDiskPlacement {
/** CacheDisk */
CacheDisk = "CacheDisk",
/** ResourceDisk */
ResourceDisk = "ResourceDisk",
/** NvmeDisk */
NvmeDisk = "NvmeDisk"
}
/**
* Defines values for DiffDiskPlacement. \
* {@link KnownDiffDiskPlacement} can be used interchangeably with DiffDiskPlacement,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **CacheDisk** \
* **ResourceDisk** \
* **NvmeDisk**
*/
export type DiffDiskPlacement = string;
/** Known values of {@link SecurityEncryptionTypes} that the service accepts. */
export declare enum KnownSecurityEncryptionTypes {
/** VMGuestStateOnly */
VMGuestStateOnly = "VMGuestStateOnly",
/** DiskWithVMGuestState */
DiskWithVMGuestState = "DiskWithVMGuestState",
/** NonPersistedTPM */
NonPersistedTPM = "NonPersistedTPM"
}
/**
* Defines values for SecurityEncryptionTypes. \
* {@link KnownSecurityEncryptionTypes} can be used interchangeably with SecurityEncryptionTypes,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **VMGuestStateOnly** \
* **DiskWithVMGuestState** \
* **NonPersistedTPM**
*/
export type SecurityEncryptionTypes = string;
/** Known values of {@link DiskDeleteOptionTypes} that the service accepts. */
export declare enum KnownDiskDeleteOptionTypes {
/** Delete */
Delete = "Delete",
/** Detach */
Detach = "Detach"
}
/**
* Defines values for DiskDeleteOptionTypes. \
* {@link KnownDiskDeleteOptionTypes} can be used interchangeably with DiskDeleteOptionTypes,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **Delete** \
* **Detach**
*/
export type DiskDeleteOptionTypes = string;
/** Known values of {@link DiskControllerTypes} that the service accepts. */
export declare enum KnownDiskControllerTypes {
/** Scsi */
Scsi = "SCSI",
/** NVMe */
NVMe = "NVMe"
}
/**
* Defines values for DiskControllerTypes. \
* {@link KnownDiskControllerTypes} can be used interchangeably with DiskControllerTypes,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **SCSI** \
* **NVMe**
*/
export type DiskControllerTypes = string;
/** Known values of {@link DomainNameLabelScopeTypes} that the service accepts. */
export declare enum KnownDomainNameLabelScopeTypes {
/** TenantReuse */
TenantReuse = "TenantReuse",
/** SubscriptionReuse */
SubscriptionReuse = "SubscriptionReuse",
/** ResourceGroupReuse */
ResourceGroupReuse = "ResourceGroupReuse",
/** NoReuse */
NoReuse = "NoReuse"
}
/**
* Defines values for DomainNameLabelScopeTypes. \
* {@link KnownDomainNameLabelScopeTypes} can be used interchangeably with DomainNameLabelScopeTypes,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **TenantReuse** \
* **SubscriptionReuse** \
* **ResourceGroupReuse** \
* **NoReuse**
*/
export type DomainNameLabelScopeTypes = string;
/** Known values of {@link IPVersion} that the service accepts. */
export declare enum KnownIPVersion {
/** IPv4 */
IPv4 = "IPv4",
/** IPv6 */
IPv6 = "IPv6"
}
/**
* Defines values for IPVersion. \
* {@link KnownIPVersion} can be used interchangeably with IPVersion,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **IPv4** \
* **IPv6**
*/
export type IPVersion = string;
/** Known values of {@link DeleteOptions} that the service accepts. */
export declare enum KnownDeleteOptions {
/** Delete */
Delete = "Delete",
/** Detach */
Detach = "Detach"
}
/**
* Defines values for DeleteOptions. \
* {@link KnownDeleteOptions} can be used interchangeably with DeleteOptions,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **Delete** \
* **Detach**
*/
export type DeleteOptions = string;
/** Known values of {@link PublicIPAddressSkuName} that the service accepts. */
export declare enum KnownPublicIPAddressSkuName {
/** Basic */
Basic = "Basic",
/** Standard */
Standard = "Standard"
}
/**
* Defines values for PublicIPAddressSkuName. \
* {@link KnownPublicIPAddressSkuName} can be used interchangeably with PublicIPAddressSkuName,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **Basic** \
* **Standard**
*/
export type PublicIPAddressSkuName = string;
/** Known values of {@link PublicIPAddressSkuTier} that the service accepts. */
export declare enum KnownPublicIPAddressSkuTier {
/** Regional */
Regional = "Regional",
/** Global */
Global = "Global"
}
/**
* Defines values for PublicIPAddressSkuTier. \
* {@link KnownPublicIPAddressSkuTier} can be used interchangeably with PublicIPAddressSkuTier,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **Regional** \
* **Global**
*/
export type PublicIPAddressSkuTier = string;
/** Known values of {@link NetworkInterfaceAuxiliaryMode} that the service accepts. */
export declare enum KnownNetworkInterfaceAuxiliaryMode {
/** None */
None = "None",
/** AcceleratedConnections */
AcceleratedConnections = "AcceleratedConnections",
/** Floating */
Floating = "Floating"
}
/**
* Defines values for NetworkInterfaceAuxiliaryMode. \
* {@link KnownNetworkInterfaceAuxiliaryMode} can be used interchangeably with NetworkInterfaceAuxiliaryMode,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **None** \
* **AcceleratedConnections** \
* **Floating**
*/
export type NetworkInterfaceAuxiliaryMode = string;
/** Known values of {@link NetworkInterfaceAuxiliarySku} that the service accepts. */
export declare enum KnownNetworkInterfaceAuxiliarySku {
/** None */
None = "None",
/** A1 */
A1 = "A1",
/** A2 */
A2 = "A2",
/** A4 */
A4 = "A4",
/** A8 */
A8 = "A8"
}
/**
* Defines values for NetworkInterfaceAuxiliarySku. \
* {@link KnownNetworkInterfaceAuxiliarySku} can be used interchangeably with NetworkInterfaceAuxiliarySku,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **None** \
* **A1** \
* **A2** \
* **A4** \
* **A8**
*/
export type NetworkInterfaceAuxiliarySku = string;
/** Known values of {@link NetworkApiVersion} that the service accepts. */
export declare enum KnownNetworkApiVersion {
/** TwoThousandTwenty1101 */
TwoThousandTwenty1101 = "2020-11-01",
/** TwoThousandTwentyTwo1101 */
TwoThousandTwentyTwo1101 = "2022-11-01"
}
/**
* Defines values for NetworkApiVersion. \
* {@link KnownNetworkApiVersion} can be used interchangeably with NetworkApiVersion,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **2020-11-01** \
* **2022-11-01**
*/
export type NetworkApiVersion = string;
/** Known values of {@link SecurityTypes} that the service accepts. */
export declare enum KnownSecurityTypes {
/** TrustedLaunch */
TrustedLaunch = "TrustedLaunch",
/** ConfidentialVM */
ConfidentialVM = "ConfidentialVM"
}
/**
* Defines values for SecurityTypes. \
* {@link KnownSecurityTypes} can be used interchangeably with SecurityTypes,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **TrustedLaunch** \
* **ConfidentialVM**
*/
export type SecurityTypes = string;
/** Known values of {@link Mode} that the service accepts. */
export declare enum KnownMode {
/** Audit */
Audit = "Audit",
/** Enforce */
Enforce = "Enforce"
}
/**
* Defines values for Mode. \
* {@link KnownMode} can be used interchangeably with Mode,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **Audit** \
* **Enforce**
*/
export type Mode = string;
/** Known values of {@link Modes} that the service accepts. */
export declare enum KnownModes {
/** Audit */
Audit = "Audit",
/** Enforce */
Enforce = "Enforce",
/** Disabled */
Disabled = "Disabled"
}
/**
* Defines values for Modes. \
* {@link KnownModes} can be used interchangeably with Modes,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **Audit** \
* **Enforce** \
* **Disabled**
*/
export type Modes = string;
/** Known values of {@link VirtualMachinePriorityTypes} that the service accepts. */
export declare enum KnownVirtualMachinePriorityTypes {
/** Regular */
Regular = "Regular",
/** Low */
Low = "Low",
/** Spot */
Spot = "Spot"
}
/**
* Defines values for VirtualMachinePriorityTypes. \
* {@link KnownVirtualMachinePriorityTypes} can be used interchangeably with VirtualMachinePriorityTypes,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **Regular** \
* **Low** \
* **Spot**
*/
export type VirtualMachinePriorityTypes = string;
/** Known values of {@link VirtualMachineEvictionPolicyTypes} that the service accepts. */
export declare enum KnownVirtualMachineEvictionPolicyTypes {
/** Deallocate */
Deallocate = "Deallocate",
/** Delete */
Delete = "Delete"
}
/**
* Defines values for VirtualMachineEvictionPolicyTypes. \
* {@link KnownVirtualMachineEvictionPolicyTypes} can be used interchangeably with VirtualMachineEvictionPolicyTypes,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **Deallocate** \
* **Delete**
*/
export type VirtualMachineEvictionPolicyTypes = string;
/** Known values of {@link VirtualMachineScaleSetScaleInRules} that the service accepts. */
export declare enum KnownVirtualMachineScaleSetScaleInRules {
/** Default */
Default = "Default",
/** OldestVM */
OldestVM = "OldestVM",
/** NewestVM */
NewestVM = "NewestVM"
}
/**
* Defines values for VirtualMachineScaleSetScaleInRules. \
* {@link KnownVirtualMachineScaleSetScaleInRules} can be used interchangeably with VirtualMachineScaleSetScaleInRules,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **Default** \
* **OldestVM** \
* **NewestVM**
*/
export type VirtualMachineScaleSetScaleInRules = string;
/** Known values of {@link OrchestrationMode} that the service accepts. */
export declare enum KnownOrchestrationMode {
/** Uniform */
Uniform = "Uniform",
/** Flexible */
Flexible = "Flexible"
}
/**
* Defines values for OrchestrationMode. \
* {@link KnownOrchestrationMode} can be used interchangeably with OrchestrationMode,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **Uniform** \
* **Flexible**
*/
export type OrchestrationMode = string;
/** Known values of {@link RebalanceStrategy} that the service accepts. */
export declare enum KnownRebalanceStrategy {
/** Recreate */
Recreate = "Recreate"
}
/**
* Defines values for RebalanceStrategy. \
* {@link KnownRebalanceStrategy} can be used interchangeably with RebalanceStrategy,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **Recreate**
*/
export type RebalanceStrategy = string;
/** Known values of {@link RebalanceBehavior} that the service accepts. */
export declare enum KnownRebalanceBehavior {
/** CreateBeforeDelete */
CreateBeforeDelete = "CreateBeforeDelete"
}
/**
* Defines values for RebalanceBehavior. \
* {@link KnownRebalanceBehavior} can be used interchangeably with RebalanceBehavior,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **CreateBeforeDelete**
*/
export type RebalanceBehavior = string;
/** Known values of {@link ZonalPlatformFaultDomainAlignMode} that the service accepts. */
export declare enum KnownZonalPlatformFaultDomainAlignMode {
/** Aligned */
Aligned = "Aligned",
/** Unaligned */
Unaligned = "Unaligned"
}
/**
* Defines values for ZonalPlatformFaultDomainAlignMode. \
* {@link KnownZonalPlatformFaultDomainAlignMode} can be used interchangeably with ZonalPlatformFaultDomainAlignMode,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **Aligned** \
* **Unaligned**
*/
export type ZonalPlatformFaultDomainAlignMode = string;
/** Known values of {@link AllocationStrategy} that the service accepts. */
export declare enum KnownAllocationStrategy {
/** LowestPrice */
LowestPrice = "LowestPrice",
/** CapacityOptimized */
CapacityOptimized = "CapacityOptimized",
/** Prioritized */
Prioritized = "Prioritized"
}
/**
* Defines values for AllocationStrategy. \
* {@link KnownAllocationStrategy} can be used interchangeably with AllocationStrategy,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **LowestPrice** \
* **CapacityOptimized** \
* **Prioritized**
*/
export type AllocationStrategy = string;
/** Known values of {@link HighSpeedInterconnectPlacement} that the service accepts. */
export declare enum KnownHighSpeedInterconnectPlacement {
/** No high speed interconnect placement */
None = "None",
/** Trunk high speed interconnect placement */
Trunk = "Trunk"
}
/**
* Defines values for HighSpeedInterconnectPlacement. \
* {@link KnownHighSpeedInterconnectPlacement} can be used interchangeably with HighSpeedInterconnectPlacement,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **None**: No high speed interconnect placement \
* **Trunk**: Trunk high speed interconnect placement
*/
export type HighSpeedInterconnectPlacement = string;
/** Known values of {@link ZonePlacementPolicyType} that the service accepts. */
export declare enum KnownZonePlacementPolicyType {
/** Any */
Any = "Any",
/** Automatic zone placement in a Virtual Machine Scale Set. */
Auto = "Auto"
}
/**
* Defines values for ZonePlacementPolicyType. \
* {@link KnownZonePlacementPolicyType} can be used interchangeably with ZonePlacementPolicyType,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **Any** \
* **Auto**: Automatic zone placement in a Virtual Machine Scale Set.
*/
export type ZonePlacementPolicyType = string;
/** Known values of {@link VirtualMachineSizeTypes} that the service accepts. */
export declare enum KnownVirtualMachineSizeTypes {
/** BasicA0 */
BasicA0 = "Basic_A0",
/** BasicA1 */
BasicA1 = "Basic_A1",
/** BasicA2 */
BasicA2 = "Basic_A2",
/** BasicA3 */
BasicA3 = "Basic_A3",
/** BasicA4 */
BasicA4 = "Basic_A4",
/** StandardA0 */
StandardA0 = "Standard_A0",
/** StandardA1 */
StandardA1 = "Standard_A1",
/** StandardA2 */
StandardA2 = "Standard_A2",
/** StandardA3 */
StandardA3 = "Standard_A3",
/** StandardA4 */
StandardA4 = "Standard_A4",
/** StandardA5 */
StandardA5 = "Standard_A5",
/** StandardA6 */
StandardA6 = "Standard_A6",
/** StandardA7 */
StandardA7 = "Standard_A7",
/** StandardA8 */
StandardA8 = "Standard_A8",
/** StandardA9 */
StandardA9 = "Standard_A9",
/** StandardA10 */
StandardA10 = "Standard_A10",
/** StandardA11 */
StandardA11 = "Standard_A11",
/** StandardA1V2 */
StandardA1V2 = "Standard_A1_v2",
/** StandardA2V2 */
StandardA2V2 = "Standard_A2_v2",
/** StandardA4V2 */
StandardA4V2 = "Standard_A4_v2",
/** StandardA8V2 */
StandardA8V2 = "Standard_A8_v2",
/** StandardA2MV2 */
StandardA2MV2 = "Standard_A2m_v2",
/** StandardA4MV2 */
StandardA4MV2 = "Standard_A4m_v2",
/** StandardA8MV2 */
StandardA8MV2 = "Standard_A8m_v2",
/** StandardB1S */
StandardB1S = "Standard_B1s",
/** StandardB1Ms */
StandardB1Ms = "Standard_B1ms",
/** StandardB2S */
StandardB2S = "Standard_B2s",
/** StandardB2Ms */
StandardB2Ms = "Standard_B2ms",
/** StandardB4Ms */
StandardB4Ms = "Standard_B4ms",
/** StandardB8Ms */
StandardB8Ms = "Standard_B8ms",
/** StandardD1 */
StandardD1 = "Standard_D1",
/** StandardD2 */
StandardD2 = "Standard_D2",
/** StandardD3 */
StandardD3 = "Standard_D3",
/** StandardD4 */
StandardD4 = "Standard_D4",
/** StandardD11 */
StandardD11 = "Standard_D11",
/** StandardD12 */
StandardD12 = "Standard_D12",
/** StandardD13 */
StandardD13 = "Standard_D13",
/** StandardD14 */
StandardD14 = "Standard_D14",
/** StandardD1V2 */
StandardD1V2 = "Standard_D1_v2",
/** StandardD2V2 */
StandardD2V2 = "Standard_D2_v2",
/** StandardD3V2 */
StandardD3V2 = "Standard_D3_v2",
/** StandardD4V2 */
StandardD4V2 = "Standard_D4_v2",
/** StandardD5V2 */
StandardD5V2 = "Standard_D5_v2",
/** StandardD2V3 */
StandardD2V3 = "Standard_D2_v3",
/** StandardD4V3 */
StandardD4V3 = "Standard_D4_v3",
/** StandardD8V3 */
StandardD8V3 = "Standard_D8_v3",
/** StandardD16V3 */
StandardD16V3 = "Standard_D16_v3",
/** StandardD32V3 */
StandardD32V3 = "Standard_D32_v3",
/** StandardD64V3 */
StandardD64V3 = "Standard_D64_v3",
/** StandardD2SV3 */
StandardD2SV3 = "Standard_D2s_v3",
/** StandardD4SV3 */
StandardD4SV3 = "Standard_D4s_v3",
/** StandardD8SV3 */
StandardD8SV3 = "Standard_D8s_v3",
/** StandardD16SV3 */
StandardD16SV3 = "Standard_D16s_v3",
/** StandardD32SV3 */
StandardD32SV3 = "Standard_D32s_v3",
/** StandardD64SV3 */
StandardD64SV3 = "Standard_D64s_v3",
/** StandardD11V2 */
StandardD11V2 = "Standard_D11_v2",
/** StandardD12V2 */
StandardD12V2 = "Standard_D12_v2",
/** StandardD13V2 */
StandardD13V2 = "Standard_D13_v2",
/** StandardD14V2 */
StandardD14V2 = "Standard_D14_v2",
/** StandardD15V2 */
StandardD15V2 = "Standard_D15_v2",
/** StandardDS1 */
StandardDS1 = "Standard_DS1",
/** StandardDS2 */
StandardDS2 = "Standard_DS2",
/** StandardDS3 */
StandardDS3 = "Standard_DS3",
/** StandardDS4 */
StandardDS4 = "Standard_DS4",
/** StandardDS11 */
StandardDS11 = "Standard_DS11",
/** StandardDS12 */
StandardDS12 = "Standard_DS12",
/** StandardDS13 */
StandardDS13 = "Standard_DS13",
/** StandardDS14 */
StandardDS14 = "Standard_DS14",
/** StandardDS1V2 */
StandardDS1V2 = "Standard_DS1_v2",
/** StandardDS2V2 */
StandardDS2V2 = "Standard_DS2_v2",
/** StandardDS3V2 */
StandardDS3V2 = "Standard_DS3_v2",
/** StandardDS4V2 */
StandardDS4V2 = "Standard_DS4_v2",
/** StandardDS5V2 */
StandardDS5V2 = "Standard_DS5_v2",
/** StandardDS11V2 */
StandardDS11V2 = "Standard_DS11_v2",
/** StandardDS12V2 */
StandardDS12V2 = "Standard_DS12_v2",
/** StandardDS13V2 */
StandardDS13V2 = "Standard_DS13_v2",
/** StandardDS14V2 */
StandardDS14V2 = "Standard_DS14_v2",
/** StandardDS15V2 */
StandardDS15V2 = "Standard_DS15_v2",
/** StandardDS134V2 */
StandardDS134V2 = "Standard_DS13-4_v2",
/** StandardDS132V2 */
StandardDS132V2 = "Standard_DS13-2_v2",
/** StandardDS148V2 */
StandardDS148V2 = "Standard_DS14-8_v2",
/** StandardDS144V2 */
StandardDS144V2 = "Standard_DS14-4_v2",
/** StandardE2V3 */
StandardE2V3 = "Standard_E2_v3",
/** StandardE4V3 */
StandardE4V3 = "Standard_E4_v3",
/** StandardE8V3 */
StandardE8V3 = "Standard_E8_v3",
/** StandardE16V3 */
StandardE16V3 = "Standard_E16_v3",
/** StandardE32V3 */
StandardE32V3 = "Standard_E32_v3",
/** StandardE64V3 */
StandardE64V3 = "Standard_E64_v3",
/** StandardE2SV3 */
StandardE2SV3 = "Standard_E2s_v3",
/** StandardE4SV3 */
StandardE4SV3 = "Standard_E4s_v3",
/** StandardE8SV3 */
StandardE8SV3 = "Standard_E8s_v3",
/** StandardE16SV3 */
StandardE16SV3 = "Standard_E16s_v3",
/** StandardE32SV3 */
StandardE32SV3 = "Standard_E32s_v3",
/** StandardE64SV3 */
StandardE64SV3 = "Standard_E64s_v3",
/** StandardE3216V3 */
StandardE3216V3 = "Standard_E32-16_v3",
/** StandardE328SV3 */
StandardE328SV3 = "Standard_E32-8s_v3",
/** StandardE6432SV3 */
StandardE6432SV3 = "Standard_E64-32s_v3",
/** StandardE6416SV3 */
StandardE6416SV3 = "Standard_E64-16s_v3",
/** StandardF1 */
StandardF1 = "Standard_F1",
/** StandardF2 */
StandardF2 = "Standard_F2",
/** StandardF4 */
StandardF4 = "Standard_F4",
/** StandardF8 */
StandardF8 = "Standard_F8",
/** StandardF16 */
StandardF16 = "Standard_F16",
/** StandardF1S */
StandardF1S = "Standard_F1s",
/** StandardF2S */
StandardF2S = "Standard_F2s",
/** StandardF4S */
StandardF4S = "Standard_F4s",
/** StandardF8S */
StandardF8S = "Standard_F8s",
/** StandardF16S */
StandardF16S = "Standard_F16s",
/** StandardF2SV2 */
StandardF2SV2 = "Standard_F2s_v2",
/** StandardF4SV2 */
StandardF4SV2 = "Standard_F4s_v2",
/** StandardF8SV2 */
StandardF8SV2 = "Standard_F8s_v2",
/** StandardF16SV2 */
StandardF16SV2 = "Standard_F16s_v2",
/** StandardF32SV2 */
StandardF32SV2 = "Standard_F32s_v2",
/** StandardF64SV2 */
StandardF64SV2 = "Standard_F64s_v2",
/** StandardF72SV2 */
StandardF72SV2 = "Standard_F72s_v2",
/** StandardG1 */
StandardG1 = "Standard_G1",
/** StandardG2 */
StandardG2 = "Standard_G2",
/** StandardG3 */
StandardG3 = "Standard_G3",
/** StandardG4 */
StandardG4 = "Standard_G4",
/** StandardG5 */
StandardG5 = "Standard_G5",
/** StandardGS1 */
StandardGS1 = "Standard_GS1",
/** StandardGS2 */
StandardGS2 = "Standard_GS2",
/** StandardGS3 */
StandardGS3 = "Standard_GS3",
/** StandardGS4 */
StandardGS4 = "Standard_GS4",
/** StandardGS5 */
StandardGS5 = "Standard_GS5",
/** StandardGS48 */
StandardGS48 = "Standard_GS4-8",
/** StandardGS44 */
StandardGS44 = "Standard_GS4-4",
/** StandardGS516 */
StandardGS516 = "Standard_GS5-16",
/** StandardGS58 */
StandardGS58 = "Standard_GS5-8",
/** StandardH8 */
StandardH8 = "Standard_H8",
/** StandardH16 */
StandardH16 = "Standard_H16",
/** StandardH8M */
StandardH8M = "Standard_H8m",
/** StandardH16M */
StandardH16M = "Standard_H16m",
/** StandardH16R */
StandardH16R = "Standard_H16r",
/** StandardH16Mr */
StandardH16Mr = "Standard_H16mr",
/** StandardL4S */
StandardL4S = "Standard_L4s",
/** StandardL8S */
StandardL8S = "Standard_L8s",
/** StandardL16S */
StandardL16S = "Standard_L16s",
/** StandardL32S */
StandardL32S = "Standard_L32s",
/** StandardM64S */
StandardM64S = "Standard_M64s",
/** StandardM64Ms */
StandardM64Ms = "Standard_M64ms",
/** StandardM128S */
StandardM128S = "Standard_M128s",
/** StandardM128Ms */
StandardM128Ms = "Standard_M128ms",
/** StandardM6432Ms */
StandardM6432Ms = "Standard_M64-32ms",
/** StandardM6416Ms */
StandardM6416Ms = "Standard_M64-16ms",
/** StandardM12864Ms */
StandardM12864Ms = "Standard_M128-64ms",
/** StandardM12832Ms */
StandardM12832Ms = "Standard_M128-32ms",
/** StandardNC6 */
StandardNC6 = "Standard_NC6",
/** StandardNC12 */
StandardNC12 = "Standard_NC12",
/** StandardNC24 */
StandardNC24 = "Standard_NC24",
/** StandardNC24R */
StandardNC24R = "Standard_NC24r",
/** StandardNC6SV2 */
StandardNC6SV2 = "Standard_NC6s_v2",
/** StandardNC12SV2 */
StandardNC12SV2 = "Standard_NC12s_v2",
/** StandardNC24SV2 */
StandardNC24SV2 = "Standard_NC24s_v2",
/** StandardNC24RsV2 */
StandardNC24RsV2 = "Standard_NC24rs_v2",
/** StandardNC6SV3 */
StandardNC6SV3 = "Standard_NC6s_v3",
/** StandardNC12SV3 */
StandardNC12SV3 = "Standard_NC12s_v3",
/** StandardNC24SV3 */
StandardNC24SV3 = "Standard_NC24s_v3",
/** StandardNC24RsV3 */
StandardNC24RsV3 = "Standard_NC24rs_v3",
/** StandardND6S */
StandardND6S = "Standard_ND6s",
/** StandardND12S */
StandardND12S = "Standard_ND12s",
/** StandardND24S */
StandardND24S = "Standard_ND24s",
/** StandardND24Rs */
StandardND24Rs = "Standard_ND24rs",
/** StandardNV6 */
StandardNV6 = "Standard_NV6",
/** StandardNV12 */
StandardNV12 = "Standard_NV12",
/** StandardNV24 */
StandardNV24 = "Standard_NV24"
}
/**
* Defines values for VirtualMachineSizeTypes. \
* {@link KnownVirtualMachineSizeTypes} can be used interchangeably with VirtualMachineSizeTypes,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **Basic_A0** \
* **Basic_A1** \
* **Basic_A2** \
* **Basic_A3** \
* **Basic_A4** \
* **Standard_A0** \
* **Standard_A1** \
* **Standard_A2** \
* **Standard_A3** \
* **Standard_A4** \
* **Standard_A5** \
* **Standard_A6** \
* **Standard_A7** \
* **Standard_A8** \
* **Standard_A9** \
* **Standard_A10** \
* **Standard_A11** \
* **Standard_A1_v2** \
* **Standard_A2_v2** \
* **Standard_A4_v2** \
* **Standard_A8_v2** \
* **Standard_A2m_v2** \
* **Standard_A4m_v2** \
* **Standard_A8m_v2** \
* **Standard_B1s** \
* **Standard_B1ms** \
* **Standard_B2s** \
* **Standard_B2ms** \
* **Standard_B4ms** \
* **Standard_B8ms** \
* **Standard_D1** \
* **Standard_D2** \
* **Standard_D3** \
* **Standard_D4** \
* **Standard_D11** \
* **Standard_D12** \
* **Standard_D13** \
* **Standard_D14** \
* **Standard_D1_v2** \
* **Standard_D2_v2** \
* **Standard_D3_v2** \
* **Standard_D4_v2** \
* **Standard_D5_v2** \
* **Standard_D2_v3** \
* **Standard_D4_v3** \
* **Standard_D8_v3** \
* **Standard_D16_v3** \
* **Standard_D32_v3** \
* **Standard_D64_v3** \
* **Standard_D2s_v3** \
* **Standard_D4s_v3** \
* **Standard_D8s_v3** \
* **Standard_D16s_v3** \
* **Standard_D32s_v3** \
* **Standard_D64s_v3** \
* **Standard_D11_v2** \
* **Standard_D12_v2** \
* **Standard_D13_v2** \
* **Standard_D14_v2** \
* **Standard_D15_v2** \
* **Standard_DS1** \
* **Standard_DS2** \
* **Standard_DS3** \
* **Standard_DS4** \
* **Standard_DS11** \
* **Standard_DS12** \
* **Standard_DS13** \
* **Standard_DS14** \
* **Standard_DS1_v2** \
* **Standard_DS2_v2** \
* **Standard_DS3_v2** \
* **Standard_DS4_v2** \
* **Standard_DS5_v2** \
* **Standard_DS11_v2** \
* **Standard_DS12_v2** \
* **Standard_DS13_v2** \
* **Standard_DS14_v2** \
* **Standard_DS15_v2** \
* **Standard_DS13-4_v2** \
* **Standard_DS13-2_v2** \
* **Standard_DS14-8_v2** \
* **Standard_DS14-4_v2** \
* **Standard_E2_v3** \
* **Standard_E4_v3** \
* **Standard_E8_v3** \
* **Standard_E16_v3** \
* **Standard_E32_v3** \
* **Standard_E64_v3** \
* **Standard_E2s_v3** \
* **Standard_E4s_v3** \
* **Standard_E8s_v3** \
* **Standard_E16s_v3** \
* **Standard_E32s_v3** \
* **Standard_E64s_v3** \
* **Standard_E32-16_v3** \
* **Standard_E32-8s_v3** \
* **Standard_E64-32s_v3** \
* **Standard_E64-16s_v3** \
* **Standard_F1** \
* **Standard_F2** \
* **Standard_F4** \
* **Standard_F8** \
* **Standard_F16** \
* **Standard_F1s** \
* **Standard_F2s** \
* **Standard_F4s** \
* **Standard_F8s** \
* **Standard_F16s** \
* **Standard_F2s_v2** \
* **Standard_F4s_v2** \
* **Standard_F8s_v2** \
* **Standard_F16s_v2** \
* **Standard_F32s_v2** \
* **Standard_F64s_v2** \
* **Standard_F72s_v2** \
* **Standard_G1** \
* **Standard_G2** \
* **Standard_G3** \
* **Standard_G4** \
* **Standard_G5** \
* **Standard_GS1** \
* **Standard_GS2** \
* **Standard_GS3** \
* **Standard_GS4** \
* **Standard_GS5** \
* **Standard_GS4-8** \
* **Standard_GS4-4** \
* **Standard_GS5-16** \
* **Standard_GS5-8** \
* **Standard_H8** \
* **Standard_H16** \
* **Standard_H8m** \
* **Standard_H16m** \
* **Standard_H16r** \
* **Standard_H16mr** \
* **Standard_L4s** \
* **Standard_L8s** \
* **Standard_L16s** \
* **Standard_L32s** \
* **Standard_M64s** \
* **Standard_M64ms** \
* **Standard_M128s** \
* **Standard_M128ms** \
* **Standard_M64-32ms** \
* **Standard_M64-16ms** \
* **Standard_M128-64ms** \
* **Standard_M128-32ms** \
* **Standard_NC6** \
* **Standard_NC12** \
* **Standard_NC24** \
* **Standard_NC24r** \
* **Standard_NC6s_v2** \
* **Standard_NC12s_v2** \
* **Standard_NC24s_v2** \
* **Standard_NC24rs_v2** \
* **Standard_NC6s_v3** \
* **Standard_NC12s_v3** \
* **Standard_NC24s_v3** \
* **Standard_NC24rs_v3** \
* **Standard_ND6s** \
* **Standard_ND12s** \
* **Standard_ND24s** \
* **Standard_ND24rs** \
* **Standard_NV6** \
* **Standard_NV12** \
* **Standard_NV24**
*/
export type VirtualMachineSizeTypes = string;
/** Known values of {@link DiskDetachOptionTypes} that the service accepts. */
export declare enum KnownDiskDetachOptionTypes {
/** ForceDetach */
ForceDetach = "ForceDetach"
}
/**
* Defines values for DiskDetachOptionTypes. \
* {@link KnownDiskDetachOptionTypes} can be used interchangeably with DiskDetachOptionTypes,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **ForceDetach**
*/
export type DiskDetachOptionTypes = string;
/** Known values of {@link IPVersions} that the service accepts. */
export declare enum KnownIPVersions {
/** IPv4 */
IPv4 = "IPv4",
/** IPv6 */
IPv6 = "IPv6"
}
/**
* Defines values for IPVersions. \
* {@link KnownIPVersions} can be used interchangeably with IPVersions,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **IPv4** \
* **IPv6**
*/
export type IPVersions = string;
/** Known values of {@link PublicIPAllocationMethod} that the service accepts. */
export declare enum KnownPublicIPAllocationMethod {
/** Dynamic */
Dynamic = "Dynamic",
/** Static */
Static = "Static"
}
/**
* Defines values for PublicIPAllocationMethod. \
* {@link KnownPublicIPAllocationMethod} can be used interchangeably with PublicIPAllocationMethod,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **Dynamic** \
* **Static**
*/
export type PublicIPAllocationMethod = string;
/** Known values of {@link HyperVGenerationType} that the service accepts. */
export declare enum KnownHyperVGenerationType {
/** V1 */
V1 = "V1",
/** V2 */
V2 = "V2"
}
/**
* Defines values for HyperVGenerationType. \
* {@link KnownHyperVGenerationType} can be used interchangeably with HyperVGenerationType,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **V1** \
* **V2**
*/
export type HyperVGenerationType = string;
/** Known values of {@link PatchOperationStatus} that the service accepts. */
export declare enum KnownPatchOperationStatus {
/** Unknown */
Unknown = "Unknown",
/** InProgress */
InProgress = "InProgress",
/** Failed */
Failed = "Failed",
/** Succeeded */
Succeeded = "Succeeded",
/** CompletedWithWarnings */
CompletedWithWarnings = "CompletedWithWarnings"
}
/**
* Defines values for PatchOperationStatus. \
* {@link KnownPatchOperationStatus} can be used interchangeably with PatchOperationStatus,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **Unknown** \
* **InProgress** \
* **Failed** \
* **Succeeded** \
* **CompletedWithWarnings**
*/
export type PatchOperationStatus = string;
/** Known values of {@link ProximityPlacementGroupType} that the service accepts. */
export declare enum KnownProximityPlacementGroupType {
/** Standard */
Standard = "Standard",
/** Ultra */
Ultra = "Ultra"
}
/**
* Defines values for ProximityPlacementGroupType. \
* {@link KnownProximityPlacementGroupType} can be used interchangeably with ProximityPlacementGroupType,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **Standard** \
* **Ultra**
*/
export type ProximityPlacementGroupType = string;
/** Known values of {@link OperatingSystemType} that the service accepts. */
export declare enum KnownOperatingSystemType {
/** Windows */
Windows = "Windows",
/** Linux */
Linux = "Linux"
}
/**
* Defines values for OperatingSystemType. \
* {@link KnownOperatingSystemType} can be used interchangeably with OperatingSystemType,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **Windows** \
* **Linux**
*/
export type OperatingSystemType = string;
/** Known values of {@link RestorePointEncryptionType} that the service accepts. */
export declare enum KnownRestorePointEncryptionType {
/** Disk Restore Point is encrypted at rest with Platform managed key. */
EncryptionAtRestWithPlatformKey = "EncryptionAtRestWithPlatformKey",
/** Disk Restore Point is encrypted at rest with Customer managed key that can be changed and revoked by a customer. */
EncryptionAtRestWithCustomerKey = "EncryptionAtRestWithCustomerKey",
/** Disk Restore Point is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed. */
EncryptionAtRestWithPlatformAndCustomerKeys = "EncryptionAtRestWithPlatformAndCustomerKeys"
}
/**
* Defines values for RestorePointEncryptionType. \
* {@link KnownRestorePointEncryptionType} can be used interchangeably with RestorePointEncryptionType,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **EncryptionAtRestWithPlatformKey**: Disk Restore Point is encrypted at rest with Platform managed key. \
* **EncryptionAtRestWithCustomerKey**: Disk Restore Point is encrypted at rest with Customer managed key that can be changed and revoked by a customer. \
* **EncryptionAtRestWithPlatformAndCustomerKeys**: Disk Restore Point is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed.
*/
export type RestorePointEncryptionType = string;
/** Known values of {@link ConsistencyModeTypes} that the service accepts. */
export declare enum KnownConsistencyModeTypes {
/** CrashConsistent */
CrashConsistent = "CrashConsistent",
/** FileSystemConsistent */
FileSystemConsistent = "FileSystemConsistent",
/** ApplicationConsistent */
ApplicationConsistent = "ApplicationConsistent"
}
/**
* Defines values for ConsistencyModeTypes. \
* {@link KnownConsistencyModeTypes} can be used interchangeably with ConsistencyModeTypes,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **CrashConsistent** \
* **FileSystemConsistent** \
* **ApplicationConsistent**
*/
export type ConsistencyModeTypes = string;
/** Known values of {@link SnapshotAccessState} that the service accepts. */
export declare enum KnownSnapshotAccessState {
/** Default value. */
Unknown = "Unknown",
/** The snapshot cannot be used for restore, copy or download to offline. */
Pending = "Pending",
/** The snapshot can be used for restore, copy to different region, and download to offline. */
Available = "Available",
/** The snapshot can be used for restoring disks with fast performance but cannot be copied or downloaded. */
InstantAccess = "InstantAccess",
/** The snapshot can be used for restoring disks with fast performance, copied and downloaded. */
AvailableWithInstantAccess = "AvailableWithInstantAccess"
}
/**
* Defines values for SnapshotAccessState. \
* {@link KnownSnapshotAccessState} can be used interchangeably with SnapshotAccessState,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **Unknown**: Default value. \
* **Pending**: The snapshot cannot be used for restore, copy or download to offline. \
* **Available**: The snapshot can be used for restore, copy to different region, and download to offline. \
* **InstantAccess**: The snapshot can be used for restoring disks with fast performance but cannot be copied or downloaded. \
* **AvailableWithInstantAccess**: The snapshot can be used for restoring disks with fast performance, copied and downloaded.
*/
export type SnapshotAccessState = string;
/** Known values of {@link ExpandTypesForListVMs} that the service accepts. */
export declare enum KnownExpandTypesForListVMs {
/** InstanceView */
InstanceView = "instanceView"
}
/**
* Defines values for ExpandTypesForListVMs. \
* {@link KnownExpandTypesForListVMs} can be used interchangeably with ExpandTypesForListVMs,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **instanceView**
*/
export type ExpandTypesForListVMs = string;
/** Known values of {@link CapacityReservationGroupInstanceViewTypes} that the service accepts. */
export declare enum KnownCapacityReservationGroupInstanceViewTypes {
/** InstanceView */
InstanceView = "instanceView"
}
/**
* Defines values for CapacityReservationGroupInstanceViewTypes. \
* {@link KnownCapacityReservationGroupInstanceViewTypes} can be used interchangeably with CapacityReservationGroupInstanceViewTypes,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **instanceView**
*/
export type CapacityReservationGroupInstanceViewTypes = string;
/** Known values of {@link CapacityReservationInstanceViewTypes} that the service accepts. */
export declare enum KnownCapacityReservationInstanceViewTypes {
/** InstanceView */
InstanceView = "instanceView"
}
/**
* Defines values for CapacityReservationInstanceViewTypes. \
* {@link KnownCapacityReservationInstanceViewTypes} can be used interchangeably with CapacityReservationInstanceViewTypes,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **instanceView**
*/
export type CapacityReservationInstanceViewTypes = string;
/** Known values of {@link RestorePointCollectionExpandOptions} that the service accepts. */
export declare enum KnownRestorePointCollectionExpandOptions {
/** RestorePoints */
RestorePoints = "restorePoints"
}
/**
* Defines values for RestorePointCollectionExpandOptions. \
* {@link KnownRestorePointCollectionExpandOptions} can be used interchangeably with RestorePointCollectionExpandOptions,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **restorePoints**
*/
export type RestorePointCollectionExpandOptions = string;
/** Known values of {@link RestorePointExpandOptions} that the service accepts. */
export declare enum KnownRestorePointExpandOptions {
/** InstanceView */
InstanceView = "instanceView"
}
/**
* Defines values for RestorePointExpandOptions. \
* {@link KnownRestorePointExpandOptions} can be used interchangeably with RestorePointExpandOptions,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **instanceView**
*/
export type RestorePointExpandOptions = string;
/** Known values of {@link SshEncryptionTypes} that the service accepts. */
export declare enum KnownSshEncryptionTypes {
/** RSA */
RSA = "RSA",
/** Ed25519 */
Ed25519 = "Ed25519"
}
/**
* Defines values for SshEncryptionTypes. \
* {@link KnownSshEncryptionTypes} can be used interchangeably with SshEncryptionTypes,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **RSA** \
* **Ed25519**
*/
export type SshEncryptionTypes = string;
/** Known values of {@link ExpandTypesForGetVMScaleSets} that the service accepts. */
export declare enum KnownExpandTypesForGetVMScaleSets {
/** UserData */
UserData = "userData"
}
/**
* Defines values for ExpandTypesForGetVMScaleSets. \
* {@link KnownExpandTypesForGetVMScaleSets} can be used interchangeably with ExpandTypesForGetVMScaleSets,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **userData**
*/
export type ExpandTypesForGetVMScaleSets = string;
/** Known values of {@link OrchestrationServiceNames} that the service accepts. */
export declare enum KnownOrchestrationServiceNames {
/** AutomaticRepairs */
AutomaticRepairs = "AutomaticRepairs",
/** AutomaticZoneRebalancing orchestration service. */
AutomaticZoneRebalancing = "AutomaticZoneRebalancing"
}
/**
* Defines values for OrchestrationServiceNames. \
* {@link KnownOrchestrationServiceNames} can be used interchangeably with OrchestrationServiceNames,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **AutomaticRepairs** \
* **AutomaticZoneRebalancing**: AutomaticZoneRebalancing orchestration service.
*/
export type OrchestrationServiceNames = string;
/** Known values of {@link OrchestrationServiceState} that the service accepts. */
export declare enum KnownOrchestrationServiceState {
/** NotRunning */
NotRunning = "NotRunning",
/** Running */
Running = "Running",
/** Suspended */
Suspended = "Suspended"
}
/**
* Defines values for OrchestrationServiceState. \
* {@link KnownOrchestrationServiceState} can be used interchangeably with OrchestrationServiceState,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **NotRunning** \
* **Running** \
* **Suspended**
*/
export type OrchestrationServiceState = string;
/** Known values of {@link OrchestrationServiceOperationStatus} that the service accepts. */
export declare enum KnownOrchestrationServiceOperationStatus {
/** InProgress orchestration service operation status. */
InProgress = "InProgress",
/** Completed orchestration service operation status. */
Completed = "Completed"
}
/**
* Defines values for OrchestrationServiceOperationStatus. \
* {@link KnownOrchestrationServiceOperationStatus} can be used interchangeably with OrchestrationServiceOperationStatus,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **InProgress**: InProgress orchestration service operation status. \
* **Completed**: Completed orchestration service operation status.
*/
export type OrchestrationServiceOperationStatus = string;
/** Known values of {@link OrchestrationServiceStateAction} that the service accepts. */
export declare enum KnownOrchestrationServiceStateAction {
/** Resume */
Resume = "Resume",
/** Suspend */
Suspend = "Suspend"
}
/**
* Defines values for OrchestrationServiceStateAction. \
* {@link KnownOrchestrationServiceStateAction} can be used interchangeably with OrchestrationServiceStateAction,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **Resume** \
* **Suspend**
*/
export type OrchestrationServiceStateAction = string;
/** Known values of {@link HyperVGeneration} that the service accepts. */
export declare enum KnownHyperVGeneration {
/** V1 */
V1 = "V1",
/** V2 */
V2 = "V2"
}
/**
* Defines values for HyperVGeneration. \
* {@link KnownHyperVGeneration} can be used interchangeably with HyperVGeneration,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **V1** \
* **V2**
*/
export type HyperVGeneration = string;
/** Known values of {@link ResilientVMDeletionStatus} that the service accepts. */
export declare enum KnownResilientVMDeletionStatus {
/** Enabled */
Enabled = "Enabled",
/** Disabled */
Disabled = "Disabled",
/** InProgress */
InProgress = "InProgress",
/** Failed */
Failed = "Failed"
}
/**
* Defines values for ResilientVMDeletionStatus. \
* {@link KnownResilientVMDeletionStatus} can be used interchangeably with ResilientVMDeletionStatus,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **Enabled** \
* **Disabled** \
* **InProgress** \
* **Failed**
*/
export type ResilientVMDeletionStatus = string;
/** Known values of {@link ScriptShellTypes} that the service accepts. */
export declare enum KnownScriptShellTypes {
/** Default script shell type. */
Default = "Default",
/** Powershell7 script shell type. */
Powershell7 = "Powershell7"
}
/**
* Defines values for ScriptShellTypes. \
* {@link KnownScriptShellTypes} can be used interchangeably with ScriptShellTypes,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **Default**: Default script shell type. \
* **Powershell7**: Powershell7 script shell type.
*/
export type ScriptShellTypes = string;
/** Known values of {@link ExecutionState} that the service accepts. */
export declare enum KnownExecutionState {
/** Unknown */
Unknown = "Unknown",
/** Pending */
Pending = "Pending",
/** Running */
Running = "Running",
/** Failed */
Failed = "Failed",
/** Succeeded */
Succeeded = "Succeeded",
/** TimedOut */
TimedOut = "TimedOut",
/** Canceled */
Canceled = "Canceled"
}
/**
* Defines values for ExecutionState. \
* {@link KnownExecutionState} can be used interchangeably with ExecutionState,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **Unknown** \
* **Pending** \
* **Running** \
* **Failed** \
* **Succeeded** \
* **TimedOut** \
* **Canceled**
*/
export type ExecutionState = string;
/** Known values of {@link ExpandTypeForListVMs} that the service accepts. */
export declare enum KnownExpandTypeForListVMs {
/** InstanceView */
InstanceView = "instanceView"
}
/**
* Defines values for ExpandTypeForListVMs. \
* {@link KnownExpandTypeForListVMs} can be used interchangeably with ExpandTypeForListVMs,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **instanceView**
*/
export type ExpandTypeForListVMs = string;
/** Known values of {@link VMGuestPatchRebootBehavior} that the service accepts. */
export declare enum KnownVMGuestPatchRebootBehavior {
/** Unknown */
Unknown = "Unknown",
/** NeverReboots */
NeverReboots = "NeverReboots",
/** AlwaysRequiresReboot */
AlwaysRequiresReboot = "AlwaysRequiresReboot",
/** CanRequestReboot */
CanRequestReboot = "CanRequestReboot"
}
/**
* Defines values for VMGuestPatchRebootBehavior. \
* {@link KnownVMGuestPatchRebootBehavior} can be used interchangeably with VMGuestPatchRebootBehavior,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **Unknown** \
* **NeverReboots** \
* **AlwaysRequiresReboot** \
* **CanRequestReboot**
*/
export type VMGuestPatchRebootBehavior = string;
/** Known values of {@link PatchAssessmentState} that the service accepts. */
export declare enum KnownPatchAssessmentState {
/** Unknown */
Unknown = "Unknown",
/** Available */
Available = "Available"
}
/**
* Defines values for PatchAssessmentState. \
* {@link KnownPatchAssessmentState} can be used interchangeably with PatchAssessmentState,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **Unknown** \
* **Available**
*/
export type PatchAssessmentState = string;
/** Known values of {@link VMGuestPatchRebootSetting} that the service accepts. */
export declare enum KnownVMGuestPatchRebootSetting {
/** IfRequired */
IfRequired = "IfRequired",
/** Never */
Never = "Never",
/** Always */
Always = "Always"
}
/**
* Defines values for VMGuestPatchRebootSetting. \
* {@link KnownVMGuestPatchRebootSetting} can be used interchangeably with VMGuestPatchRebootSetting,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **IfRequired** \
* **Never** \
* **Always**
*/
export type VMGuestPatchRebootSetting = string;
/** Known values of {@link VMGuestPatchClassificationWindows} that the service accepts. */
export declare enum KnownVMGuestPatchClassificationWindows {
/** Critical */
Critical = "Critical",
/** Security */
Security = "Security",
/** UpdateRollUp */
UpdateRollUp = "UpdateRollUp",
/** FeaturePack */
FeaturePack = "FeaturePack",
/** ServicePack */
ServicePack = "ServicePack",
/** Definition */
Definition = "Definition",
/** Tools */
Tools = "Tools",
/** Updates */
Updates = "Updates"
}
/**
* Defines values for VMGuestPatchClassificationWindows. \
* {@link KnownVMGuestPatchClassificationWindows} can be used interchangeably with VMGuestPatchClassificationWindows,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **Critical** \
* **Security** \
* **UpdateRollUp** \
* **FeaturePack** \
* **ServicePack** \
* **Definition** \
* **Tools** \
* **Updates**
*/
export type VMGuestPatchClassificationWindows = string;
/** Known values of {@link VMGuestPatchClassificationLinux} that the service accepts. */
export declare enum KnownVMGuestPatchClassificationLinux {
/** Critical */
Critical = "Critical",
/** Security */
Security = "Security",
/** Other */
Other = "Other"
}
/**
* Defines values for VMGuestPatchClassificationLinux. \
* {@link KnownVMGuestPatchClassificationLinux} can be used interchangeably with VMGuestPatchClassificationLinux,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **Critical** \
* **Security** \
* **Other**
*/
export type VMGuestPatchClassificationLinux = string;
/** Known values of {@link VMGuestPatchRebootStatus} that the service accepts. */
export declare enum KnownVMGuestPatchRebootStatus {
/** Unknown */
Unknown = "Unknown",
/** NotNeeded */
NotNeeded = "NotNeeded",
/** Required */
Required = "Required",
/** Started */
Started = "Started",
/** Failed */
Failed = "Failed",
/** Completed */
Completed = "Completed"
}
/**
* Defines values for VMGuestPatchRebootStatus. \
* {@link KnownVMGuestPatchRebootStatus} can be used interchangeably with VMGuestPatchRebootStatus,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **Unknown** \
* **NotNeeded** \
* **Required** \
* **Started** \
* **Failed** \
* **Completed**
*/
export type VMGuestPatchRebootStatus = string;
/** Known values of {@link PatchInstallationState} that the service accepts. */
export declare enum KnownPatchInstallationState {
/** Unknown */
Unknown = "Unknown",
/** Installed */
Installed = "Installed",
/** Failed */
Failed = "Failed",
/** Excluded */
Excluded = "Excluded",
/** NotSelected */
NotSelected = "NotSelected",
/** Pending */
Pending = "Pending"
}
/**
* Defines values for PatchInstallationState. \
* {@link KnownPatchInstallationState} can be used interchangeably with PatchInstallationState,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **Unknown** \
* **Installed** \
* **Failed** \
* **Excluded** \
* **NotSelected** \
* **Pending**
*/
export type PatchInstallationState = string;
/** Known values of {@link PrivateEndpointServiceConnectionStatus} that the service accepts. */
export declare enum KnownPrivateEndpointServiceConnectionStatus {
/** Pending */
Pending = "Pending",
/** Approved */
Approved = "Approved",
/** Rejected */
Rejected = "Rejected"
}
/**
* Defines values for PrivateEndpointServiceConnectionStatus. \
* {@link KnownPrivateEndpointServiceConnectionStatus} can be used interchangeably with PrivateEndpointServiceConnectionStatus,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **Pending** \
* **Approved** \
* **Rejected**
*/
export type PrivateEndpointServiceConnectionStatus = string;
/** Known values of {@link PrivateEndpointConnectionProvisioningState} that the service accepts. */
export declare enum KnownPrivateEndpointConnectionProvisioningState {
/** Succeeded */
Succeeded = "Succeeded",
/** Creating */
Creating = "Creating",
/** Deleting */
Deleting = "Deleting",
/** Failed */
Failed = "Failed"
}
/**
* Defines values for PrivateEndpointConnectionProvisioningState. \
* {@link KnownPrivateEndpointConnectionProvisioningState} can be used interchangeably with PrivateEndpointConnectionProvisioningState,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **Succeeded** \
* **Creating** \
* **Deleting** \
* **Failed**
*/
export type PrivateEndpointConnectionProvisioningState = string;
/** Known values of {@link DiskEncryptionSetType} that the service accepts. */
export declare enum KnownDiskEncryptionSetType {
/** Resource using diskEncryptionSet would be encrypted at rest with Customer managed key that can be changed and revoked by a customer. */
EncryptionAtRestWithCustomerKey = "EncryptionAtRestWithCustomerKey",
/** Resource using diskEncryptionSet would be encrypted at rest with two layers of encryption. One of the keys is Customer managed and the other key is Platform managed. */
EncryptionAtRestWithPlatformAndCustomerKeys = "EncryptionAtRestWithPlatformAndCustomerKeys",
/** Confidential VM supported disk and VM guest state would be encrypted with customer managed key. */
ConfidentialVmEncryptedWithCustomerKey = "ConfidentialVmEncryptedWithCustomerKey"
}
/**
* Defines values for DiskEncryptionSetType. \
* {@link KnownDiskEncryptionSetType} can be used interchangeably with DiskEncryptionSetType,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **EncryptionAtRestWithCustomerKey**: Resource using diskEncryptionSet would be encrypted at rest with Customer managed key that can be changed and revoked by a customer. \
* **EncryptionAtRestWithPlatformAndCustomerKeys**: Resource using diskEncryptionSet would be encrypted at rest with two layers of encryption. One of the keys is Customer managed and the other key is Platform managed. \
* **ConfidentialVmEncryptedWithCustomerKey**: Confidential VM supported disk and VM guest state would be encrypted with customer managed key.
*/
export type DiskEncryptionSetType = string;
/** Known values of {@link DiskEncryptionSetIdentityType} that the service accepts. */
export declare enum KnownDiskEncryptionSetIdentityType {
/** SystemAssigned */
SystemAssigned = "SystemAssigned",
/** UserAssigned */
UserAssigned = "UserAssigned",
/** SystemAssignedUserAssigned */
SystemAssignedUserAssigned = "SystemAssigned, UserAssigned",
/** None */
None = "None"
}
/**
* Defines values for DiskEncryptionSetIdentityType. \
* {@link KnownDiskEncryptionSetIdentityType} can be used interchangeably with DiskEncryptionSetIdentityType,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **SystemAssigned** \
* **UserAssigned** \
* **SystemAssigned, UserAssigned** \
* **None**
*/
export type DiskEncryptionSetIdentityType = string;
/** Known values of {@link Architecture} that the service accepts. */
export declare enum KnownArchitecture {
/** X64 */
X64 = "x64",
/** Arm64 */
Arm64 = "Arm64"
}
/**
* Defines values for Architecture. \
* {@link KnownArchitecture} can be used interchangeably with Architecture,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **x64** \
* **Arm64**
*/
export type Architecture = string;
/** Known values of {@link SupportedSecurityOption} that the service accepts. */
export declare enum KnownSupportedSecurityOption {
/** The disk supports creating Trusted Launch VMs. */
TrustedLaunchSupported = "TrustedLaunchSupported",
/** The disk supports creating both Trusted Launch and Confidential VMs. */
TrustedLaunchAndConfidentialVMSupported = "TrustedLaunchAndConfidentialVMSupported"
}
/**
* Defines values for SupportedSecurityOption. \
* {@link KnownSupportedSecurityOption} can be used interchangeably with SupportedSecurityOption,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **TrustedLaunchSupported**: The disk supports creating Trusted Launch VMs. \
* **TrustedLaunchAndConfidentialVMSupported**: The disk supports creating both Trusted Launch and Confidential VMs.
*/
export type SupportedSecurityOption = string;
/** Known values of {@link DiskCreateOption} that the service accepts. */
export declare enum KnownDiskCreateOption {
/** Create an empty data disk of a size given by diskSizeGB. */
Empty = "Empty",
/** Disk will be attached to a VM. */
Attach = "Attach",
/** Create a new disk from a platform image specified by the given imageReference or galleryImageReference. */
FromImage = "FromImage",
/** Create a disk by importing from a blob specified by a sourceUri in a storage account specified by storageAccountId. */
Import = "Import",
/** Create a new disk or snapshot by copying from a disk or snapshot specified by the given sourceResourceId. */
Copy = "Copy",
/** Create a new disk by copying from a backup recovery point. */
Restore = "Restore",
/** Create a new disk by obtaining a write token and using it to directly upload the contents of the disk. */
Upload = "Upload",
/** Create a new disk by using a deep copy process, where the resource creation is considered complete only after all data has been copied from the source. */
CopyStart = "CopyStart",
/** Similar to Import create option. Create a new Trusted Launch VM or Confidential VM supported disk by importing additional blobs for VM guest state specified by securityDataUri and VM metadata specified by securityMetadataUri in storage account specified by storageAccountId. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. */
ImportSecure = "ImportSecure",
/** Similar to Upload create option. Create a new Trusted Launch VM or Confidential VM supported disk and upload using write token in disk, VM guest state and VM metadata. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. */
UploadPreparedSecure = "UploadPreparedSecure",
/** Create a new disk by exporting from elastic san volume snapshot */
CopyFromSanSnapshot = "CopyFromSanSnapshot"
}
/**
* Defines values for DiskCreateOption. \
* {@link KnownDiskCreateOption} can be used interchangeably with DiskCreateOption,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **Empty**: Create an empty data disk of a size given by diskSizeGB. \
* **Attach**: Disk will be attached to a VM. \
* **FromImage**: Create a new disk from a platform image specified by the given imageReference or galleryImageReference. \
* **Import**: Create a disk by importing from a blob specified by a sourceUri in a storage account specified by storageAccountId. \
* **Copy**: Create a new disk or snapshot by copying from a disk or snapshot specified by the given sourceResourceId. \
* **Restore**: Create a new disk by copying from a backup recovery point. \
* **Upload**: Create a new disk by obtaining a write token and using it to directly upload the contents of the disk. \
* **CopyStart**: Create a new disk by using a deep copy process, where the resource creation is considered complete only after all data has been copied from the source. \
* **ImportSecure**: Similar to Import create option. Create a new Trusted Launch VM or Confidential VM supported disk by importing additional blobs for VM guest state specified by securityDataUri and VM metadata specified by securityMetadataUri in storage account specified by storageAccountId. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. \
* **UploadPreparedSecure**: Similar to Upload create option. Create a new Trusted Launch VM or Confidential VM supported disk and upload using write token in disk, VM guest state and VM metadata. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. \
* **CopyFromSanSnapshot**: Create a new disk by exporting from elastic san volume snapshot
*/
export type DiskCreateOption = string;
/** Known values of {@link ProvisionedBandwidthCopyOption} that the service accepts. */
export declare enum KnownProvisionedBandwidthCopyOption {
/** None */
None = "None",
/** Enhanced */
Enhanced = "Enhanced"
}
/**
* Defines values for ProvisionedBandwidthCopyOption. \
* {@link KnownProvisionedBandwidthCopyOption} can be used interchangeably with ProvisionedBandwidthCopyOption,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **None** \
* **Enhanced**
*/
export type ProvisionedBandwidthCopyOption = string;
/** Known values of {@link DiskState} that the service accepts. */
export declare enum KnownDiskState {
/** The disk is not being used and can be attached to a VM. */
Unattached = "Unattached",
/** The disk is currently attached to a running VM. */
Attached = "Attached",
/** The disk is attached to a stopped-deallocated VM. */
Reserved = "Reserved",
/** The disk is attached to a VM which is in hibernated state. */
Frozen = "Frozen",
/** The disk currently has an Active SAS Uri associated with it. */
ActiveSAS = "ActiveSAS",
/** The disk is attached to a VM in hibernated state and has an active SAS URI associated with it. */
ActiveSASFrozen = "ActiveSASFrozen",
/** A disk is ready to be created by upload by requesting a write token. */
ReadyToUpload = "ReadyToUpload",
/** A disk is created for upload and a write token has been issued for uploading to it. */
ActiveUpload = "ActiveUpload"
}
/**
* Defines values for DiskState. \
* {@link KnownDiskState} can be used interchangeably with DiskState,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **Unattached**: The disk is not being used and can be attached to a VM. \
* **Attached**: The disk is currently attached to a running VM. \
* **Reserved**: The disk is attached to a stopped-deallocated VM. \
* **Frozen**: The disk is attached to a VM which is in hibernated state. \
* **ActiveSAS**: The disk currently has an Active SAS Uri associated with it. \
* **ActiveSASFrozen**: The disk is attached to a VM in hibernated state and has an active SAS URI associated with it. \
* **ReadyToUpload**: A disk is ready to be created by upload by requesting a write token. \
* **ActiveUpload**: A disk is created for upload and a write token has been issued for uploading to it.
*/
export type DiskState = string;
/** Known values of {@link EncryptionType} that the service accepts. */
export declare enum KnownEncryptionType {
/** Disk is encrypted at rest with Platform managed key. It is the default encryption type. This is not a valid encryption type for disk encryption sets. */
EncryptionAtRestWithPlatformKey = "EncryptionAtRestWithPlatformKey",
/** Disk is encrypted at rest with Customer managed key that can be changed and revoked by a customer. */
EncryptionAtRestWithCustomerKey = "EncryptionAtRestWithCustomerKey",
/** Disk is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed. */
EncryptionAtRestWithPlatformAndCustomerKeys = "EncryptionAtRestWithPlatformAndCustomerKeys"
}
/**
* Defines values for EncryptionType. \
* {@link KnownEncryptionType} can be used interchangeably with EncryptionType,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **EncryptionAtRestWithPlatformKey**: Disk is encrypted at rest with Platform managed key. It is the default encryption type. This is not a valid encryption type for disk encryption sets. \
* **EncryptionAtRestWithCustomerKey**: Disk is encrypted at rest with Customer managed key that can be changed and revoked by a customer. \
* **EncryptionAtRestWithPlatformAndCustomerKeys**: Disk is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed.
*/
export type EncryptionType = string;
/** Known values of {@link NetworkAccessPolicy} that the service accepts. */
export declare enum KnownNetworkAccessPolicy {
/** The disk can be exported or uploaded to from any network. */
AllowAll = "AllowAll",
/** The disk can be exported or uploaded to using a DiskAccess resource's private endpoints. */
AllowPrivate = "AllowPrivate",
/** The disk cannot be exported. */
DenyAll = "DenyAll"
}
/**
* Defines values for NetworkAccessPolicy. \
* {@link KnownNetworkAccessPolicy} can be used interchangeably with NetworkAccessPolicy,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **AllowAll**: The disk can be exported or uploaded to from any network. \
* **AllowPrivate**: The disk can be exported or uploaded to using a DiskAccess resource's private endpoints. \
* **DenyAll**: The disk cannot be exported.
*/
export type NetworkAccessPolicy = string;
/** Known values of {@link DiskSecurityTypes} that the service accepts. */
export declare enum KnownDiskSecurityTypes {
/** Trusted Launch provides security features such as secure boot and virtual Trusted Platform Module (vTPM) */
TrustedLaunch = "TrustedLaunch",
/** Indicates Confidential VM disk with only VM guest state encrypted */
ConfidentialVMVmguestStateOnlyEncryptedWithPlatformKey = "ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey",
/** Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a platform managed key */
ConfidentialVMDiskEncryptedWithPlatformKey = "ConfidentialVM_DiskEncryptedWithPlatformKey",
/** Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a customer managed key */
ConfidentialVMDiskEncryptedWithCustomerKey = "ConfidentialVM_DiskEncryptedWithCustomerKey",
/** Indicates Confidential VM disk with a ephemeral vTPM. vTPM state is not persisted across VM reboots. */
ConfidentialVMNonPersistedTPM = "ConfidentialVM_NonPersistedTPM"
}
/**
* Defines values for DiskSecurityTypes. \
* {@link KnownDiskSecurityTypes} can be used interchangeably with DiskSecurityTypes,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **TrustedLaunch**: Trusted Launch provides security features such as secure boot and virtual Trusted Platform Module (vTPM) \
* **ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey**: Indicates Confidential VM disk with only VM guest state encrypted \
* **ConfidentialVM_DiskEncryptedWithPlatformKey**: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a platform managed key \
* **ConfidentialVM_DiskEncryptedWithCustomerKey**: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a customer managed key \
* **ConfidentialVM_NonPersistedTPM**: Indicates Confidential VM disk with a ephemeral vTPM. vTPM state is not persisted across VM reboots.
*/
export type DiskSecurityTypes = string;
/** Known values of {@link PublicNetworkAccess} that the service accepts. */
export declare enum KnownPublicNetworkAccess {
/** You can generate a SAS URI to access the underlying data of the disk publicly on the internet when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. */
Enabled = "Enabled",
/** You cannot access the underlying data of the disk publicly on the internet even when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. */
Disabled = "Disabled"
}
/**
* Defines values for PublicNetworkAccess. \
* {@link KnownPublicNetworkAccess} can be used interchangeably with PublicNetworkAccess,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **Enabled**: You can generate a SAS URI to access the underlying data of the disk publicly on the internet when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. \
* **Disabled**: You cannot access the underlying data of the disk publicly on the internet even when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate.
*/
export type PublicNetworkAccess = string;
/** Known values of {@link DataAccessAuthMode} that the service accepts. */
export declare enum KnownDataAccessAuthMode {
/** When export\/upload URL is used, the system checks if the user has an identity in Azure Active Directory and has necessary permissions to export\/upload the data. Please refer to aka.ms\/DisksAzureADAuth. */
AzureActiveDirectory = "AzureActiveDirectory",
/** No additional authentication would be performed when accessing export\/upload URL. */
None = "None"
}
/**
* Defines values for DataAccessAuthMode. \
* {@link KnownDataAccessAuthMode} can be used interchangeably with DataAccessAuthMode,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **AzureActiveDirectory**: When export\/upload URL is used, the system checks if the user has an identity in Azure Active Directory and has necessary permissions to export\/upload the data. Please refer to aka.ms\/DisksAzureADAuth. \
* **None**: No additional authentication would be performed when accessing export\/upload URL.
*/
export type DataAccessAuthMode = string;
/** Known values of {@link AvailabilityPolicyDiskDelay} that the service accepts. */
export declare enum KnownAvailabilityPolicyDiskDelay {
/** Defaults to behavior without av policy specified, which is VM restart upon slow disk io. */
None = "None",
/** Upon a disk io failure or slow response, try detaching then reattaching the disk. */
AutomaticReattach = "AutomaticReattach"
}
/**
* Defines values for AvailabilityPolicyDiskDelay. \
* {@link KnownAvailabilityPolicyDiskDelay} can be used interchangeably with AvailabilityPolicyDiskDelay,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **None**: Defaults to behavior without av policy specified, which is VM restart upon slow disk io. \
* **AutomaticReattach**: Upon a disk io failure or slow response, try detaching then reattaching the disk.
*/
export type AvailabilityPolicyDiskDelay = string;
/** Known values of {@link DiskStorageAccountTypes} that the service accepts. */
export declare enum KnownDiskStorageAccountTypes {
/** Standard HDD locally redundant storage. Best for backup, non-critical, and infrequent access. */
StandardLRS = "Standard_LRS",
/** Premium SSD locally redundant storage. Best for production and performance sensitive workloads. */
PremiumLRS = "Premium_LRS",
/** Standard SSD locally redundant storage. Best for web servers, lightly used enterprise applications and dev\/test. */
StandardSSDLRS = "StandardSSD_LRS",
/** Ultra SSD locally redundant storage. Best for IO-intensive workloads such as SAP HANA, top tier databases (for example, SQL, Oracle), and other transaction-heavy workloads. */
UltraSSDLRS = "UltraSSD_LRS",
/** Premium SSD zone redundant storage. Best for the production workloads that need storage resiliency against zone failures. */
PremiumZRS = "Premium_ZRS",
/** Standard SSD zone redundant storage. Best for web servers, lightly used enterprise applications and dev\/test that need storage resiliency against zone failures. */
StandardSSDZRS = "StandardSSD_ZRS",
/** Premium SSD v2 locally redundant storage. Best for production and performance-sensitive workloads that consistently require low latency and high IOPS and throughput. */
PremiumV2LRS = "PremiumV2_LRS"
}
/**
* Defines values for DiskStorageAccountTypes. \
* {@link KnownDiskStorageAccountTypes} can be used interchangeably with DiskStorageAccountTypes,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **Standard_LRS**: Standard HDD locally redundant storage. Best for backup, non-critical, and infrequent access. \
* **Premium_LRS**: Premium SSD locally redundant storage. Best for production and performance sensitive workloads. \
* **StandardSSD_LRS**: Standard SSD locally redundant storage. Best for web servers, lightly used enterprise applications and dev\/test. \
* **UltraSSD_LRS**: Ultra SSD locally redundant storage. Best for IO-intensive workloads such as SAP HANA, top tier databases (for example, SQL, Oracle), and other transaction-heavy workloads. \
* **Premium_ZRS**: Premium SSD zone redundant storage. Best for the production workloads that need storage resiliency against zone failures. \
* **StandardSSD_ZRS**: Standard SSD zone redundant storage. Best for web servers, lightly used enterprise applications and dev\/test that need storage resiliency against zone failures. \
* **PremiumV2_LRS**: Premium SSD v2 locally redundant storage. Best for production and performance-sensitive workloads that consistently require low latency and high IOPS and throughput.
*/
export type DiskStorageAccountTypes = string;
/** Known values of {@link CopyCompletionErrorReason} that the service accepts. */
export declare enum KnownCopyCompletionErrorReason {
/** Indicates that the source snapshot was deleted while the background copy of the resource created via CopyStart operation was in progress. */
CopySourceNotFound = "CopySourceNotFound"
}
/**
* Defines values for CopyCompletionErrorReason. \
* {@link KnownCopyCompletionErrorReason} can be used interchangeably with CopyCompletionErrorReason,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **CopySourceNotFound**: Indicates that the source snapshot was deleted while the background copy of the resource created via CopyStart operation was in progress.
*/
export type CopyCompletionErrorReason = string;
/** Known values of {@link SnapshotStorageAccountTypes} that the service accepts. */
export declare enum KnownSnapshotStorageAccountTypes {
/** Standard HDD locally redundant storage */
StandardLRS = "Standard_LRS",
/** Premium SSD locally redundant storage */
PremiumLRS = "Premium_LRS",
/** Standard zone redundant storage */
StandardZRS = "Standard_ZRS"
}
/**
* Defines values for SnapshotStorageAccountTypes. \
* {@link KnownSnapshotStorageAccountTypes} can be used interchangeably with SnapshotStorageAccountTypes,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **Standard_LRS**: Standard HDD locally redundant storage \
* **Premium_LRS**: Premium SSD locally redundant storage \
* **Standard_ZRS**: Standard zone redundant storage
*/
export type SnapshotStorageAccountTypes = string;
/** Known values of {@link AccessLevel} that the service accepts. */
export declare enum KnownAccessLevel {
/** None */
None = "None",
/** Read */
Read = "Read",
/** Write */
Write = "Write"
}
/**
* Defines values for AccessLevel. \
* {@link KnownAccessLevel} can be used interchangeably with AccessLevel,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **None** \
* **Read** \
* **Write**
*/
export type AccessLevel = string;
/** Known values of {@link FileFormat} that the service accepts. */
export declare enum KnownFileFormat {
/** A VHD file is a disk image file in the Virtual Hard Disk file format. */
VHD = "VHD",
/** A VHDX file is a disk image file in the Virtual Hard Disk v2 file format. */
Vhdx = "VHDX"
}
/**
* Defines values for FileFormat. \
* {@link KnownFileFormat} can be used interchangeably with FileFormat,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **VHD**: A VHD file is a disk image file in the Virtual Hard Disk file format. \
* **VHDX**: A VHDX file is a disk image file in the Virtual Hard Disk v2 file format.
*/
export type FileFormat = string;
/** Known values of {@link ExtendedLocationType} that the service accepts. */
export declare enum KnownExtendedLocationType {
/** EdgeZone */
EdgeZone = "EdgeZone"
}
/**
* Defines values for ExtendedLocationType. \
* {@link KnownExtendedLocationType} can be used interchangeably with ExtendedLocationType,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **EdgeZone**
*/
export type ExtendedLocationType = string;
/** Known values of {@link GalleryProvisioningState} that the service accepts. */
export declare enum KnownGalleryProvisioningState {
/** Creating */
Creating = "Creating",
/** Updating */
Updating = "Updating",
/** Failed */
Failed = "Failed",
/** Succeeded */
Succeeded = "Succeeded",
/** Deleting */
Deleting = "Deleting",
/** Migrating */
Migrating = "Migrating"
}
/**
* Defines values for GalleryProvisioningState. \
* {@link KnownGalleryProvisioningState} can be used interchangeably with GalleryProvisioningState,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **Creating** \
* **Updating** \
* **Failed** \
* **Succeeded** \
* **Deleting** \
* **Migrating**
*/
export type GalleryProvisioningState = string;
/** Known values of {@link GallerySharingPermissionTypes} that the service accepts. */
export declare enum KnownGallerySharingPermissionTypes {
/** Private */
Private = "Private",
/** Groups */
Groups = "Groups",
/** Community */
Community = "Community"
}
/**
* Defines values for GallerySharingPermissionTypes. \
* {@link KnownGallerySharingPermissionTypes} can be used interchangeably with GallerySharingPermissionTypes,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **Private** \
* **Groups** \
* **Community**
*/
export type GallerySharingPermissionTypes = string;
/** Known values of {@link SharingProfileGroupTypes} that the service accepts. */
export declare enum KnownSharingProfileGroupTypes {
/** Subscriptions */
Subscriptions = "Subscriptions",
/** AADTenants */
AADTenants = "AADTenants"
}
/**
* Defines values for SharingProfileGroupTypes. \
* {@link KnownSharingProfileGroupTypes} can be used interchangeably with SharingProfileGroupTypes,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **Subscriptions** \
* **AADTenants**
*/
export type SharingProfileGroupTypes = string;
/** Known values of {@link SharingState} that the service accepts. */
export declare enum KnownSharingState {
/** Succeeded */
Succeeded = "Succeeded",
/** InProgress */
InProgress = "InProgress",
/** Failed */
Failed = "Failed",
/** Unknown */
Unknown = "Unknown"
}
/**
* Defines values for SharingState. \
* {@link KnownSharingState} can be used interchangeably with SharingState,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **Succeeded** \
* **InProgress** \
* **Failed** \
* **Unknown**
*/
export type SharingState = string;
/** Known values of {@link UefiSignatureTemplateName} that the service accepts. */
export declare enum KnownUefiSignatureTemplateName {
/** NoSignatureTemplate */
NoSignatureTemplate = "NoSignatureTemplate",
/** MicrosoftUefiCertificateAuthorityTemplate */
MicrosoftUefiCertificateAuthorityTemplate = "MicrosoftUefiCertificateAuthorityTemplate",
/** MicrosoftWindowsTemplate */
MicrosoftWindowsTemplate = "MicrosoftWindowsTemplate"
}
/**
* Defines values for UefiSignatureTemplateName. \
* {@link KnownUefiSignatureTemplateName} can be used interchangeably with UefiSignatureTemplateName,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **NoSignatureTemplate** \
* **MicrosoftUefiCertificateAuthorityTemplate** \
* **MicrosoftWindowsTemplate**
*/
export type UefiSignatureTemplateName = string;
/** Known values of {@link UefiKeyType} that the service accepts. */
export declare enum KnownUefiKeyType {
/** Sha256 */
Sha256 = "sha256",
/** X509 */
X509 = "x509"
}
/**
* Defines values for UefiKeyType. \
* {@link KnownUefiKeyType} can be used interchangeably with UefiKeyType,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **sha256** \
* **x509**
*/
export type UefiKeyType = string;
/** Known values of {@link SharedGalleryHostCaching} that the service accepts. */
export declare enum KnownSharedGalleryHostCaching {
/** None */
None = "None",
/** ReadOnly */
ReadOnly = "ReadOnly",
/** ReadWrite */
ReadWrite = "ReadWrite"
}
/**
* Defines values for SharedGalleryHostCaching. \
* {@link KnownSharedGalleryHostCaching} can be used interchangeably with SharedGalleryHostCaching,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **None** \
* **ReadOnly** \
* **ReadWrite**
*/
export type SharedGalleryHostCaching = string;
/** Known values of {@link SharedToValues} that the service accepts. */
export declare enum KnownSharedToValues {
/** Tenant */
Tenant = "tenant"
}
/**
* Defines values for SharedToValues. \
* {@link KnownSharedToValues} can be used interchangeably with SharedToValues,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **tenant**
*/
export type SharedToValues = string;
/** Known values of {@link SelectPermissions} that the service accepts. */
export declare enum KnownSelectPermissions {
/** Permissions */
Permissions = "Permissions"
}
/**
* Defines values for SelectPermissions. \
* {@link KnownSelectPermissions} can be used interchangeably with SelectPermissions,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **Permissions**
*/
export type SelectPermissions = string;
/** Known values of {@link GalleryExpandParams} that the service accepts. */
export declare enum KnownGalleryExpandParams {
/** SharingProfileGroups */
SharingProfileGroups = "SharingProfile/Groups"
}
/**
* Defines values for GalleryExpandParams. \
* {@link KnownGalleryExpandParams} can be used interchangeably with GalleryExpandParams,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **SharingProfile\/Groups**
*/
export type GalleryExpandParams = string;
/** Known values of {@link GalleryApplicationScriptRebootBehavior} that the service accepts. */
export declare enum KnownGalleryApplicationScriptRebootBehavior {
/** None */
None = "None",
/** Rerun */
Rerun = "Rerun"
}
/**
* Defines values for GalleryApplicationScriptRebootBehavior. \
* {@link KnownGalleryApplicationScriptRebootBehavior} can be used interchangeably with GalleryApplicationScriptRebootBehavior,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **None** \
* **Rerun**
*/
export type GalleryApplicationScriptRebootBehavior = string;
/** Known values of {@link StorageAccountType} that the service accepts. */
export declare enum KnownStorageAccountType {
/** StandardLRS */
StandardLRS = "Standard_LRS",
/** StandardZRS */
StandardZRS = "Standard_ZRS",
/** PremiumLRS */
PremiumLRS = "Premium_LRS",
/** PremiumV2LRS */
PremiumV2LRS = "PremiumV2_LRS"
}
/**
* Defines values for StorageAccountType. \
* {@link KnownStorageAccountType} can be used interchangeably with StorageAccountType,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **Standard_LRS** \
* **Standard_ZRS** \
* **Premium_LRS** \
* **PremiumV2_LRS**
*/
export type StorageAccountType = string;
/** Known values of {@link ConfidentialVMEncryptionType} that the service accepts. */
export declare enum KnownConfidentialVMEncryptionType {
/** EncryptedVMGuestStateOnlyWithPmk */
EncryptedVMGuestStateOnlyWithPmk = "EncryptedVMGuestStateOnlyWithPmk",
/** EncryptedWithPmk */
EncryptedWithPmk = "EncryptedWithPmk",
/** EncryptedWithCmk */
EncryptedWithCmk = "EncryptedWithCmk",
/** NonPersistedTPM */
NonPersistedTPM = "NonPersistedTPM"
}
/**
* Defines values for ConfidentialVMEncryptionType. \
* {@link KnownConfidentialVMEncryptionType} can be used interchangeably with ConfidentialVMEncryptionType,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **EncryptedVMGuestStateOnlyWithPmk** \
* **EncryptedWithPmk** \
* **EncryptedWithCmk** \
* **NonPersistedTPM**
*/
export type ConfidentialVMEncryptionType = string;
/** Known values of {@link ReplicationMode} that the service accepts. */
export declare enum KnownReplicationMode {
/** Full */
Full = "Full",
/** Shallow */
Shallow = "Shallow"
}
/**
* Defines values for ReplicationMode. \
* {@link KnownReplicationMode} can be used interchangeably with ReplicationMode,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **Full** \
* **Shallow**
*/
export type ReplicationMode = string;
/** Known values of {@link GalleryExtendedLocationType} that the service accepts. */
export declare enum KnownGalleryExtendedLocationType {
/** EdgeZone */
EdgeZone = "EdgeZone",
/** Unknown */
Unknown = "Unknown"
}
/**
* Defines values for GalleryExtendedLocationType. \
* {@link KnownGalleryExtendedLocationType} can be used interchangeably with GalleryExtendedLocationType,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **EdgeZone** \
* **Unknown**
*/
export type GalleryExtendedLocationType = string;
/** Known values of {@link EdgeZoneStorageAccountType} that the service accepts. */
export declare enum KnownEdgeZoneStorageAccountType {
/** StandardLRS */
StandardLRS = "Standard_LRS",
/** StandardZRS */
StandardZRS = "Standard_ZRS",
/** StandardSSDLRS */
StandardSSDLRS = "StandardSSD_LRS",
/** PremiumLRS */
PremiumLRS = "Premium_LRS"
}
/**
* Defines values for EdgeZoneStorageAccountType. \
* {@link KnownEdgeZoneStorageAccountType} can be used interchangeably with EdgeZoneStorageAccountType,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **Standard_LRS** \
* **Standard_ZRS** \
* **StandardSSD_LRS** \
* **Premium_LRS**
*/
export type EdgeZoneStorageAccountType = string;
/** Known values of {@link AggregatedReplicationState} that the service accepts. */
export declare enum KnownAggregatedReplicationState {
/** Unknown */
Unknown = "Unknown",
/** InProgress */
InProgress = "InProgress",
/** Completed */
Completed = "Completed",
/** Failed */
Failed = "Failed"
}
/**
* Defines values for AggregatedReplicationState. \
* {@link KnownAggregatedReplicationState} can be used interchangeably with AggregatedReplicationState,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **Unknown** \
* **InProgress** \
* **Completed** \
* **Failed**
*/
export type AggregatedReplicationState = string;
/** Known values of {@link ReplicationState} that the service accepts. */
export declare enum KnownReplicationState {
/** Unknown */
Unknown = "Unknown",
/** Replicating */
Replicating = "Replicating",
/** Completed */
Completed = "Completed",
/** Failed */
Failed = "Failed"
}
/**
* Defines values for ReplicationState. \
* {@link KnownReplicationState} can be used interchangeably with ReplicationState,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **Unknown** \
* **Replicating** \
* **Completed** \
* **Failed**
*/
export type ReplicationState = string;
/** Known values of {@link ReplicationStatusTypes} that the service accepts. */
export declare enum KnownReplicationStatusTypes {
/** ReplicationStatus */
ReplicationStatus = "ReplicationStatus",
/** UefiSettings */
UefiSettings = "UefiSettings"
}
/**
* Defines values for ReplicationStatusTypes. \
* {@link KnownReplicationStatusTypes} can be used interchangeably with ReplicationStatusTypes,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **ReplicationStatus** \
* **UefiSettings**
*/
export type ReplicationStatusTypes = string;
/** Known values of {@link PolicyViolationCategory} that the service accepts. */
export declare enum KnownPolicyViolationCategory {
/** Other */
Other = "Other",
/** ImageFlaggedUnsafe */
ImageFlaggedUnsafe = "ImageFlaggedUnsafe",
/** CopyrightValidation */
CopyrightValidation = "CopyrightValidation",
/** IpTheft */
IpTheft = "IpTheft"
}
/**
* Defines values for PolicyViolationCategory. \
* {@link KnownPolicyViolationCategory} can be used interchangeably with PolicyViolationCategory,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **Other** \
* **ImageFlaggedUnsafe** \
* **CopyrightValidation** \
* **IpTheft**
*/
export type PolicyViolationCategory = string;
/** Known values of {@link ValidationStatus} that the service accepts. */
export declare enum KnownValidationStatus {
/** Unknown */
Unknown = "Unknown",
/** Failed */
Failed = "Failed",
/** Succeeded */
Succeeded = "Succeeded"
}
/**
* Defines values for ValidationStatus. \
* {@link KnownValidationStatus} can be used interchangeably with ValidationStatus,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **Unknown** \
* **Failed** \
* **Succeeded**
*/
export type ValidationStatus = string;
/** Known values of {@link AccessControlRulesMode} that the service accepts. */
export declare enum KnownAccessControlRulesMode {
/** Audit */
Audit = "Audit",
/** Enforce */
Enforce = "Enforce",
/** Disabled */
Disabled = "Disabled"
}
/**
* Defines values for AccessControlRulesMode. \
* {@link KnownAccessControlRulesMode} can be used interchangeably with AccessControlRulesMode,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **Audit** \
* **Enforce** \
* **Disabled**
*/
export type AccessControlRulesMode = string;
/** Known values of {@link EndpointAccess} that the service accepts. */
export declare enum KnownEndpointAccess {
/** Allow */
Allow = "Allow",
/** Deny */
Deny = "Deny"
}
/**
* Defines values for EndpointAccess. \
* {@link KnownEndpointAccess} can be used interchangeably with EndpointAccess,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **Allow** \
* **Deny**
*/
export type EndpointAccess = string;
/** Known values of {@link SharingUpdateOperationTypes} that the service accepts. */
export declare enum KnownSharingUpdateOperationTypes {
/** Add */
Add = "Add",
/** Remove */
Remove = "Remove",
/** Reset */
Reset = "Reset",
/** EnableCommunity */
EnableCommunity = "EnableCommunity"
}
/**
* Defines values for SharingUpdateOperationTypes. \
* {@link KnownSharingUpdateOperationTypes} can be used interchangeably with SharingUpdateOperationTypes,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **Add** \
* **Remove** \
* **Reset** \
* **EnableCommunity**
*/
export type SharingUpdateOperationTypes = string;
/** Known values of {@link SoftDeletedArtifactTypes} that the service accepts. */
export declare enum KnownSoftDeletedArtifactTypes {
/** Images */
Images = "Images"
}
/**
* Defines values for SoftDeletedArtifactTypes. \
* {@link KnownSoftDeletedArtifactTypes} can be used interchangeably with SoftDeletedArtifactTypes,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **Images**
*/
export type SoftDeletedArtifactTypes = string;
/** Known values of {@link CloudServiceUpgradeMode} that the service accepts. */
export declare enum KnownCloudServiceUpgradeMode {
/** Auto */
Auto = "Auto",
/** Manual */
Manual = "Manual",
/** Simultaneous */
Simultaneous = "Simultaneous"
}
/**
* Defines values for CloudServiceUpgradeMode. \
* {@link KnownCloudServiceUpgradeMode} can be used interchangeably with CloudServiceUpgradeMode,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **Auto** \
* **Manual** \
* **Simultaneous**
*/
export type CloudServiceUpgradeMode = string;
/** Known values of {@link CloudServiceSlotType} that the service accepts. */
export declare enum KnownCloudServiceSlotType {
/** Production */
Production = "Production",
/** Staging */
Staging = "Staging"
}
/**
* Defines values for CloudServiceSlotType. \
* {@link KnownCloudServiceSlotType} can be used interchangeably with CloudServiceSlotType,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **Production** \
* **Staging**
*/
export type CloudServiceSlotType = string;
/** Known values of {@link AvailabilitySetSkuTypes} that the service accepts. */
export declare enum KnownAvailabilitySetSkuTypes {
/** Classic */
Classic = "Classic",
/** Aligned */
Aligned = "Aligned"
}
/**
* Defines values for AvailabilitySetSkuTypes. \
* {@link KnownAvailabilitySetSkuTypes} can be used interchangeably with AvailabilitySetSkuTypes,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **Classic** \
* **Aligned**
*/
export type AvailabilitySetSkuTypes = string;
/** Defines values for StatusLevelTypes. */
export type StatusLevelTypes = "Info" | "Warning" | "Error";
/** Defines values for OperatingSystemTypes. */
export type OperatingSystemTypes = "Windows" | "Linux";
/** Defines values for OperatingSystemStateTypes. */
export type OperatingSystemStateTypes = "Generalized" | "Specialized";
/** Defines values for CachingTypes. */
export type CachingTypes = "None" | "ReadOnly" | "ReadWrite";
/** Defines values for IntervalInMins. */
export type IntervalInMins = "ThreeMins" | "FiveMins" | "ThirtyMins" | "SixtyMins";
/** Defines values for UpgradeMode. */
export type UpgradeMode = "Automatic" | "Manual" | "Rolling";
/** Defines values for SettingNames. */
export type SettingNames = "AutoLogon" | "FirstLogonCommands";
/** Defines values for ProtocolTypes. */
export type ProtocolTypes = "Http" | "Https";
/** Defines values for ResourceIdentityType. */
export type ResourceIdentityType = "SystemAssigned" | "UserAssigned" | "SystemAssigned, UserAssigned" | "None";
/** Defines values for MaintenanceOperationResultCodeTypes. */
export type MaintenanceOperationResultCodeTypes = "None" | "RetryLater" | "MaintenanceAborted" | "MaintenanceCompleted";
/** Defines values for InstanceViewTypes. */
export type InstanceViewTypes = "instanceView" | "userData" | "resiliencyView";
/** Defines values for DedicatedHostLicenseTypes. */
export type DedicatedHostLicenseTypes = "None" | "Windows_Server_Hybrid" | "Windows_Server_Perpetual";
/** Defines values for UpgradeState. */
export type UpgradeState = "RollingForward" | "Cancelled" | "Completed" | "Faulted";
/** Defines values for UpgradeOperationInvoker. */
export type UpgradeOperationInvoker = "Unknown" | "User" | "Platform";
/** Defines values for RollingUpgradeStatusCode. */
export type RollingUpgradeStatusCode = "RollingForward" | "Cancelled" | "Completed" | "Faulted";
/** Defines values for RollingUpgradeActionType. */
export type RollingUpgradeActionType = "Start" | "Cancel";
/** Defines values for VirtualMachineScaleSetSkuScaleType. */
export type VirtualMachineScaleSetSkuScaleType = "Automatic" | "None";
/** Defines values for ResourceSkuCapacityScaleType. */
export type ResourceSkuCapacityScaleType = "Automatic" | "Manual" | "None";
/** Defines values for ResourceSkuRestrictionsType. */
export type ResourceSkuRestrictionsType = "Location" | "Zone";
/** Defines values for ResourceSkuRestrictionsReasonCode. */
export type ResourceSkuRestrictionsReasonCode = "QuotaId" | "NotAvailableForSubscription";
/** Defines values for GalleryApplicationCustomActionParameterType. */
export type GalleryApplicationCustomActionParameterType = "String" | "ConfigurationDataBlob" | "LogOutputBlob";
/** Defines values for HostCaching. */
export type HostCaching = "None" | "ReadOnly" | "ReadWrite";
/** Defines values for EndpointTypes. */
export type EndpointTypes = "WireServer" | "IMDS";
/** Optional parameters. */
export interface OperationsListOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the list operation. */
export type OperationsListResponse = OperationListResult;
/** Optional parameters. */
export interface OperationsListNextOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listNext operation. */
export type OperationsListNextResponse = OperationListResult;
/** Optional parameters. */
export interface AvailabilitySetsListBySubscriptionOptionalParams extends coreClient.OperationOptions {
/** The expand expression to apply to the operation. Allowed values are 'instanceView'. */
expand?: string;
}
/** Contains response data for the listBySubscription operation. */
export type AvailabilitySetsListBySubscriptionResponse = AvailabilitySetListResult;
/** Optional parameters. */
export interface AvailabilitySetsListOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the list operation. */
export type AvailabilitySetsListResponse = AvailabilitySetListResult;
/** Optional parameters. */
export interface AvailabilitySetsGetOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the get operation. */
export type AvailabilitySetsGetResponse = AvailabilitySet;
/** Optional parameters. */
export interface AvailabilitySetsCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the createOrUpdate operation. */
export type AvailabilitySetsCreateOrUpdateResponse = AvailabilitySet;
/** Optional parameters. */
export interface AvailabilitySetsUpdateOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the update operation. */
export type AvailabilitySetsUpdateResponse = AvailabilitySet;
/** Optional parameters. */
export interface AvailabilitySetsDeleteOptionalParams extends coreClient.OperationOptions {
}
/** Optional parameters. */
export interface AvailabilitySetsCancelMigrationToVirtualMachineScaleSetOptionalParams extends coreClient.OperationOptions {
}
/** Optional parameters. */
export interface AvailabilitySetsConvertToVirtualMachineScaleSetOptionalParams extends coreClient.OperationOptions {
/** Parameters supplied to the migrate operation on the availability set. */
parameters?: ConvertToVirtualMachineScaleSetInput;
/** 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 convertToVirtualMachineScaleSet operation. */
export type AvailabilitySetsConvertToVirtualMachineScaleSetResponse = AvailabilitySetsConvertToVirtualMachineScaleSetHeaders;
/** Optional parameters. */
export interface AvailabilitySetsStartMigrationToVirtualMachineScaleSetOptionalParams extends coreClient.OperationOptions {
}
/** Optional parameters. */
export interface AvailabilitySetsValidateMigrationToVirtualMachineScaleSetOptionalParams extends coreClient.OperationOptions {
}
/** Optional parameters. */
export interface AvailabilitySetsListAvailableSizesOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listAvailableSizes operation. */
export type AvailabilitySetsListAvailableSizesResponse = VirtualMachineSizeListResult;
/** Optional parameters. */
export interface AvailabilitySetsListBySubscriptionNextOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listBySubscriptionNext operation. */
export type AvailabilitySetsListBySubscriptionNextResponse = AvailabilitySetListResult;
/** Optional parameters. */
export interface AvailabilitySetsListNextOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listNext operation. */
export type AvailabilitySetsListNextResponse = AvailabilitySetListResult;
/** Optional parameters. */
export interface AvailabilitySetsListAvailableSizesNextOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listAvailableSizesNext operation. */
export type AvailabilitySetsListAvailableSizesNextResponse = VirtualMachineSizeListResult;
/** Optional parameters. */
export interface CapacityReservationGroupsListBySubscriptionOptionalParams extends coreClient.OperationOptions {
/** The expand expression to apply on the operation. Based on the expand param(s) specified we return Virtual Machine or ScaleSet VM Instance or both resource Ids which are associated to capacity reservation group in the response. */
expand?: ExpandTypesForGetCapacityReservationGroups;
/** The query option to fetch Capacity Reservation Group Resource Ids. 'CreatedInSubscription' enables fetching Resource Ids for all capacity reservation group resources created in the subscription. 'SharedWithSubscription' enables fetching Resource Ids for all capacity reservation group resources shared with the subscription. 'All' enables fetching Resource Ids for all capacity reservation group resources shared with the subscription and created in the subscription. */
resourceIdsOnly?: ResourceIdOptionsForGetCapacityReservationGroups;
}
/** Contains response data for the listBySubscription operation. */
export type CapacityReservationGroupsListBySubscriptionResponse = CapacityReservationGroupListResult;
/** Optional parameters. */
export interface CapacityReservationGroupsListByResourceGroupOptionalParams extends coreClient.OperationOptions {
/** The expand expression to apply on the operation. Based on the expand param(s) specified we return Virtual Machine or ScaleSet VM Instance or both resource Ids which are associated to capacity reservation group in the response. */
expand?: ExpandTypesForGetCapacityReservationGroups;
}
/** Contains response data for the listByResourceGroup operation. */
export type CapacityReservationGroupsListByResourceGroupResponse = CapacityReservationGroupListResult;
/** Optional parameters. */
export interface CapacityReservationGroupsGetOptionalParams extends coreClient.OperationOptions {
/** The expand expression to apply on the operation. 'InstanceView' will retrieve the list of instance views of the capacity reservations under the capacity reservation group which is a snapshot of the runtime properties of a capacity reservation that is managed by the platform and can change outside of control plane operations. */
expand?: CapacityReservationGroupInstanceViewTypes;
}
/** Contains response data for the get operation. */
export type CapacityReservationGroupsGetResponse = CapacityReservationGroup;
/** Optional parameters. */
export interface CapacityReservationGroupsCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the createOrUpdate operation. */
export type CapacityReservationGroupsCreateOrUpdateResponse = CapacityReservationGroup;
/** Optional parameters. */
export interface CapacityReservationGroupsUpdateOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the update operation. */
export type CapacityReservationGroupsUpdateResponse = CapacityReservationGroup;
/** Optional parameters. */
export interface CapacityReservationGroupsDeleteOptionalParams extends coreClient.OperationOptions {
}
/** Optional parameters. */
export interface CapacityReservationGroupsListBySubscriptionNextOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listBySubscriptionNext operation. */
export type CapacityReservationGroupsListBySubscriptionNextResponse = CapacityReservationGroupListResult;
/** Optional parameters. */
export interface CapacityReservationGroupsListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listByResourceGroupNext operation. */
export type CapacityReservationGroupsListByResourceGroupNextResponse = CapacityReservationGroupListResult;
/** Optional parameters. */
export interface DedicatedHostGroupsListBySubscriptionOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listBySubscription operation. */
export type DedicatedHostGroupsListBySubscriptionResponse = DedicatedHostGroupListResult;
/** Optional parameters. */
export interface DedicatedHostGroupsListByResourceGroupOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listByResourceGroup operation. */
export type DedicatedHostGroupsListByResourceGroupResponse = DedicatedHostGroupListResult;
/** Optional parameters. */
export interface DedicatedHostGroupsGetOptionalParams extends coreClient.OperationOptions {
/** The expand expression to apply on the operation. 'InstanceView' will retrieve the list of instance views of the dedicated hosts under the dedicated host group. 'UserData' is not supported for dedicated host group. */
expand?: InstanceViewTypes;
}
/** Contains response data for the get operation. */
export type DedicatedHostGroupsGetResponse = DedicatedHostGroup;
/** Optional parameters. */
export interface DedicatedHostGroupsCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the createOrUpdate operation. */
export type DedicatedHostGroupsCreateOrUpdateResponse = DedicatedHostGroup;
/** Optional parameters. */
export interface DedicatedHostGroupsUpdateOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the update operation. */
export type DedicatedHostGroupsUpdateResponse = DedicatedHostGroup;
/** Optional parameters. */
export interface DedicatedHostGroupsDeleteOptionalParams extends coreClient.OperationOptions {
}
/** Optional parameters. */
export interface DedicatedHostGroupsListBySubscriptionNextOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listBySubscriptionNext operation. */
export type DedicatedHostGroupsListBySubscriptionNextResponse = DedicatedHostGroupListResult;
/** Optional parameters. */
export interface DedicatedHostGroupsListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listByResourceGroupNext operation. */
export type DedicatedHostGroupsListByResourceGroupNextResponse = DedicatedHostGroupListResult;
/** Optional parameters. */
export interface ImagesListOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the list operation. */
export type ImagesListResponse = ImageListResult;
/** Optional parameters. */
export interface ImagesListByResourceGroupOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listByResourceGroup operation. */
export type ImagesListByResourceGroupResponse = ImageListResult;
/** Optional parameters. */
export interface ImagesGetOptionalParams extends coreClient.OperationOptions {
/** The expand expression to apply on the operation. */
expand?: string;
}
/** Contains response data for the get operation. */
export type ImagesGetResponse = Image;
/** Optional parameters. */
export interface ImagesCreateOrUpdateOptionalParams 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 createOrUpdate operation. */
export type ImagesCreateOrUpdateResponse = Image;
/** Optional parameters. */
export interface ImagesUpdateOptionalParams 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. */
export type ImagesUpdateResponse = Image;
/** Optional parameters. */
export interface ImagesDeleteOptionalParams 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 ImagesListNextOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listNext operation. */
export type ImagesListNextResponse = ImageListResult;
/** Optional parameters. */
export interface ImagesListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listByResourceGroupNext operation. */
export type ImagesListByResourceGroupNextResponse = ImageListResult;
/** Optional parameters. */
export interface VirtualMachineImagesEdgeZoneListPublishersOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listPublishers operation. */
export type VirtualMachineImagesEdgeZoneListPublishersResponse = VirtualMachineImageResource[];
/** Optional parameters. */
export interface VirtualMachineImagesEdgeZoneListOffersOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listOffers operation. */
export type VirtualMachineImagesEdgeZoneListOffersResponse = VirtualMachineImageResource[];
/** Optional parameters. */
export interface VirtualMachineImagesEdgeZoneListSkusOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listSkus operation. */
export type VirtualMachineImagesEdgeZoneListSkusResponse = VirtualMachineImageResource[];
/** Optional parameters. */
export interface VirtualMachineImagesEdgeZoneListOptionalParams extends coreClient.OperationOptions {
/** The expand expression to apply on the operation. */
expand?: string;
/** An integer value specifying the number of images to return that matches supplied values. */
top?: number;
/** Specifies the order of the results returned. Formatted as an OData query. */
orderby?: string;
}
/** Contains response data for the list operation. */
export type VirtualMachineImagesEdgeZoneListResponse = VirtualMachineImageResource[];
/** Optional parameters. */
export interface VirtualMachineImagesEdgeZoneGetOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the get operation. */
export type VirtualMachineImagesEdgeZoneGetResponse = VirtualMachineImage;
/** Optional parameters. */
export interface VirtualMachineImagesListByEdgeZoneOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listByEdgeZone operation. */
export type VirtualMachineImagesListByEdgeZoneResponse = VmImagesInEdgeZoneListResult;
/** Optional parameters. */
export interface VirtualMachineImagesListPublishersOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listPublishers operation. */
export type VirtualMachineImagesListPublishersResponse = VirtualMachineImageResource[];
/** Optional parameters. */
export interface VirtualMachineImagesListOffersOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listOffers operation. */
export type VirtualMachineImagesListOffersResponse = VirtualMachineImageResource[];
/** Optional parameters. */
export interface VirtualMachineImagesListSkusOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listSkus operation. */
export type VirtualMachineImagesListSkusResponse = VirtualMachineImageResource[];
/** Optional parameters. */
export interface VirtualMachineImagesListOptionalParams extends coreClient.OperationOptions {
/** The expand expression to apply on the operation. */
expand?: string;
/** An integer value specifying the number of images to return that matches supplied values. */
top?: number;
/** Specifies the order of the results returned. Formatted as an OData query. */
orderby?: string;
}
/** Contains response data for the list operation. */
export type VirtualMachineImagesListResponse = VirtualMachineImageResource[];
/** Optional parameters. */
export interface VirtualMachineImagesGetOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the get operation. */
export type VirtualMachineImagesGetResponse = VirtualMachineImage;
/** Optional parameters. */
export interface VirtualMachineImagesListWithPropertiesOptionalParams extends coreClient.OperationOptions {
/** An integer value specifying the number of images to return that matches supplied values. */
top?: number;
/** Specifies the order of the results returned. Formatted as an OData query. */
orderby?: string;
}
/** Contains response data for the listWithProperties operation. */
export type VirtualMachineImagesListWithPropertiesResponse = VirtualMachineImage[];
/** Optional parameters. */
export interface LogAnalyticsExportRequestRateByIntervalOptionalParams 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 exportRequestRateByInterval operation. */
export type LogAnalyticsExportRequestRateByIntervalResponse = LogAnalyticsOperationResult;
/** Optional parameters. */
export interface LogAnalyticsExportThrottledRequestsOptionalParams 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 exportThrottledRequests operation. */
export type LogAnalyticsExportThrottledRequestsResponse = LogAnalyticsOperationResult;
/** Optional parameters. */
export interface VirtualMachineExtensionImagesListTypesOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listTypes operation. */
export type VirtualMachineExtensionImagesListTypesResponse = VirtualMachineExtensionImage[];
/** Optional parameters. */
export interface VirtualMachineExtensionImagesListVersionsOptionalParams extends coreClient.OperationOptions {
/** An integer value specifying the number of images to return that matches supplied values. */
top?: number;
/** Specifies the order of the results returned. Formatted as an OData query. */
orderby?: string;
/** The filter to apply on the operation. */
filter?: string;
}
/** Contains response data for the listVersions operation. */
export type VirtualMachineExtensionImagesListVersionsResponse = VirtualMachineExtensionImage[];
/** Optional parameters. */
export interface VirtualMachineExtensionImagesGetOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the get operation. */
export type VirtualMachineExtensionImagesGetResponse = VirtualMachineExtensionImage;
/** Optional parameters. */
export interface VirtualMachineRunCommandsListOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the list operation. */
export type VirtualMachineRunCommandsListResponse = RunCommandListResult;
/** Optional parameters. */
export interface VirtualMachineRunCommandsGetOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the get operation. */
export type VirtualMachineRunCommandsGetResponse = RunCommandDocument;
/** Optional parameters. */
export interface VirtualMachineRunCommandsListByVirtualMachineOptionalParams extends coreClient.OperationOptions {
/** The expand expression to apply on the operation. */
expand?: string;
}
/** Contains response data for the listByVirtualMachine operation. */
export type VirtualMachineRunCommandsListByVirtualMachineResponse = VirtualMachineRunCommandsListResult;
/** Optional parameters. */
export interface VirtualMachineRunCommandsGetByVirtualMachineOptionalParams extends coreClient.OperationOptions {
/** The expand expression to apply on the operation. */
expand?: string;
}
/** Contains response data for the getByVirtualMachine operation. */
export type VirtualMachineRunCommandsGetByVirtualMachineResponse = VirtualMachineRunCommand;
/** Optional parameters. */
export interface VirtualMachineRunCommandsCreateOrUpdateOptionalParams 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 createOrUpdate operation. */
export type VirtualMachineRunCommandsCreateOrUpdateResponse = VirtualMachineRunCommand;
/** Optional parameters. */
export interface VirtualMachineRunCommandsUpdateOptionalParams 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. */
export type VirtualMachineRunCommandsUpdateResponse = VirtualMachineRunCommandsUpdateHeaders & VirtualMachineRunCommand;
/** Optional parameters. */
export interface VirtualMachineRunCommandsDeleteOptionalParams 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 VirtualMachineRunCommandsListNextOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listNext operation. */
export type VirtualMachineRunCommandsListNextResponse = RunCommandListResult;
/** Optional parameters. */
export interface VirtualMachineRunCommandsListByVirtualMachineNextOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listByVirtualMachineNext operation. */
export type VirtualMachineRunCommandsListByVirtualMachineNextResponse = VirtualMachineRunCommandsListResult;
/** Optional parameters. */
export interface UsageListOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the list operation. */
export type UsageListResponse = ListUsagesResult;
/** Optional parameters. */
export interface UsageListNextOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listNext operation. */
export type UsageListNextResponse = ListUsagesResult;
/** Optional parameters. */
export interface VirtualMachineScaleSetsListByLocationOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listByLocation operation. */
export type VirtualMachineScaleSetsListByLocationResponse = VirtualMachineScaleSetListResult;
/** Optional parameters. */
export interface VirtualMachineScaleSetsListAllOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listAll operation. */
export type VirtualMachineScaleSetsListAllResponse = VirtualMachineScaleSetListWithLinkResult;
/** Optional parameters. */
export interface VirtualMachineScaleSetsListOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the list operation. */
export type VirtualMachineScaleSetsListResponse = VirtualMachineScaleSetListResult;
/** Optional parameters. */
export interface VirtualMachineScaleSetsGetOptionalParams extends coreClient.OperationOptions {
/** The expand expression to apply on the operation. 'UserData' retrieves the UserData property of the VM scale set that was provided by the user during the VM scale set Create/Update operation */
expand?: ExpandTypesForGetVMScaleSets;
}
/** Contains response data for the get operation. */
export type VirtualMachineScaleSetsGetResponse = VirtualMachineScaleSet;
/** Optional parameters. */
export interface VirtualMachineScaleSetsCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
/** The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes. */
ifMatch?: string;
/** Set to '*' to allow a new record set to be created, but to prevent updating an existing record set. Other values will result in error from server as they are not supported. */
ifNoneMatch?: string;
/** 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 createOrUpdate operation. */
export type VirtualMachineScaleSetsCreateOrUpdateResponse = VirtualMachineScaleSet;
/** Optional parameters. */
export interface VirtualMachineScaleSetsUpdateOptionalParams extends coreClient.OperationOptions {
/** The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes. */
ifMatch?: string;
/** Set to '*' to allow a new record set to be created, but to prevent updating an existing record set. Other values will result in error from server as they are not supported. */
ifNoneMatch?: string;
/** 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. */
export type VirtualMachineScaleSetsUpdateResponse = VirtualMachineScaleSetsUpdateHeaders & VirtualMachineScaleSet;
/** Optional parameters. */
export interface VirtualMachineScaleSetsDeleteOptionalParams extends coreClient.OperationOptions {
/** Optional parameter to force delete a VM scale set. (Feature in Preview) */
forceDeletion?: boolean;
/** 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 VirtualMachineScaleSetsApproveRollingUpgradeOptionalParams extends coreClient.OperationOptions {
/** A list of virtual machine instance IDs from the VM scale set. */
vmInstanceIDs?: VirtualMachineScaleSetVMInstanceIDs;
/** 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 approveRollingUpgrade operation. */
export type VirtualMachineScaleSetsApproveRollingUpgradeResponse = VirtualMachineScaleSetsApproveRollingUpgradeHeaders;
/** Optional parameters. */
export interface VirtualMachineScaleSetsConvertToSinglePlacementGroupOptionalParams extends coreClient.OperationOptions {
}
/** Optional parameters. */
export interface VirtualMachineScaleSetsDeallocateOptionalParams extends coreClient.OperationOptions {
/** A list of virtual machine instance IDs from the VM scale set. */
vmInstanceIDs?: VirtualMachineScaleSetVMInstanceIDs;
/** Optional parameter to hibernate a virtual machine from the VM scale set. (This feature is available for VMSS with Flexible OrchestrationMode only) */
hibernate?: boolean;
/** 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 VirtualMachineScaleSetsDeleteInstancesOptionalParams extends coreClient.OperationOptions {
/** Optional parameter to force delete virtual machines from the VM scale set. (Feature in Preview) */
forceDeletion?: boolean;
/** 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 VirtualMachineScaleSetsForceRecoveryServiceFabricPlatformUpdateDomainWalkOptionalParams extends coreClient.OperationOptions {
/** The zone in which the manual recovery walk is requested for cross zone virtual machine scale set */
zone?: string;
/** The placement group id for which the manual recovery walk is requested. */
placementGroupId?: string;
}
/** Contains response data for the forceRecoveryServiceFabricPlatformUpdateDomainWalk operation. */
export type VirtualMachineScaleSetsForceRecoveryServiceFabricPlatformUpdateDomainWalkResponse = RecoveryWalkResponse;
/** Optional parameters. */
export interface VirtualMachineScaleSetsGetInstanceViewOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the getInstanceView operation. */
export type VirtualMachineScaleSetsGetInstanceViewResponse = VirtualMachineScaleSetInstanceView;
/** Optional parameters. */
export interface VirtualMachineScaleSetsUpdateInstancesOptionalParams 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 VirtualMachineScaleSetsGetOSUpgradeHistoryOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the getOSUpgradeHistory operation. */
export type VirtualMachineScaleSetsGetOSUpgradeHistoryResponse = VirtualMachineScaleSetListOSUpgradeHistory;
/** Optional parameters. */
export interface VirtualMachineScaleSetsPerformMaintenanceOptionalParams extends coreClient.OperationOptions {
/** A list of virtual machine instance IDs from the VM scale set. */
vmInstanceIDs?: VirtualMachineScaleSetVMInstanceIDs;
/** 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 VirtualMachineScaleSetsPowerOffOptionalParams extends coreClient.OperationOptions {
/** A list of virtual machine instance IDs from the VM scale set. */
vmInstanceIDs?: VirtualMachineScaleSetVMInstanceIDs;
/** The parameter to request non-graceful VM shutdown. True value for this flag indicates non-graceful shutdown whereas false indicates otherwise. Default value for this flag is false if not specified */
skipShutdown?: boolean;
/** 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 VirtualMachineScaleSetsReapplyOptionalParams 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 VirtualMachineScaleSetsRedeployOptionalParams extends coreClient.OperationOptions {
/** A list of virtual machine instance IDs from the VM scale set. */
vmInstanceIDs?: VirtualMachineScaleSetVMInstanceIDs;
/** 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 VirtualMachineScaleSetsReimageOptionalParams extends coreClient.OperationOptions {
/** Parameters for Reimaging VM ScaleSet. */
vmScaleSetReimageInput?: VirtualMachineScaleSetReimageParameters;
/** 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 VirtualMachineScaleSetsReimageAllOptionalParams extends coreClient.OperationOptions {
/** A list of virtual machine instance IDs from the VM scale set. */
vmInstanceIDs?: VirtualMachineScaleSetVMInstanceIDs;
/** 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 VirtualMachineScaleSetsRestartOptionalParams extends coreClient.OperationOptions {
/** A list of virtual machine instance IDs from the VM scale set. */
vmInstanceIDs?: VirtualMachineScaleSetVMInstanceIDs;
/** 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 VirtualMachineScaleSetsScaleOutOptionalParams 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 VirtualMachineScaleSetsSetOrchestrationServiceStateOptionalParams 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 VirtualMachineScaleSetsListSkusOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listSkus operation. */
export type VirtualMachineScaleSetsListSkusResponse = VirtualMachineScaleSetListSkusResult;
/** Optional parameters. */
export interface VirtualMachineScaleSetsStartOptionalParams extends coreClient.OperationOptions {
/** A list of virtual machine instance IDs from the VM scale set. */
vmInstanceIDs?: VirtualMachineScaleSetVMInstanceIDs;
/** 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 VirtualMachineScaleSetsListByLocationNextOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listByLocationNext operation. */
export type VirtualMachineScaleSetsListByLocationNextResponse = VirtualMachineScaleSetListResult;
/** Optional parameters. */
export interface VirtualMachineScaleSetsListAllNextOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listAllNext operation. */
export type VirtualMachineScaleSetsListAllNextResponse = VirtualMachineScaleSetListWithLinkResult;
/** Optional parameters. */
export interface VirtualMachineScaleSetsListNextOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listNext operation. */
export type VirtualMachineScaleSetsListNextResponse = VirtualMachineScaleSetListResult;
/** Optional parameters. */
export interface VirtualMachineScaleSetsGetOSUpgradeHistoryNextOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the getOSUpgradeHistoryNext operation. */
export type VirtualMachineScaleSetsGetOSUpgradeHistoryNextResponse = VirtualMachineScaleSetListOSUpgradeHistory;
/** Optional parameters. */
export interface VirtualMachineScaleSetsListSkusNextOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listSkusNext operation. */
export type VirtualMachineScaleSetsListSkusNextResponse = VirtualMachineScaleSetListSkusResult;
/** Optional parameters. */
export interface VirtualMachinesListByLocationOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listByLocation operation. */
export type VirtualMachinesListByLocationResponse = VirtualMachineListResult;
/** Optional parameters. */
export interface VirtualMachinesListAllOptionalParams extends coreClient.OperationOptions {
/** The system query option to filter VMs returned in the response. Allowed value is 'virtualMachineScaleSet/id' eq /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmssName}' */
filter?: string;
/** statusOnly=true enables fetching run time status of all Virtual Machines in the subscription. */
statusOnly?: string;
/** The expand expression to apply on operation. 'instanceView' enables fetching run time status of all Virtual Machines, this can only be specified if a valid $filter option is specified */
expand?: ExpandTypesForListVMs;
}
/** Contains response data for the listAll operation. */
export type VirtualMachinesListAllResponse = VirtualMachineListResult;
/** Optional parameters. */
export interface VirtualMachinesListOptionalParams extends coreClient.OperationOptions {
/** The system query option to filter VMs returned in the response. Allowed value is 'virtualMachineScaleSet/id' eq /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmssName}' */
filter?: string;
/** The expand expression to apply on operation. 'instanceView' enables fetching run time status of all Virtual Machines, this can only be specified if a valid $filter option is specified */
expand?: ExpandTypeForListVMs;
}
/** Contains response data for the list operation. */
export type VirtualMachinesListResponse = VirtualMachineListResult;
/** Optional parameters. */
export interface VirtualMachinesGetOptionalParams extends coreClient.OperationOptions {
/** The expand expression to apply on the operation. 'InstanceView' retrieves a snapshot of the runtime properties of the virtual machine that is managed by the platform and can change outside of control plane operations. 'UserData' retrieves the UserData property as part of the VM model view that was provided by the user during the VM Create/Update operation. */
expand?: InstanceViewTypes;
}
/** Contains response data for the get operation. */
export type VirtualMachinesGetResponse = VirtualMachine;
/** Optional parameters. */
export interface VirtualMachinesCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
/** The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes. */
ifMatch?: string;
/** Set to '*' to allow a new record set to be created, but to prevent updating an existing record set. Other values will result in error from server as they are not supported. */
ifNoneMatch?: string;
/** 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 createOrUpdate operation. */
export type VirtualMachinesCreateOrUpdateResponse = VirtualMachine;
/** Optional parameters. */
export interface VirtualMachinesUpdateOptionalParams extends coreClient.OperationOptions {
/** The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes. */
ifMatch?: string;
/** Set to '*' to allow a new record set to be created, but to prevent updating an existing record set. Other values will result in error from server as they are not supported. */
ifNoneMatch?: string;
/** 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. */
export type VirtualMachinesUpdateResponse = VirtualMachinesUpdateHeaders & VirtualMachine;
/** Optional parameters. */
export interface VirtualMachinesDeleteOptionalParams extends coreClient.OperationOptions {
/** Optional parameter to force delete virtual machines. */
forceDeletion?: boolean;
/** 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 VirtualMachinesAssessPatchesOptionalParams 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 assessPatches operation. */
export type VirtualMachinesAssessPatchesResponse = VirtualMachineAssessPatchesResult;
/** Optional parameters. */
export interface VirtualMachinesAttachDetachDataDisksOptionalParams 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 attachDetachDataDisks operation. */
export type VirtualMachinesAttachDetachDataDisksResponse = StorageProfile;
/** Optional parameters. */
export interface VirtualMachinesCaptureOptionalParams 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 capture operation. */
export type VirtualMachinesCaptureResponse = VirtualMachineCaptureResult;
/** Optional parameters. */
export interface VirtualMachinesConvertToManagedDisksOptionalParams 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 VirtualMachinesDeallocateOptionalParams extends coreClient.OperationOptions {
/** Optional parameter to hibernate a virtual machine. */
hibernate?: boolean;
/** 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 VirtualMachinesGeneralizeOptionalParams extends coreClient.OperationOptions {
}
/** Optional parameters. */
export interface VirtualMachinesInstallPatchesOptionalParams 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 installPatches operation. */
export type VirtualMachinesInstallPatchesResponse = VirtualMachineInstallPatchesResult;
/** Optional parameters. */
export interface VirtualMachinesInstanceViewOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the instanceView operation. */
export type VirtualMachinesInstanceViewResponse = VirtualMachineInstanceView;
/** Optional parameters. */
export interface VirtualMachinesMigrateToVMScaleSetOptionalParams extends coreClient.OperationOptions {
/** Parameters supplied to the Migrate Virtual Machine operation. */
parameters?: MigrateVMToVirtualMachineScaleSetInput;
/** 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 migrateToVMScaleSet operation. */
export type VirtualMachinesMigrateToVMScaleSetResponse = VirtualMachinesMigrateToVMScaleSetHeaders;
/** Optional parameters. */
export interface VirtualMachinesPerformMaintenanceOptionalParams 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 VirtualMachinesPowerOffOptionalParams extends coreClient.OperationOptions {
/** The parameter to request non-graceful VM shutdown. True value for this flag indicates non-graceful shutdown whereas false indicates otherwise. Default value for this flag is false if not specified */
skipShutdown?: boolean;
/** 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 VirtualMachinesReapplyOptionalParams 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 VirtualMachinesRedeployOptionalParams 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 VirtualMachinesReimageOptionalParams extends coreClient.OperationOptions {
/** Parameters supplied to the Reimage Virtual Machine operation. */
parameters?: VirtualMachineReimageParameters;
/** 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 VirtualMachinesRestartOptionalParams 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 VirtualMachinesRetrieveBootDiagnosticsDataOptionalParams extends coreClient.OperationOptions {
/** Expiration duration in minutes for the SAS URIs with a value between 1 to 1440 minutes. **Note:** If not specified, SAS URIs will be generated with a default expiration duration of 120 minutes. */
sasUriExpirationTimeInMinutes?: number;
}
/** Contains response data for the retrieveBootDiagnosticsData operation. */
export type VirtualMachinesRetrieveBootDiagnosticsDataResponse = RetrieveBootDiagnosticsDataResult;
/** Optional parameters. */
export interface VirtualMachinesRunCommandOptionalParams 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 runCommand operation. */
export type VirtualMachinesRunCommandResponse = RunCommandResult;
/** Optional parameters. */
export interface VirtualMachinesSimulateEvictionOptionalParams extends coreClient.OperationOptions {
}
/** Optional parameters. */
export interface VirtualMachinesStartOptionalParams 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 VirtualMachinesListAvailableSizesOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listAvailableSizes operation. */
export type VirtualMachinesListAvailableSizesResponse = VirtualMachineSizeListResult;
/** Optional parameters. */
export interface VirtualMachinesListByLocationNextOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listByLocationNext operation. */
export type VirtualMachinesListByLocationNextResponse = VirtualMachineListResult;
/** Optional parameters. */
export interface VirtualMachinesListAllNextOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listAllNext operation. */
export type VirtualMachinesListAllNextResponse = VirtualMachineListResult;
/** Optional parameters. */
export interface VirtualMachinesListNextOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listNext operation. */
export type VirtualMachinesListNextResponse = VirtualMachineListResult;
/** Optional parameters. */
export interface VirtualMachinesListAvailableSizesNextOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listAvailableSizesNext operation. */
export type VirtualMachinesListAvailableSizesNextResponse = VirtualMachineSizeListResult;
/** Optional parameters. */
export interface VirtualMachineSizesListOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the list operation. */
export type VirtualMachineSizesListResponse = VirtualMachineSizeListResult;
/** Optional parameters. */
export interface VirtualMachineSizesListNextOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listNext operation. */
export type VirtualMachineSizesListNextResponse = VirtualMachineSizeListResult;
/** Optional parameters. */
export interface ProximityPlacementGroupsListBySubscriptionOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listBySubscription operation. */
export type ProximityPlacementGroupsListBySubscriptionResponse = ProximityPlacementGroupListResult;
/** Optional parameters. */
export interface ProximityPlacementGroupsListByResourceGroupOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listByResourceGroup operation. */
export type ProximityPlacementGroupsListByResourceGroupResponse = ProximityPlacementGroupListResult;
/** Optional parameters. */
export interface ProximityPlacementGroupsGetOptionalParams extends coreClient.OperationOptions {
/** includeColocationStatus=true enables fetching the colocation status of all the resources in the proximity placement group. */
includeColocationStatus?: string;
}
/** Contains response data for the get operation. */
export type ProximityPlacementGroupsGetResponse = ProximityPlacementGroup;
/** Optional parameters. */
export interface ProximityPlacementGroupsCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the createOrUpdate operation. */
export type ProximityPlacementGroupsCreateOrUpdateResponse = ProximityPlacementGroup;
/** Optional parameters. */
export interface ProximityPlacementGroupsUpdateOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the update operation. */
export type ProximityPlacementGroupsUpdateResponse = ProximityPlacementGroup;
/** Optional parameters. */
export interface ProximityPlacementGroupsDeleteOptionalParams extends coreClient.OperationOptions {
}
/** Optional parameters. */
export interface ProximityPlacementGroupsListBySubscriptionNextOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listBySubscriptionNext operation. */
export type ProximityPlacementGroupsListBySubscriptionNextResponse = ProximityPlacementGroupListResult;
/** Optional parameters. */
export interface ProximityPlacementGroupsListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listByResourceGroupNext operation. */
export type ProximityPlacementGroupsListByResourceGroupNextResponse = ProximityPlacementGroupListResult;
/** Optional parameters. */
export interface RestorePointCollectionsListAllOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listAll operation. */
export type RestorePointCollectionsListAllResponse = RestorePointCollectionListResult;
/** Optional parameters. */
export interface RestorePointCollectionsListOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the list operation. */
export type RestorePointCollectionsListResponse = RestorePointCollectionListResult;
/** Optional parameters. */
export interface RestorePointCollectionsGetOptionalParams extends coreClient.OperationOptions {
/** The expand expression to apply on the operation. If expand=restorePoints, server will return all contained restore points in the restorePointCollection. */
expand?: RestorePointCollectionExpandOptions;
}
/** Contains response data for the get operation. */
export type RestorePointCollectionsGetResponse = RestorePointCollection;
/** Optional parameters. */
export interface RestorePointCollectionsCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the createOrUpdate operation. */
export type RestorePointCollectionsCreateOrUpdateResponse = RestorePointCollection;
/** Optional parameters. */
export interface RestorePointCollectionsUpdateOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the update operation. */
export type RestorePointCollectionsUpdateResponse = RestorePointCollection;
/** Optional parameters. */
export interface RestorePointCollectionsDeleteOptionalParams 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 RestorePointCollectionsListAllNextOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listAllNext operation. */
export type RestorePointCollectionsListAllNextResponse = RestorePointCollectionListResult;
/** Optional parameters. */
export interface RestorePointCollectionsListNextOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listNext operation. */
export type RestorePointCollectionsListNextResponse = RestorePointCollectionListResult;
/** Optional parameters. */
export interface SshPublicKeysListBySubscriptionOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listBySubscription operation. */
export type SshPublicKeysListBySubscriptionResponse = SshPublicKeysGroupListResult;
/** Optional parameters. */
export interface SshPublicKeysListByResourceGroupOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listByResourceGroup operation. */
export type SshPublicKeysListByResourceGroupResponse = SshPublicKeysGroupListResult;
/** Optional parameters. */
export interface SshPublicKeysGetOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the get operation. */
export type SshPublicKeysGetResponse = SshPublicKeyResource;
/** Optional parameters. */
export interface SshPublicKeysCreateOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the create operation. */
export type SshPublicKeysCreateResponse = SshPublicKeyResource;
/** Optional parameters. */
export interface SshPublicKeysUpdateOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the update operation. */
export type SshPublicKeysUpdateResponse = SshPublicKeyResource;
/** Optional parameters. */
export interface SshPublicKeysDeleteOptionalParams extends coreClient.OperationOptions {
}
/** Optional parameters. */
export interface SshPublicKeysGenerateKeyPairOptionalParams extends coreClient.OperationOptions {
/** Parameters supplied to generate the SSH public key. */
parameters?: SshGenerateKeyPairInputParameters;
}
/** Contains response data for the generateKeyPair operation. */
export type SshPublicKeysGenerateKeyPairResponse = SshPublicKeyGenerateKeyPairResult;
/** Optional parameters. */
export interface SshPublicKeysListBySubscriptionNextOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listBySubscriptionNext operation. */
export type SshPublicKeysListBySubscriptionNextResponse = SshPublicKeysGroupListResult;
/** Optional parameters. */
export interface SshPublicKeysListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listByResourceGroupNext operation. */
export type SshPublicKeysListByResourceGroupNextResponse = SshPublicKeysGroupListResult;
/** Optional parameters. */
export interface CapacityReservationsListByCapacityReservationGroupOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listByCapacityReservationGroup operation. */
export type CapacityReservationsListByCapacityReservationGroupResponse = CapacityReservationListResult;
/** Optional parameters. */
export interface CapacityReservationsGetOptionalParams extends coreClient.OperationOptions {
/** The expand expression to apply on the operation. 'InstanceView' retrieves a snapshot of the runtime properties of the capacity reservation that is managed by the platform and can change outside of control plane operations. */
expand?: CapacityReservationInstanceViewTypes;
}
/** Contains response data for the get operation. */
export type CapacityReservationsGetResponse = CapacityReservation;
/** Optional parameters. */
export interface CapacityReservationsCreateOrUpdateOptionalParams 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 createOrUpdate operation. */
export type CapacityReservationsCreateOrUpdateResponse = CapacityReservation;
/** Optional parameters. */
export interface CapacityReservationsUpdateOptionalParams 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. */
export type CapacityReservationsUpdateResponse = CapacityReservation;
/** Optional parameters. */
export interface CapacityReservationsDeleteOptionalParams 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 CapacityReservationsListByCapacityReservationGroupNextOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listByCapacityReservationGroupNext operation. */
export type CapacityReservationsListByCapacityReservationGroupNextResponse = CapacityReservationListResult;
/** Optional parameters. */
export interface DedicatedHostsListByHostGroupOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listByHostGroup operation. */
export type DedicatedHostsListByHostGroupResponse = DedicatedHostListResult;
/** Optional parameters. */
export interface DedicatedHostsGetOptionalParams extends coreClient.OperationOptions {
/** The expand expression to apply on the operation. 'InstanceView' will retrieve the list of instance views of the dedicated host. 'UserData' is not supported for dedicated host. */
expand?: InstanceViewTypes;
}
/** Contains response data for the get operation. */
export type DedicatedHostsGetResponse = DedicatedHost;
/** Optional parameters. */
export interface DedicatedHostsCreateOrUpdateOptionalParams 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 createOrUpdate operation. */
export type DedicatedHostsCreateOrUpdateResponse = DedicatedHost;
/** Optional parameters. */
export interface DedicatedHostsUpdateOptionalParams 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. */
export type DedicatedHostsUpdateResponse = DedicatedHostsUpdateHeaders & DedicatedHost;
/** Optional parameters. */
export interface DedicatedHostsDeleteOptionalParams 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 DedicatedHostsListAvailableSizesOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listAvailableSizes operation. */
export type DedicatedHostsListAvailableSizesResponse = DedicatedHostSizeListResult;
/** Optional parameters. */
export interface DedicatedHostsRedeployOptionalParams 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 redeploy operation. */
export type DedicatedHostsRedeployResponse = DedicatedHostsRedeployHeaders;
/** Optional parameters. */
export interface DedicatedHostsRestartOptionalParams 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 restart operation. */
export type DedicatedHostsRestartResponse = DedicatedHostsRestartHeaders;
/** Optional parameters. */
export interface DedicatedHostsListByHostGroupNextOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listByHostGroupNext operation. */
export type DedicatedHostsListByHostGroupNextResponse = DedicatedHostListResult;
/** Optional parameters. */
export interface DedicatedHostsListAvailableSizesNextOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listAvailableSizesNext operation. */
export type DedicatedHostsListAvailableSizesNextResponse = DedicatedHostSizeListResult;
/** Optional parameters. */
export interface RestorePointsGetOptionalParams extends coreClient.OperationOptions {
/** The expand expression to apply on the operation. 'InstanceView' retrieves information about the run-time state of a restore point. */
expand?: RestorePointExpandOptions;
}
/** Contains response data for the get operation. */
export type RestorePointsGetResponse = RestorePoint;
/** Optional parameters. */
export interface RestorePointsCreateOptionalParams 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 create operation. */
export type RestorePointsCreateResponse = RestorePointsCreateHeaders & RestorePoint;
/** Optional parameters. */
export interface RestorePointsDeleteOptionalParams 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 VirtualMachineScaleSetRollingUpgradesStartExtensionUpgradeOptionalParams 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 VirtualMachineScaleSetRollingUpgradesStartOSUpgradeOptionalParams 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 VirtualMachineScaleSetRollingUpgradesCancelOptionalParams 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 VirtualMachineScaleSetRollingUpgradesGetLatestOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the getLatest operation. */
export type VirtualMachineScaleSetRollingUpgradesGetLatestResponse = RollingUpgradeStatusInfo;
/** Optional parameters. */
export interface VirtualMachineScaleSetExtensionsListOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the list operation. */
export type VirtualMachineScaleSetExtensionsListResponse = VirtualMachineScaleSetExtensionListResult;
/** Optional parameters. */
export interface VirtualMachineScaleSetExtensionsGetOptionalParams extends coreClient.OperationOptions {
/** The expand expression to apply on the operation. */
expand?: string;
}
/** Contains response data for the get operation. */
export type VirtualMachineScaleSetExtensionsGetResponse = VirtualMachineScaleSetExtension;
/** Optional parameters. */
export interface VirtualMachineScaleSetExtensionsCreateOrUpdateOptionalParams 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 createOrUpdate operation. */
export type VirtualMachineScaleSetExtensionsCreateOrUpdateResponse = VirtualMachineScaleSetExtension;
/** Optional parameters. */
export interface VirtualMachineScaleSetExtensionsUpdateOptionalParams 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. */
export type VirtualMachineScaleSetExtensionsUpdateResponse = VirtualMachineScaleSetExtension;
/** Optional parameters. */
export interface VirtualMachineScaleSetExtensionsDeleteOptionalParams 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 VirtualMachineScaleSetExtensionsListNextOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listNext operation. */
export type VirtualMachineScaleSetExtensionsListNextResponse = VirtualMachineScaleSetExtensionListResult;
/** Optional parameters. */
export interface VirtualMachineScaleSetVMsListOptionalParams extends coreClient.OperationOptions {
/** The expand expression to apply to the operation. Allowed values are 'instanceView'. */
expand?: string;
/** The filter to apply to the operation. Allowed values are 'startswith(instanceView/statuses/code, 'PowerState') eq true', 'properties/latestModelApplied eq true', 'properties/latestModelApplied eq false'. */
filter?: string;
/** The list parameters. Allowed values are 'instanceView', 'instanceView/statuses'. */
select?: string;
}
/** Contains response data for the list operation. */
export type VirtualMachineScaleSetVMsListResponse = VirtualMachineScaleSetVMListResult;
/** Optional parameters. */
export interface VirtualMachineScaleSetVMsGetOptionalParams extends coreClient.OperationOptions {
/** The expand expression to apply on the operation. 'InstanceView' will retrieve the instance view of the virtual machine. 'UserData' will retrieve the UserData of the virtual machine. */
expand?: InstanceViewTypes;
}
/** Contains response data for the get operation. */
export type VirtualMachineScaleSetVMsGetResponse = VirtualMachineScaleSetVM;
/** Optional parameters. */
export interface VirtualMachineScaleSetVMsUpdateOptionalParams extends coreClient.OperationOptions {
/** The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes. */
ifMatch?: string;
/** Set to '*' to allow a new record set to be created, but to prevent updating an existing record set. Other values will result in error from server as they are not supported. */
ifNoneMatch?: string;
/** 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. */
export type VirtualMachineScaleSetVMsUpdateResponse = VirtualMachineScaleSetVM;
/** Optional parameters. */
export interface VirtualMachineScaleSetVMsDeleteOptionalParams extends coreClient.OperationOptions {
/** Optional parameter to force delete a virtual machine from a VM scale set. (Feature in Preview) */
forceDeletion?: boolean;
/** 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 VirtualMachineScaleSetVMsApproveRollingUpgradeOptionalParams 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 approveRollingUpgrade operation. */
export type VirtualMachineScaleSetVMsApproveRollingUpgradeResponse = VirtualMachineScaleSetVMsApproveRollingUpgradeHeaders;
/** Optional parameters. */
export interface VirtualMachineScaleSetVMsAttachDetachDataDisksOptionalParams 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 attachDetachDataDisks operation. */
export type VirtualMachineScaleSetVMsAttachDetachDataDisksResponse = StorageProfile;
/** Optional parameters. */
export interface VirtualMachineScaleSetVMsDeallocateOptionalParams 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 VirtualMachineScaleSetVMsGetInstanceViewOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the getInstanceView operation. */
export type VirtualMachineScaleSetVMsGetInstanceViewResponse = VirtualMachineScaleSetVMInstanceView;
/** Optional parameters. */
export interface VirtualMachineScaleSetVMsPerformMaintenanceOptionalParams 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 VirtualMachineScaleSetVMsPowerOffOptionalParams extends coreClient.OperationOptions {
/** The parameter to request non-graceful VM shutdown. True value for this flag indicates non-graceful shutdown whereas false indicates otherwise. Default value for this flag is false if not specified */
skipShutdown?: boolean;
/** 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 VirtualMachineScaleSetVMsRedeployOptionalParams 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 VirtualMachineScaleSetVMsReimageOptionalParams extends coreClient.OperationOptions {
/** Parameters for the Reimaging Virtual machine in ScaleSet. */
vmScaleSetVMReimageInput?: VirtualMachineScaleSetVMReimageParameters;
/** 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 VirtualMachineScaleSetVMsReimageAllOptionalParams 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 VirtualMachineScaleSetVMsRestartOptionalParams 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 VirtualMachineScaleSetVMsRetrieveBootDiagnosticsDataOptionalParams extends coreClient.OperationOptions {
/** Expiration duration in minutes for the SAS URIs with a value between 1 to 1440 minutes. **Note:** If not specified, SAS URIs will be generated with a default expiration duration of 120 minutes. */
sasUriExpirationTimeInMinutes?: number;
}
/** Contains response data for the retrieveBootDiagnosticsData operation. */
export type VirtualMachineScaleSetVMsRetrieveBootDiagnosticsDataResponse = RetrieveBootDiagnosticsDataResult;
/** Optional parameters. */
export interface VirtualMachineScaleSetVMsRunCommandOptionalParams 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 runCommand operation. */
export type VirtualMachineScaleSetVMsRunCommandResponse = RunCommandResult;
/** Optional parameters. */
export interface VirtualMachineScaleSetVMsSimulateEvictionOptionalParams extends coreClient.OperationOptions {
}
/** Optional parameters. */
export interface VirtualMachineScaleSetVMsStartOptionalParams 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 VirtualMachineScaleSetVMsListNextOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listNext operation. */
export type VirtualMachineScaleSetVMsListNextResponse = VirtualMachineScaleSetVMListResult;
/** Optional parameters. */
export interface VirtualMachineScaleSetVMExtensionsListOptionalParams extends coreClient.OperationOptions {
/** The expand expression to apply on the operation. */
expand?: string;
}
/** Contains response data for the list operation. */
export type VirtualMachineScaleSetVMExtensionsListResponse = VirtualMachineScaleSetVMExtensionsListResult;
/** Optional parameters. */
export interface VirtualMachineScaleSetVMExtensionsGetOptionalParams extends coreClient.OperationOptions {
/** The expand expression to apply on the operation. */
expand?: string;
}
/** Contains response data for the get operation. */
export type VirtualMachineScaleSetVMExtensionsGetResponse = VirtualMachineScaleSetVMExtension;
/** Optional parameters. */
export interface VirtualMachineScaleSetVMExtensionsCreateOrUpdateOptionalParams 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 createOrUpdate operation. */
export type VirtualMachineScaleSetVMExtensionsCreateOrUpdateResponse = VirtualMachineScaleSetVMExtension;
/** Optional parameters. */
export interface VirtualMachineScaleSetVMExtensionsUpdateOptionalParams 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. */
export type VirtualMachineScaleSetVMExtensionsUpdateResponse = VirtualMachineScaleSetVMExtensionsUpdateHeaders & VirtualMachineScaleSetVMExtension;
/** Optional parameters. */
export interface VirtualMachineScaleSetVMExtensionsDeleteOptionalParams 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 VirtualMachineScaleSetVMRunCommandsListOptionalParams extends coreClient.OperationOptions {
/** The expand expression to apply on the operation. */
expand?: string;
}
/** Contains response data for the list operation. */
export type VirtualMachineScaleSetVMRunCommandsListResponse = VirtualMachineRunCommandsListResult;
/** Optional parameters. */
export interface VirtualMachineScaleSetVMRunCommandsGetOptionalParams extends coreClient.OperationOptions {
/** The expand expression to apply on the operation. */
expand?: string;
}
/** Contains response data for the get operation. */
export type VirtualMachineScaleSetVMRunCommandsGetResponse = VirtualMachineRunCommand;
/** Optional parameters. */
export interface VirtualMachineScaleSetVMRunCommandsCreateOrUpdateOptionalParams 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 createOrUpdate operation. */
export type VirtualMachineScaleSetVMRunCommandsCreateOrUpdateResponse = VirtualMachineRunCommand;
/** Optional parameters. */
export interface VirtualMachineScaleSetVMRunCommandsUpdateOptionalParams 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. */
export type VirtualMachineScaleSetVMRunCommandsUpdateResponse = VirtualMachineScaleSetVMRunCommandsUpdateHeaders & VirtualMachineRunCommand;
/** Optional parameters. */
export interface VirtualMachineScaleSetVMRunCommandsDeleteOptionalParams 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 VirtualMachineScaleSetVMRunCommandsListNextOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listNext operation. */
export type VirtualMachineScaleSetVMRunCommandsListNextResponse = VirtualMachineRunCommandsListResult;
/** Optional parameters. */
export interface VirtualMachineExtensionsListOptionalParams extends coreClient.OperationOptions {
/** The expand expression to apply on the operation. */
expand?: string;
}
/** Contains response data for the list operation. */
export type VirtualMachineExtensionsListResponse = VirtualMachineExtensionsListResult;
/** Optional parameters. */
export interface VirtualMachineExtensionsGetOptionalParams extends coreClient.OperationOptions {
/** The expand expression to apply on the operation. */
expand?: string;
}
/** Contains response data for the get operation. */
export type VirtualMachineExtensionsGetResponse = VirtualMachineExtension;
/** Optional parameters. */
export interface VirtualMachineExtensionsCreateOrUpdateOptionalParams 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 createOrUpdate operation. */
export type VirtualMachineExtensionsCreateOrUpdateResponse = VirtualMachineExtension;
/** Optional parameters. */
export interface VirtualMachineExtensionsUpdateOptionalParams 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. */
export type VirtualMachineExtensionsUpdateResponse = VirtualMachineExtensionsUpdateHeaders & VirtualMachineExtension;
/** Optional parameters. */
export interface VirtualMachineExtensionsDeleteOptionalParams 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 DiskAccessesListOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the list operation. */
export type DiskAccessesListResponse = DiskAccessList;
/** Optional parameters. */
export interface DiskAccessesListByResourceGroupOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listByResourceGroup operation. */
export type DiskAccessesListByResourceGroupResponse = DiskAccessList;
/** Optional parameters. */
export interface DiskAccessesGetOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the get operation. */
export type DiskAccessesGetResponse = DiskAccess;
/** Optional parameters. */
export interface DiskAccessesCreateOrUpdateOptionalParams 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 createOrUpdate operation. */
export type DiskAccessesCreateOrUpdateResponse = DiskAccess;
/** Optional parameters. */
export interface DiskAccessesUpdateOptionalParams 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. */
export type DiskAccessesUpdateResponse = DiskAccess;
/** Optional parameters. */
export interface DiskAccessesDeleteOptionalParams 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 DiskAccessesListPrivateEndpointConnectionsOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listPrivateEndpointConnections operation. */
export type DiskAccessesListPrivateEndpointConnectionsResponse = PrivateEndpointConnectionListResult;
/** Optional parameters. */
export interface DiskAccessesGetAPrivateEndpointConnectionOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the getAPrivateEndpointConnection operation. */
export type DiskAccessesGetAPrivateEndpointConnectionResponse = PrivateEndpointConnection;
/** Optional parameters. */
export interface DiskAccessesUpdateAPrivateEndpointConnectionOptionalParams 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 updateAPrivateEndpointConnection operation. */
export type DiskAccessesUpdateAPrivateEndpointConnectionResponse = PrivateEndpointConnection;
/** Optional parameters. */
export interface DiskAccessesDeleteAPrivateEndpointConnectionOptionalParams 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 DiskAccessesGetPrivateLinkResourcesOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the getPrivateLinkResources operation. */
export type DiskAccessesGetPrivateLinkResourcesResponse = PrivateLinkResourceListResult;
/** Optional parameters. */
export interface DiskAccessesListNextOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listNext operation. */
export type DiskAccessesListNextResponse = DiskAccessList;
/** Optional parameters. */
export interface DiskAccessesListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listByResourceGroupNext operation. */
export type DiskAccessesListByResourceGroupNextResponse = DiskAccessList;
/** Optional parameters. */
export interface DiskAccessesListPrivateEndpointConnectionsNextOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listPrivateEndpointConnectionsNext operation. */
export type DiskAccessesListPrivateEndpointConnectionsNextResponse = PrivateEndpointConnectionListResult;
/** Optional parameters. */
export interface DiskEncryptionSetsListOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the list operation. */
export type DiskEncryptionSetsListResponse = DiskEncryptionSetList;
/** Optional parameters. */
export interface DiskEncryptionSetsListByResourceGroupOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listByResourceGroup operation. */
export type DiskEncryptionSetsListByResourceGroupResponse = DiskEncryptionSetList;
/** Optional parameters. */
export interface DiskEncryptionSetsGetOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the get operation. */
export type DiskEncryptionSetsGetResponse = DiskEncryptionSet;
/** Optional parameters. */
export interface DiskEncryptionSetsCreateOrUpdateOptionalParams 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 createOrUpdate operation. */
export type DiskEncryptionSetsCreateOrUpdateResponse = DiskEncryptionSet;
/** Optional parameters. */
export interface DiskEncryptionSetsUpdateOptionalParams 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. */
export type DiskEncryptionSetsUpdateResponse = DiskEncryptionSet;
/** Optional parameters. */
export interface DiskEncryptionSetsDeleteOptionalParams 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 DiskEncryptionSetsListAssociatedResourcesOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listAssociatedResources operation. */
export type DiskEncryptionSetsListAssociatedResourcesResponse = ResourceUriList;
/** Optional parameters. */
export interface DiskEncryptionSetsListNextOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listNext operation. */
export type DiskEncryptionSetsListNextResponse = DiskEncryptionSetList;
/** Optional parameters. */
export interface DiskEncryptionSetsListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listByResourceGroupNext operation. */
export type DiskEncryptionSetsListByResourceGroupNextResponse = DiskEncryptionSetList;
/** Optional parameters. */
export interface DiskEncryptionSetsListAssociatedResourcesNextOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listAssociatedResourcesNext operation. */
export type DiskEncryptionSetsListAssociatedResourcesNextResponse = ResourceUriList;
/** Optional parameters. */
export interface DisksListOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the list operation. */
export type DisksListResponse = DiskList;
/** Optional parameters. */
export interface DisksListByResourceGroupOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listByResourceGroup operation. */
export type DisksListByResourceGroupResponse = DiskList;
/** Optional parameters. */
export interface DisksGetOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the get operation. */
export type DisksGetResponse = Disk;
/** Optional parameters. */
export interface DisksCreateOrUpdateOptionalParams 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 createOrUpdate operation. */
export type DisksCreateOrUpdateResponse = Disk;
/** Optional parameters. */
export interface DisksUpdateOptionalParams 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. */
export type DisksUpdateResponse = Disk;
/** Optional parameters. */
export interface DisksDeleteOptionalParams 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 DisksGrantAccessOptionalParams 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 grantAccess operation. */
export type DisksGrantAccessResponse = AccessUri;
/** Optional parameters. */
export interface DisksRevokeAccessOptionalParams 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 DisksListNextOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listNext operation. */
export type DisksListNextResponse = DiskList;
/** Optional parameters. */
export interface DisksListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listByResourceGroupNext operation. */
export type DisksListByResourceGroupNextResponse = DiskList;
/** Optional parameters. */
export interface SnapshotsListOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the list operation. */
export type SnapshotsListResponse = SnapshotList;
/** Optional parameters. */
export interface SnapshotsListByResourceGroupOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listByResourceGroup operation. */
export type SnapshotsListByResourceGroupResponse = SnapshotList;
/** Optional parameters. */
export interface SnapshotsGetOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the get operation. */
export type SnapshotsGetResponse = Snapshot;
/** Optional parameters. */
export interface SnapshotsCreateOrUpdateOptionalParams 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 createOrUpdate operation. */
export type SnapshotsCreateOrUpdateResponse = Snapshot;
/** Optional parameters. */
export interface SnapshotsUpdateOptionalParams 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. */
export type SnapshotsUpdateResponse = Snapshot;
/** Optional parameters. */
export interface SnapshotsDeleteOptionalParams 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 SnapshotsGrantAccessOptionalParams 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 grantAccess operation. */
export type SnapshotsGrantAccessResponse = AccessUri;
/** Optional parameters. */
export interface SnapshotsRevokeAccessOptionalParams 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 SnapshotsListNextOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listNext operation. */
export type SnapshotsListNextResponse = SnapshotList;
/** Optional parameters. */
export interface SnapshotsListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listByResourceGroupNext operation. */
export type SnapshotsListByResourceGroupNextResponse = SnapshotList;
/** Optional parameters. */
export interface DiskRestorePointListByRestorePointOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listByRestorePoint operation. */
export type DiskRestorePointListByRestorePointResponse = DiskRestorePointList;
/** Optional parameters. */
export interface DiskRestorePointGetOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the get operation. */
export type DiskRestorePointGetResponse = DiskRestorePoint;
/** Optional parameters. */
export interface DiskRestorePointGrantAccessOptionalParams 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 grantAccess operation. */
export type DiskRestorePointGrantAccessResponse = AccessUri;
/** Optional parameters. */
export interface DiskRestorePointRevokeAccessOptionalParams 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 DiskRestorePointListByRestorePointNextOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listByRestorePointNext operation. */
export type DiskRestorePointListByRestorePointNextResponse = DiskRestorePointList;
/** Optional parameters. */
export interface ResourceSkusListOptionalParams extends coreClient.OperationOptions {
/** The filter to apply on the operation. Only **location** filter is supported currently. */
filter?: string;
/** To Include Extended Locations information or not in the response. */
includeExtendedLocations?: string;
}
/** Contains response data for the list operation. */
export type ResourceSkusListResponse = ResourceSkusResult;
/** Optional parameters. */
export interface ResourceSkusListNextOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listNext operation. */
export type ResourceSkusListNextResponse = ResourceSkusResult;
/** Optional parameters. */
export interface GalleriesListOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the list operation. */
export type GalleriesListResponse = GalleryList;
/** Optional parameters. */
export interface GalleriesListByResourceGroupOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listByResourceGroup operation. */
export type GalleriesListByResourceGroupResponse = GalleryList;
/** Optional parameters. */
export interface GalleriesGetOptionalParams extends coreClient.OperationOptions {
/** The select expression to apply on the operation. */
select?: SelectPermissions;
/** The expand query option to apply on the operation. */
expand?: GalleryExpandParams;
}
/** Contains response data for the get operation. */
export type GalleriesGetResponse = Gallery;
/** Optional parameters. */
export interface GalleriesCreateOrUpdateOptionalParams 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 createOrUpdate operation. */
export type GalleriesCreateOrUpdateResponse = Gallery;
/** Optional parameters. */
export interface GalleriesUpdateOptionalParams 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. */
export type GalleriesUpdateResponse = GalleriesUpdateHeaders & Gallery;
/** Optional parameters. */
export interface GalleriesDeleteOptionalParams 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 GalleriesListNextOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listNext operation. */
export type GalleriesListNextResponse = GalleryList;
/** Optional parameters. */
export interface GalleriesListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listByResourceGroupNext operation. */
export type GalleriesListByResourceGroupNextResponse = GalleryList;
/** Optional parameters. */
export interface CommunityGalleriesGetOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the get operation. */
export type CommunityGalleriesGetResponse = CommunityGallery;
/** Optional parameters. */
export interface CommunityGalleryImagesListOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the list operation. */
export type CommunityGalleryImagesListResponse = CommunityGalleryImageList;
/** Optional parameters. */
export interface CommunityGalleryImagesGetOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the get operation. */
export type CommunityGalleryImagesGetResponse = CommunityGalleryImage;
/** Optional parameters. */
export interface CommunityGalleryImagesListNextOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listNext operation. */
export type CommunityGalleryImagesListNextResponse = CommunityGalleryImageList;
/** Optional parameters. */
export interface CommunityGalleryImageVersionsListOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the list operation. */
export type CommunityGalleryImageVersionsListResponse = CommunityGalleryImageVersionList;
/** Optional parameters. */
export interface CommunityGalleryImageVersionsGetOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the get operation. */
export type CommunityGalleryImageVersionsGetResponse = CommunityGalleryImageVersion;
/** Optional parameters. */
export interface CommunityGalleryImageVersionsListNextOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listNext operation. */
export type CommunityGalleryImageVersionsListNextResponse = CommunityGalleryImageVersionList;
/** Optional parameters. */
export interface SharedGalleriesListOptionalParams extends coreClient.OperationOptions {
/** The query parameter to decide what shared galleries to fetch when doing listing operations. */
sharedTo?: SharedToValues;
}
/** Contains response data for the list operation. */
export type SharedGalleriesListResponse = SharedGalleryList;
/** Optional parameters. */
export interface SharedGalleriesGetOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the get operation. */
export type SharedGalleriesGetResponse = SharedGallery;
/** Optional parameters. */
export interface SharedGalleriesListNextOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listNext operation. */
export type SharedGalleriesListNextResponse = SharedGalleryList;
/** Optional parameters. */
export interface SharedGalleryImagesListOptionalParams extends coreClient.OperationOptions {
/** The query parameter to decide what shared galleries to fetch when doing listing operations. */
sharedTo?: SharedToValues;
}
/** Contains response data for the list operation. */
export type SharedGalleryImagesListResponse = SharedGalleryImageList;
/** Optional parameters. */
export interface SharedGalleryImagesGetOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the get operation. */
export type SharedGalleryImagesGetResponse = SharedGalleryImage;
/** Optional parameters. */
export interface SharedGalleryImagesListNextOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listNext operation. */
export type SharedGalleryImagesListNextResponse = SharedGalleryImageList;
/** Optional parameters. */
export interface SharedGalleryImageVersionsListOptionalParams extends coreClient.OperationOptions {
/** The query parameter to decide what shared galleries to fetch when doing listing operations. */
sharedTo?: SharedToValues;
}
/** Contains response data for the list operation. */
export type SharedGalleryImageVersionsListResponse = SharedGalleryImageVersionList;
/** Optional parameters. */
export interface SharedGalleryImageVersionsGetOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the get operation. */
export type SharedGalleryImageVersionsGetResponse = SharedGalleryImageVersion;
/** Optional parameters. */
export interface SharedGalleryImageVersionsListNextOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listNext operation. */
export type SharedGalleryImageVersionsListNextResponse = SharedGalleryImageVersionList;
/** Optional parameters. */
export interface GalleryApplicationsListByGalleryOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listByGallery operation. */
export type GalleryApplicationsListByGalleryResponse = GalleryApplicationList;
/** Optional parameters. */
export interface GalleryApplicationsGetOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the get operation. */
export type GalleryApplicationsGetResponse = GalleryApplication;
/** Optional parameters. */
export interface GalleryApplicationsCreateOrUpdateOptionalParams 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 createOrUpdate operation. */
export type GalleryApplicationsCreateOrUpdateResponse = GalleryApplication;
/** Optional parameters. */
export interface GalleryApplicationsUpdateOptionalParams 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. */
export type GalleryApplicationsUpdateResponse = GalleryApplicationsUpdateHeaders & GalleryApplication;
/** Optional parameters. */
export interface GalleryApplicationsDeleteOptionalParams 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 GalleryApplicationsListByGalleryNextOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listByGalleryNext operation. */
export type GalleryApplicationsListByGalleryNextResponse = GalleryApplicationList;
/** Optional parameters. */
export interface GalleryApplicationVersionsListByGalleryApplicationOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listByGalleryApplication operation. */
export type GalleryApplicationVersionsListByGalleryApplicationResponse = GalleryApplicationVersionList;
/** Optional parameters. */
export interface GalleryApplicationVersionsGetOptionalParams extends coreClient.OperationOptions {
/** The expand expression to apply on the operation. */
expand?: ReplicationStatusTypes;
}
/** Contains response data for the get operation. */
export type GalleryApplicationVersionsGetResponse = GalleryApplicationVersion;
/** Optional parameters. */
export interface GalleryApplicationVersionsCreateOrUpdateOptionalParams 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 createOrUpdate operation. */
export type GalleryApplicationVersionsCreateOrUpdateResponse = GalleryApplicationVersion;
/** Optional parameters. */
export interface GalleryApplicationVersionsUpdateOptionalParams 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. */
export type GalleryApplicationVersionsUpdateResponse = GalleryApplicationVersionsUpdateHeaders & GalleryApplicationVersion;
/** Optional parameters. */
export interface GalleryApplicationVersionsDeleteOptionalParams 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 GalleryApplicationVersionsListByGalleryApplicationNextOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listByGalleryApplicationNext operation. */
export type GalleryApplicationVersionsListByGalleryApplicationNextResponse = GalleryApplicationVersionList;
/** Optional parameters. */
export interface GalleryImagesListByGalleryOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listByGallery operation. */
export type GalleryImagesListByGalleryResponse = GalleryImageList;
/** Optional parameters. */
export interface GalleryImagesGetOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the get operation. */
export type GalleryImagesGetResponse = GalleryImage;
/** Optional parameters. */
export interface GalleryImagesCreateOrUpdateOptionalParams 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 createOrUpdate operation. */
export type GalleryImagesCreateOrUpdateResponse = GalleryImage;
/** Optional parameters. */
export interface GalleryImagesUpdateOptionalParams 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. */
export type GalleryImagesUpdateResponse = GalleryImagesUpdateHeaders & GalleryImage;
/** Optional parameters. */
export interface GalleryImagesDeleteOptionalParams 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 GalleryImagesListByGalleryNextOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listByGalleryNext operation. */
export type GalleryImagesListByGalleryNextResponse = GalleryImageList;
/** Optional parameters. */
export interface GalleryImageVersionsListByGalleryImageOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listByGalleryImage operation. */
export type GalleryImageVersionsListByGalleryImageResponse = GalleryImageVersionList;
/** Optional parameters. */
export interface GalleryImageVersionsGetOptionalParams extends coreClient.OperationOptions {
/** The expand expression to apply on the operation. */
expand?: ReplicationStatusTypes;
}
/** Contains response data for the get operation. */
export type GalleryImageVersionsGetResponse = GalleryImageVersion;
/** Optional parameters. */
export interface GalleryImageVersionsCreateOrUpdateOptionalParams 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 createOrUpdate operation. */
export type GalleryImageVersionsCreateOrUpdateResponse = GalleryImageVersion;
/** Optional parameters. */
export interface GalleryImageVersionsUpdateOptionalParams 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. */
export type GalleryImageVersionsUpdateResponse = GalleryImageVersionsUpdateHeaders & GalleryImageVersion;
/** Optional parameters. */
export interface GalleryImageVersionsDeleteOptionalParams 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 GalleryImageVersionsListByGalleryImageNextOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listByGalleryImageNext operation. */
export type GalleryImageVersionsListByGalleryImageNextResponse = GalleryImageVersionList;
/** Optional parameters. */
export interface GalleryInVMAccessControlProfilesListByGalleryOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listByGallery operation. */
export type GalleryInVMAccessControlProfilesListByGalleryResponse = GalleryInVMAccessControlProfileList;
/** Optional parameters. */
export interface GalleryInVMAccessControlProfilesGetOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the get operation. */
export type GalleryInVMAccessControlProfilesGetResponse = GalleryInVMAccessControlProfile;
/** Optional parameters. */
export interface GalleryInVMAccessControlProfilesCreateOrUpdateOptionalParams 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 createOrUpdate operation. */
export type GalleryInVMAccessControlProfilesCreateOrUpdateResponse = GalleryInVMAccessControlProfile;
/** Optional parameters. */
export interface GalleryInVMAccessControlProfilesUpdateOptionalParams 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. */
export type GalleryInVMAccessControlProfilesUpdateResponse = GalleryInVMAccessControlProfilesUpdateHeaders & GalleryInVMAccessControlProfile;
/** Optional parameters. */
export interface GalleryInVMAccessControlProfilesDeleteOptionalParams 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 delete operation. */
export type GalleryInVMAccessControlProfilesDeleteResponse = GalleryInVMAccessControlProfilesDeleteHeaders;
/** Optional parameters. */
export interface GalleryInVMAccessControlProfilesListByGalleryNextOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listByGalleryNext operation. */
export type GalleryInVMAccessControlProfilesListByGalleryNextResponse = GalleryInVMAccessControlProfileList;
/** Optional parameters. */
export interface GalleryInVMAccessControlProfileVersionsListByGalleryInVMAccessControlProfileOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listByGalleryInVMAccessControlProfile operation. */
export type GalleryInVMAccessControlProfileVersionsListByGalleryInVMAccessControlProfileResponse = GalleryInVMAccessControlProfileVersionList;
/** Optional parameters. */
export interface GalleryInVMAccessControlProfileVersionsGetOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the get operation. */
export type GalleryInVMAccessControlProfileVersionsGetResponse = GalleryInVMAccessControlProfileVersion;
/** Optional parameters. */
export interface GalleryInVMAccessControlProfileVersionsCreateOrUpdateOptionalParams 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 createOrUpdate operation. */
export type GalleryInVMAccessControlProfileVersionsCreateOrUpdateResponse = GalleryInVMAccessControlProfileVersion;
/** Optional parameters. */
export interface GalleryInVMAccessControlProfileVersionsUpdateOptionalParams 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. */
export type GalleryInVMAccessControlProfileVersionsUpdateResponse = GalleryInVMAccessControlProfileVersionsUpdateHeaders & GalleryInVMAccessControlProfileVersion;
/** Optional parameters. */
export interface GalleryInVMAccessControlProfileVersionsDeleteOptionalParams 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 delete operation. */
export type GalleryInVMAccessControlProfileVersionsDeleteResponse = GalleryInVMAccessControlProfileVersionsDeleteHeaders;
/** Optional parameters. */
export interface GalleryInVMAccessControlProfileVersionsListByGalleryInVMAccessControlProfileNextOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listByGalleryInVMAccessControlProfileNext operation. */
export type GalleryInVMAccessControlProfileVersionsListByGalleryInVMAccessControlProfileNextResponse = GalleryInVMAccessControlProfileVersionList;
/** Optional parameters. */
export interface GallerySharingProfileUpdateOptionalParams 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. */
export type GallerySharingProfileUpdateResponse = SharingUpdate;
/** Optional parameters. */
export interface SoftDeletedResourceListByArtifactNameOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listByArtifactName operation. */
export type SoftDeletedResourceListByArtifactNameResponse = GallerySoftDeletedResourceList;
/** Optional parameters. */
export interface SoftDeletedResourceListByArtifactNameNextOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listByArtifactNameNext operation. */
export type SoftDeletedResourceListByArtifactNameNextResponse = GallerySoftDeletedResourceList;
/** Optional parameters. */
export interface CloudServiceRoleInstancesDeleteOptionalParams 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 CloudServiceRoleInstancesGetOptionalParams extends coreClient.OperationOptions {
/** The expand expression to apply to the operation. 'UserData' is not supported for cloud services. */
expand?: InstanceViewTypes;
}
/** Contains response data for the get operation. */
export type CloudServiceRoleInstancesGetResponse = RoleInstance;
/** Optional parameters. */
export interface CloudServiceRoleInstancesGetInstanceViewOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the getInstanceView operation. */
export type CloudServiceRoleInstancesGetInstanceViewResponse = RoleInstanceView;
/** Optional parameters. */
export interface CloudServiceRoleInstancesListOptionalParams extends coreClient.OperationOptions {
/** The expand expression to apply to the operation. 'UserData' is not supported for cloud services. */
expand?: InstanceViewTypes;
}
/** Contains response data for the list operation. */
export type CloudServiceRoleInstancesListResponse = RoleInstanceListResult;
/** Optional parameters. */
export interface CloudServiceRoleInstancesRestartOptionalParams 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 CloudServiceRoleInstancesReimageOptionalParams 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 CloudServiceRoleInstancesRebuildOptionalParams 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 CloudServiceRoleInstancesGetRemoteDesktopFileOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the getRemoteDesktopFile operation. */
export type CloudServiceRoleInstancesGetRemoteDesktopFileResponse = {
/**
* BROWSER ONLY
*
* The response body as a browser Blob.
* Always `undefined` in node.js.
*/
blobBody?: Promise<Blob>;
/**
* NODEJS ONLY
*
* The response body as a node.js Readable stream.
* Always `undefined` in the browser.
*/
readableStreamBody?: NodeJS.ReadableStream;
};
/** Optional parameters. */
export interface CloudServiceRoleInstancesListNextOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listNext operation. */
export type CloudServiceRoleInstancesListNextResponse = RoleInstanceListResult;
/** Optional parameters. */
export interface CloudServiceRolesGetOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the get operation. */
export type CloudServiceRolesGetResponse = CloudServiceRole;
/** Optional parameters. */
export interface CloudServiceRolesListOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the list operation. */
export type CloudServiceRolesListResponse = CloudServiceRoleListResult;
/** Optional parameters. */
export interface CloudServiceRolesListNextOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listNext operation. */
export type CloudServiceRolesListNextResponse = CloudServiceRoleListResult;
/** Optional parameters. */
export interface CloudServicesCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
/** The cloud service object. */
parameters?: CloudService;
/** 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 createOrUpdate operation. */
export type CloudServicesCreateOrUpdateResponse = CloudService;
/** Optional parameters. */
export interface CloudServicesUpdateOptionalParams extends coreClient.OperationOptions {
/** The cloud service object. */
parameters?: CloudServiceUpdate;
/** 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. */
export type CloudServicesUpdateResponse = CloudService;
/** Optional parameters. */
export interface CloudServicesDeleteOptionalParams 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 CloudServicesGetOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the get operation. */
export type CloudServicesGetResponse = CloudService;
/** Optional parameters. */
export interface CloudServicesGetInstanceViewOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the getInstanceView operation. */
export type CloudServicesGetInstanceViewResponse = CloudServiceInstanceView;
/** Optional parameters. */
export interface CloudServicesListAllOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listAll operation. */
export type CloudServicesListAllResponse = CloudServiceListResult;
/** Optional parameters. */
export interface CloudServicesListOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the list operation. */
export type CloudServicesListResponse = CloudServiceListResult;
/** Optional parameters. */
export interface CloudServicesStartOptionalParams 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 CloudServicesPowerOffOptionalParams 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 CloudServicesRestartOptionalParams extends coreClient.OperationOptions {
/** List of cloud service role instance names. */
parameters?: RoleInstances;
/** 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 CloudServicesReimageOptionalParams extends coreClient.OperationOptions {
/** List of cloud service role instance names. */
parameters?: RoleInstances;
/** 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 CloudServicesRebuildOptionalParams extends coreClient.OperationOptions {
/** List of cloud service role instance names. */
parameters?: RoleInstances;
/** 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 CloudServicesDeleteInstancesOptionalParams extends coreClient.OperationOptions {
/** List of cloud service role instance names. */
parameters?: RoleInstances;
/** 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 CloudServicesListAllNextOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listAllNext operation. */
export type CloudServicesListAllNextResponse = CloudServiceListResult;
/** Optional parameters. */
export interface CloudServicesListNextOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listNext operation. */
export type CloudServicesListNextResponse = CloudServiceListResult;
/** Optional parameters. */
export interface CloudServicesUpdateDomainWalkUpdateDomainOptionalParams extends coreClient.OperationOptions {
/** The update domain object. */
parameters?: UpdateDomain;
/** 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 CloudServicesUpdateDomainGetUpdateDomainOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the getUpdateDomain operation. */
export type CloudServicesUpdateDomainGetUpdateDomainResponse = UpdateDomain;
/** Optional parameters. */
export interface CloudServicesUpdateDomainListUpdateDomainsOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listUpdateDomains operation. */
export type CloudServicesUpdateDomainListUpdateDomainsResponse = UpdateDomainListResult;
/** Optional parameters. */
export interface CloudServicesUpdateDomainListUpdateDomainsNextOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listUpdateDomainsNext operation. */
export type CloudServicesUpdateDomainListUpdateDomainsNextResponse = UpdateDomainListResult;
/** Optional parameters. */
export interface CloudServiceOperatingSystemsGetOSVersionOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the getOSVersion operation. */
export type CloudServiceOperatingSystemsGetOSVersionResponse = OSVersion;
/** Optional parameters. */
export interface CloudServiceOperatingSystemsListOSVersionsOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listOSVersions operation. */
export type CloudServiceOperatingSystemsListOSVersionsResponse = OSVersionListResult;
/** Optional parameters. */
export interface CloudServiceOperatingSystemsGetOSFamilyOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the getOSFamily operation. */
export type CloudServiceOperatingSystemsGetOSFamilyResponse = OSFamily;
/** Optional parameters. */
export interface CloudServiceOperatingSystemsListOSFamiliesOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listOSFamilies operation. */
export type CloudServiceOperatingSystemsListOSFamiliesResponse = OSFamilyListResult;
/** Optional parameters. */
export interface CloudServiceOperatingSystemsListOSVersionsNextOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listOSVersionsNext operation. */
export type CloudServiceOperatingSystemsListOSVersionsNextResponse = OSVersionListResult;
/** Optional parameters. */
export interface CloudServiceOperatingSystemsListOSFamiliesNextOptionalParams extends coreClient.OperationOptions {
}
/** Contains response data for the listOSFamiliesNext operation. */
export type CloudServiceOperatingSystemsListOSFamiliesNextResponse = OSFamilyListResult;
/** Optional parameters. */
export interface ComputeManagementClientOptionalParams extends coreClient.ServiceClientOptions {
/** server parameter */
$host?: string;
/** Overrides client endpoint. */
endpoint?: string;
}
//# sourceMappingURL=index.d.ts.map