@azure/arm-computefleet package
Classes
AzureFleetClient |
Interfaces
AdditionalCapabilities |
AdditionalCapabilities for VM. |
AdditionalLocationsProfile |
Represents the configuration for additional locations where Fleet resources may be deployed. |
AdditionalUnattendContent |
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. |
ApiEntityReference |
The API entity reference. |
ApiError |
ApiError for Fleet |
ApiErrorBase |
API error base. |
ApplicationProfile |
Contains the list of gallery applications that should be made available to the VM/VMSS |
AzureFleetClientOptionalParams |
Optional parameters for the client. |
BaseVirtualMachineProfile |
Describes the base virtual machine profile for fleet |
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. |
CapacityReservationProfile |
The parameters of a capacity reservation Profile. |
ComputeProfile |
Compute Profile to use for running user's workloads. |
DiagnosticsProfile |
Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15. |
DiffDiskSettings |
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. |
DiskEncryptionSetParameters |
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. |
EncryptionIdentity |
Specifies the Managed Identity used by ADE to get access token for keyvault operations. |
Fleet |
An Compute Fleet resource |
FleetProperties |
Details of the Compute Fleet. |
FleetUpdate |
Fleet Update Model |
FleetsCreateOrUpdateOptionalParams |
Optional parameters. |
FleetsDeleteOptionalParams |
Optional parameters. |
FleetsGetOptionalParams |
Optional parameters. |
FleetsListByResourceGroupOptionalParams |
Optional parameters. |
FleetsListBySubscriptionOptionalParams |
Optional parameters. |
FleetsListVirtualMachineScaleSetsOptionalParams |
Optional parameters. |
FleetsOperations |
Interface representing a Fleets operations. |
FleetsUpdateOptionalParams |
Optional parameters. |
ImageReference |
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. |
InnerError |
Inner error details. |
KeyVaultSecretReference |
Describes a reference to Key Vault Secret |
LinuxConfiguration |
Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see Linux on Azure-Endorsed Distributions. |
LinuxPatchSettings |
Specifies settings related to VM Guest Patching on Linux. |
LinuxVMGuestPatchAutomaticByPlatformSettings |
Specifies additional settings to be applied when patch mode AutomaticByPlatform is selected in Linux patch settings. |
LocationProfile |
Represents the profile for a single additional location in the Fleet. The location and the virtualMachineProfileOverride (optional). |
ManagedServiceIdentity |
Managed service identity (system assigned and/or user assigned identities) |
ManagedServiceIdentityUpdate |
The template for adding optional properties. |
OSImageNotificationProfile |
Specifies OS Image Scheduled Event related configurations. |
Operation |
Details of a REST API operation, returned from the Resource Provider Operations API |
OperationDisplay |
Localized display information for and operation. |
OperationsListOptionalParams |
Optional parameters. |
OperationsOperations |
Interface representing a Operations operations. |
PageSettings |
Options for the byPage method |
PagedAsyncIterableIterator |
An interface that allows async iterable iteration both to completion and by page. |
PatchSettings |
Specifies settings related to VM Guest Patching on Windows. |
Plan |
Plan for the resource. |
ProxyAgentSettings |
Specifies ProxyAgent settings while creating the virtual machine. Minimum api-version: 2023-09-01. |
PublicIPAddressSku |
Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible. |
RegularPriorityProfile |
Configuration Options for Regular instances in Compute Fleet. |
Resource |
Common fields that are returned in the response for all Azure Resource Manager resources |
ResourcePlanUpdate |
The template for adding optional properties. |
RestorePollerOptions | |
ScheduledEventsProfile |
Specifies Scheduled Event related configurations. |
SecurityPostureReference |
Specifies the security posture to be used for all virtual machines in the scale set. Minimum api-version: 2023-03-01 |
SecurityProfile |
Specifies the Security profile settings for the virtual machine or virtual machine scale set. |
ServiceArtifactReference |
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 |
SpotPriorityProfile |
Configuration Options for Spot instances in Compute Fleet. |
SshConfiguration |
SSH configuration for Linux based VMs running on Azure |
SshPublicKey |
Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed. |
SubResource |
Describes SubResource |
SystemData |
Metadata pertaining to creation and last modification of the resource. |
TerminateNotificationProfile |
Specifies Terminate Scheduled Event related configurations. |
TrackedResource |
The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location' |
UefiSettings |
Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum api-version: 2020-12-01. |
UserAssignedIdentity |
User assigned identity properties |
VMAttributeMinMaxDouble |
VMAttributes using double values. |
VMAttributeMinMaxInteger |
While retrieving VMSizes from CRS, Min = 0 (uint.MinValue) if not specified, Max = 4294967295 (uint.MaxValue) if not specified. This allows to filter VMAttributes on all available VMSizes. |
VMAttributes |
VMAttributes that will be used to filter VMSizes which will be used to build Fleet. |
VMDiskSecurityProfile |
Specifies the security profile settings for the managed disk. Note: It can only be set for Confidential VMs. |
VMGalleryApplication |
Specifies the required information to reference a compute gallery application version |
VMSizeProperties |
Specifies VM Size Property settings on the virtual machine. |
VaultCertificate |
Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM. |
VaultSecretGroup |
Describes a set of certificates which are all in the same Key Vault. |
VirtualHardDisk |
Describes the uri of a disk. |
VirtualMachineScaleSet |
An AzureFleet's virtualMachineScaleSet |
VirtualMachineScaleSetDataDisk |
Describes a virtual machine scale set data disk. |
VirtualMachineScaleSetExtension |
Describes a Virtual Machine Scale Set Extension. |
VirtualMachineScaleSetExtensionProfile |
Describes a virtual machine scale set extension profile. |
VirtualMachineScaleSetExtensionProperties |
Describes the properties of a Virtual Machine Scale Set Extension. |
VirtualMachineScaleSetHardwareProfile |
Specifies the hardware settings for the virtual machine scale set. |
VirtualMachineScaleSetIPConfiguration |
Describes a virtual machine scale set network profile's IP configuration. |
VirtualMachineScaleSetIPConfigurationProperties |
Describes a virtual machine scale set network profile's IP configuration properties. |
VirtualMachineScaleSetIpTag |
Contains the IP tag associated with the public IP address. |
VirtualMachineScaleSetManagedDiskParameters |
Describes the parameters of a ScaleSet managed disk. |
VirtualMachineScaleSetNetworkConfiguration |
Describes a virtual machine scale set network profile's network configurations. |
VirtualMachineScaleSetNetworkConfigurationDnsSettings |
Describes a virtual machines scale sets network configuration's DNS settings. |
VirtualMachineScaleSetNetworkConfigurationProperties |
Describes a virtual machine scale set network profile's IP configuration. |
VirtualMachineScaleSetNetworkProfile |
Describes a virtual machine scale set network profile. |
VirtualMachineScaleSetOSDisk |
Describes a virtual machine scale set operating system disk. |
VirtualMachineScaleSetOSProfile |
Describes a virtual machine scale set OS profile. |
VirtualMachineScaleSetPublicIPAddressConfiguration |
Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration |
VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings |
Describes a virtual machines scale sets network configuration's DNS settings. |
VirtualMachineScaleSetPublicIPAddressConfigurationProperties |
Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration |
VirtualMachineScaleSetStorageProfile |
Describes a virtual machine scale set storage profile. |
VmSizeProfile |
Specifications about a VM Size. This will also contain the corresponding rank and weight in future. |
WinRMConfiguration |
Describes Windows Remote Management configuration of the VM |
WinRMListener |
Describes Protocol and thumbprint of Windows Remote Management listener |
WindowsConfiguration |
Specifies Windows operating system settings on the virtual machine. |
WindowsVMGuestPatchAutomaticByPlatformSettings |
Specifies additional settings to be applied when patch mode AutomaticByPlatform is selected in Windows patch settings. |
Type Aliases
AcceleratorManufacturer |
Accelerator manufacturers supported by Azure VMs. Known values supported by the serviceAMD: AMD GpuType |
AcceleratorType |
Accelerator types supported by Azure VMs. Known values supported by the serviceGPU: GPU Accelerator |
ActionType |
Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. Known values supported by the serviceInternal: Actions are for internal-only APIs. |
ArchitectureType |
Architecture types supported by Azure VMs. Known values supported by the serviceARM64: ARM64 Architecture |
CachingTypes |
Specifies the caching requirements. Known values supported by the serviceNone: 'None' is default for Standard Storage |
ContinuablePage |
An interface that describes a page of results. |
CpuManufacturer |
Cpu Manufacturers supported by Azure VMs. Known values supported by the serviceIntel: Intel CPU. |
CreatedByType |
The kind of entity that created the resource. Known values supported by the serviceUser: The entity was created by a user. |
DeleteOptions |
Specify what happens to the network interface when the VM is deleted Known values supported by the serviceDelete: Delete Option |
DiffDiskOptions |
Specifies the ephemeral disk option for operating system disk. Known values supported by the serviceLocal: Local Option. |
DiffDiskPlacement |
Specifies the ephemeral disk placement for operating system disk. This property
can be used by user in the request to choose the location i.e, cache disk or
resource disk space for Ephemeral OS disk provisioning. For more information on
Ephemeral OS disk size requirements, please refer Ephemeral OS disk size
requirements for Windows VM at
https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements
and Linux VM at
https://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements
Minimum api-version for NvmeDisk: 2024-03-01. Known values supported by the serviceCacheDisk: CacheDisk option. |
DiskControllerTypes |
Specifies the disk controller type configured for the VM and
VirtualMachineScaleSet. This property is only supported for virtual machines
whose operating system disk and VM sku supports Generation 2
(https://docs.microsoft.com/en-us/azure/virtual-machines/generation-2), please
check the HyperVGenerations capability returned as part of VM sku capabilities
in the response of Microsoft.Compute SKUs api for the region contains V2
(https://docs.microsoft.com/rest/api/compute/resourceskus/list). For more
information about Disk Controller Types supported please refer to
https://aka.ms/azure-diskcontrollertypes. Known values supported by the serviceSCSI: SCSI disk type |
DiskCreateOptionTypes |
Specifies how the virtual machine should be created. Known values supported by the serviceFromImage: 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. |
DiskDeleteOptionTypes |
Specifies the behavior of the managed disk when the VM gets deleted, for
example whether the managed disk is deleted or detached. Supported values are:
Delete. If this value is used, the managed disk is deleted when VM gets
deleted. Detach. If this value is used, the managed disk is retained after
VM gets deleted. Minimum api-version: 2021-03-01. Known values supported by the serviceDelete: If this value is used, the managed disk is deleted when VM gets deleted. |
DomainNameLabelScopeTypes |
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 Known values supported by the serviceTenantReuse: TenantReuse type |
EvictionPolicy |
Different kind of eviction policies Known values supported by the serviceDelete: When evicted, the Spot VM will be deleted and the corresponding capacity will be updated to reflect this. |
IPVersion |
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'. Known values supported by the serviceIPv4: IPv4 version |
LinuxPatchAssessmentMode |
Specifies the mode of VM Guest Patch Assessment for the IaaS virtual
machine. Known values supported by the serviceImageDefault: You control the timing of patch assessments on a virtual machine. |
LinuxVMGuestPatchAutomaticByPlatformRebootSetting |
Specifies the reboot setting for all AutomaticByPlatform patch installation
operations. Known values supported by the serviceUnknown: Unknown Reboot setting |
LinuxVMGuestPatchMode |
Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual
machines associated to virtual machine scale set with OrchestrationMode as
Flexible. Known values supported by the serviceImageDefault: The virtual machine's default patching configuration is used. |
LocalStorageDiskType |
Different kind of Local storage disk types supported by Azure VMs. Known values supported by the serviceHDD: HDD DiskType. |
ManagedServiceIdentityType |
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). Known values supported by the serviceNone: No managed identity. |
Mode |
Specifies the mode that ProxyAgent will execute on if the feature is enabled.
ProxyAgent will start to audit or monitor but not enforce access control over
requests to host endpoints in Audit mode, while in Enforce mode it will enforce
access control. The default value is Enforce mode. Known values supported by the serviceAudit: Audit Mode |
NetworkApiVersion |
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' Known values supported by the service2020-11-01: Initial version supported. Later versions are supported as well. |
NetworkInterfaceAuxiliaryMode |
Specifies whether the Auxiliary mode is enabled for the Network Interface
resource. Known values supported by the serviceNone: None Mode |
NetworkInterfaceAuxiliarySku |
Specifies whether the Auxiliary sku is enabled for the Network Interface
resource. Known values supported by the serviceNone: no sku |
OperatingSystemTypes |
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. Known values supported by the serviceWindows: Windows OS type |
Origin |
The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" Known values supported by the serviceuser: Indicates the operation is initiated by a user. |
ProtocolTypes |
Specifies the protocol of WinRM listener. Possible values are: http,
https. Known values supported by the serviceHttp: Http protocol |
ProvisioningState |
The provisioning state of a resource type. Known values supported by the serviceSucceeded |
PublicIPAddressSkuName |
Specify public IP sku name. Known values supported by the serviceBasic: Basic sku name |
PublicIPAddressSkuTier |
Specify public IP sku tier Known values supported by the serviceRegional: Regional sku tier |
RegularPriorityAllocationStrategy |
Regular VM Allocation strategy types for Compute Fleet Known values supported by the serviceLowestPrice: Default. VM sizes distribution will be determined to optimize for price. |
SecurityEncryptionTypes |
Specifies the EncryptionType of the managed disk.
Note: It can be set for only Confidential VMs. Known values supported by the serviceVMGuestStateOnly: EncryptionType of the managed disk is set to VMGuestStateOnly for encryption
of just the VMGuestState blob. |
SecurityTypes |
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. Known values supported by the serviceTrustedLaunch: TrustedLaunch security type |
SettingNames |
Specifies the name of the setting to which the content applies. Possible values
are: FirstLogonCommands and AutoLogon. Known values supported by the serviceAutoLogon: AutoLogon setting |
SpotAllocationStrategy |
Spot allocation strategy types for Compute Fleet Known values supported by the servicePriceCapacityOptimized: Default. VM sizes distribution will be determined to optimize for both price and capacity. |
StorageAccountTypes |
Specifies the storage account type for the managed disk. Managed OS disk
storage account type can only be set when you create the scale set. NOTE:
UltraSSD_LRS can only be used with data disks. It cannot be used with OS Disk.
Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS
uses Premium SSD. UltraSSD_LRS uses Ultra disk. Premium_ZRS uses Premium SSD
zone redundant storage. StandardSSD_ZRS uses Standard SSD zone redundant
storage. For more information regarding disks supported for Windows Virtual
Machines, refer to
https://docs.microsoft.com/azure/virtual-machines/windows/disks-types and, for
Linux Virtual Machines, refer to
https://docs.microsoft.com/azure/virtual-machines/linux/disks-types Known values supported by the serviceStandard_LRS: Standard_LRS option. |
VMAttributeSupport |
VMSizes supported by Azure VMs. Included is a union of Excluded and Required. Known values supported by the serviceExcluded: All VMSizes having the feature support will be excluded. |
VMCategory |
VMCategories defined for Azure VMs.
See: https://learn.microsoft.com/en-us/azure/virtual-machines/sizes/overview?tabs=breakdownseries%2Cgeneralsizelist%2Ccomputesizelist%2Cmemorysizelist%2Cstoragesizelist%2Cgpusizelist%2Cfpgasizelist%2Chpcsizelist#general-purpose Known values supported by the serviceGeneralPurpose: General purpose VM sizes provide balanced CPU-to-memory ratio. Ideal for testing and development, small to medium databases, and low to medium traffic web servers. |
WindowsPatchAssessmentMode |
Specifies the mode of VM Guest patch assessment for the IaaS virtual machine. Known values supported by the serviceImageDefault: You control the timing of patch assessments on a virtual machine. |
WindowsVMGuestPatchAutomaticByPlatformRebootSetting |
Specifies the reboot setting for all AutomaticByPlatform patch installation operations. Known values supported by the serviceUnknown: Unknown Reboot setting |
WindowsVMGuestPatchMode |
Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual
machines associated to virtual machine scale set with OrchestrationMode as
Flexible. Known values supported by the serviceManual: 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 |
Enums
KnownAcceleratorManufacturer |
Accelerator manufacturers supported by Azure VMs. |
KnownAcceleratorType |
Accelerator types supported by Azure VMs. |
KnownActionType |
Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. |
KnownArchitectureType |
Architecture types supported by Azure VMs. |
KnownCachingTypes |
Specifies the caching requirements. |
KnownCpuManufacturer |
Cpu Manufacturers supported by Azure VMs. |
KnownCreatedByType |
The kind of entity that created the resource. |
KnownDeleteOptions |
Specify what happens to the network interface when the VM is deleted |
KnownDiffDiskOptions |
Specifies the ephemeral disk option for operating system disk. |
KnownDiffDiskPlacement |
Specifies the ephemeral disk placement for operating system disk. This property can be used by user in the request to choose the location i.e, cache disk or resource disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer Ephemeral OS disk size requirements for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements Minimum api-version for NvmeDisk: 2024-03-01. |
KnownDiskControllerTypes |
Specifies the disk controller type configured for the VM and VirtualMachineScaleSet. This property is only supported for virtual machines whose operating system disk and VM sku supports Generation 2 (https://docs.microsoft.com/en-us/azure/virtual-machines/generation-2), please check the HyperVGenerations capability returned as part of VM sku capabilities in the response of Microsoft.Compute SKUs api for the region contains V2 (https://docs.microsoft.com/rest/api/compute/resourceskus/list). For more information about Disk Controller Types supported please refer to https://aka.ms/azure-diskcontrollertypes. |
KnownDiskCreateOptionTypes |
Specifies how the virtual machine should be created. |
KnownDiskDeleteOptionTypes |
Specifies the behavior of the managed disk when the VM gets deleted, for example whether the managed disk is deleted or detached. Supported values are: Delete. If this value is used, the managed disk is deleted when VM gets deleted. Detach. If this value is used, the managed disk is retained after VM gets deleted. Minimum api-version: 2021-03-01. |
KnownDomainNameLabelScopeTypes |
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 |
KnownEvictionPolicy |
Different kind of eviction policies |
KnownIPVersion |
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'. |
KnownLinuxPatchAssessmentMode |
Specifies the mode of VM Guest Patch Assessment for the IaaS virtual
machine. |
KnownLinuxVMGuestPatchAutomaticByPlatformRebootSetting |
Specifies the reboot setting for all AutomaticByPlatform patch installation operations. |
KnownLinuxVMGuestPatchMode |
Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible. |
KnownLocalStorageDiskType |
Different kind of Local storage disk types supported by Azure VMs. |
KnownManagedServiceIdentityType |
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). |
KnownMode |
Specifies the mode that ProxyAgent will execute on if the feature is enabled. ProxyAgent will start to audit or monitor but not enforce access control over requests to host endpoints in Audit mode, while in Enforce mode it will enforce access control. The default value is Enforce mode. |
KnownNetworkApiVersion |
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' |
KnownNetworkInterfaceAuxiliaryMode |
Specifies whether the Auxiliary mode is enabled for the Network Interface resource. |
KnownNetworkInterfaceAuxiliarySku |
Specifies whether the Auxiliary sku is enabled for the Network Interface resource. |
KnownOperatingSystemTypes |
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. |
KnownOrigin |
The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" |
KnownProtocolTypes |
Specifies the protocol of WinRM listener. Possible values are: http, https. |
KnownProvisioningState |
Known values of ProvisioningState that the service accepts. |
KnownPublicIPAddressSkuName |
Specify public IP sku name. |
KnownPublicIPAddressSkuTier |
Specify public IP sku tier |
KnownRegularPriorityAllocationStrategy |
Regular VM Allocation strategy types for Compute Fleet |
KnownSecurityEncryptionTypes |
Specifies the EncryptionType of the managed disk. Note: It can be set for only Confidential VMs. |
KnownSecurityTypes |
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. |
KnownSettingNames |
Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. |
KnownSpotAllocationStrategy |
Spot allocation strategy types for Compute Fleet |
KnownStorageAccountTypes |
Specifies the storage account type for the managed disk. Managed OS disk storage account type can only be set when you create the scale set. NOTE: UltraSSD_LRS can only be used with data disks. It cannot be used with OS Disk. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. Premium_ZRS uses Premium SSD zone redundant storage. StandardSSD_ZRS uses Standard SSD zone redundant storage. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/azure/virtual-machines/linux/disks-types |
KnownVMAttributeSupport |
VMSizes supported by Azure VMs. Included is a union of Excluded and Required. |
KnownVMCategory |
VMCategories defined for Azure VMs. See: https://learn.microsoft.com/en-us/azure/virtual-machines/sizes/overview?tabs=breakdownseries%2Cgeneralsizelist%2Ccomputesizelist%2Cmemorysizelist%2Cstoragesizelist%2Cgpusizelist%2Cfpgasizelist%2Chpcsizelist#general-purpose |
KnownWindowsPatchAssessmentMode |
Specifies the mode of VM Guest patch assessment for the IaaS virtual machine. |
KnownWindowsVMGuestPatchAutomaticByPlatformRebootSetting |
Specifies the reboot setting for all AutomaticByPlatform patch installation operations. |
KnownWindowsVMGuestPatchMode |
Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible. |
Functions
restore |
Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope. |
Function Details
restorePoller<TResponse, TResult>(AzureFleetClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)
Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.
function restorePoller<TResponse, TResult>(client: AzureFleetClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>
Parameters
- client
- AzureFleetClient
- serializedState
-
string
- sourceOperation
-
(args: any[]) => PollerLike<OperationState<TResult>, TResult>
- options
-
RestorePollerOptions<TResult, PathUncheckedResponse>
Returns
PollerLike<OperationState<TResult>, TResult>