@azure/arm-azurestackhcivm package

Interfaces

AttestationStatus

The attestation status of the virtual machine

AttestationStatusProperties

Defines the attestation status properties

AttestationStatusesGetOptionalParams

Optional parameters.

AttestationStatusesOperations

Interface representing a AttestationStatuses operations.

AzureStackHCIVMManagementClientOptionalParams

Optional parameters for the client.

BackendAddressPool

Backend address pool for the load balancer.

BackendAddressPoolProperties

Backend address pool for the load balancer.

CreationData

Data used when creating a disk or snapshot

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Common error response for all Azure Resource Manager APIs to return error details for failed operations.

ExtendedLocation

The complex type of the extended location.

ExtensionResource

The base extension resource.

FabricIntegrationStatus

Enhanced fabric integration status with detailed health monitoring and connectivity state.

FabricIssue

Issues exposed by managed network fabric

FrontendIPConfiguration

FrontendIP Configuration object for a load balancer.

FrontendIPConfigurationProperties

FrontendIP Configuration object for a load balancer.

GalleryImage

The gallery images resource definition.

GalleryImageIdentifier

This is the gallery image definition identifier.

GalleryImageProperties

Properties under the gallery image resource

GalleryImageStatus

The observed state of gallery images

GalleryImageStatusDownloadStatus

The download status of the gallery image

GalleryImageStatusProvisioningStatus

The status of the operation performed on the gallery image

GalleryImageTagsUpdate

The type used for updating tags in GalleryImage resources.

GalleryImageVersion

Specifies information about the gallery image version that you want to create or update.

GalleryImageVersionProperties

Describes the properties of a gallery image version.

GalleryImageVersionStorageProfile

This is the storage profile of a Gallery Image Version.

GalleryImagesCreateOrUpdateOptionalParams

Optional parameters.

GalleryImagesDeleteOptionalParams

Optional parameters.

GalleryImagesGetOptionalParams

Optional parameters.

GalleryImagesListAllOptionalParams

Optional parameters.

GalleryImagesListByResourceGroupOptionalParams

Optional parameters.

GalleryImagesOperations

Interface representing a GalleryImages operations.

GalleryImagesUpdateOptionalParams

Optional parameters.

GalleryOSDiskImage

This is the OS disk image.

GuestAgent

Defines the GuestAgent.

GuestAgentInstallStatus

Defines the status of a guest agent installation.

GuestAgentProperties

Defines the resource properties.

GuestAgentsCreateOptionalParams

Optional parameters.

GuestAgentsDeleteOptionalParams

Optional parameters.

GuestAgentsGetOptionalParams

Optional parameters.

GuestAgentsListByVirtualMachineInstanceOptionalParams

Optional parameters.

GuestAgentsOperations

Interface representing a GuestAgents operations.

GuestCredential

Username / Password Credentials to connect to guest.

HardwareProfileUpdate

HardwareProfile - Specifies the hardware settings for the virtual machine instance.

HttpProxyConfiguration

HTTP Proxy configuration for the VM.

HybridIdentityMetadata

Defines the HybridIdentityMetadata.

HybridIdentityMetadataGetOptionalParams

Optional parameters.

HybridIdentityMetadataListByVirtualMachineInstanceOptionalParams

Optional parameters.

HybridIdentityMetadataOperations

Interface representing a HybridIdentityMetadata operations.

HybridIdentityMetadataProperties

Defines the resource properties.

IPConfiguration

InterfaceIPConfiguration IPConfiguration in a network interface.

IPConfigurationArmReference

The Azure Resource ID of an IPConfiguration resource

IPConfigurationProperties

InterfaceIPConfigurationPropertiesFormat properties of IP configuration.

IPPool

Describes IPPool

IPPoolInfo

IP Pool info

Identity

Identity for the resource.

ImageArmReference

The Azure Resource ID for a Gallery Image.

InboundRule

The inbound rule resource definition.

InboundRuleProperties

Inbound rule properties - extends InboundNATRuleProperties with additional status tracking

InboundRuleStatus

The observed state of inbound rule

InboundRuleStatusProvisioningStatus

Provisioning status of Inbound Rule

InboundRulesCreateOrUpdateOptionalParams

Optional parameters.

InboundRulesDeleteOptionalParams

Optional parameters.

InboundRulesGetOptionalParams

Optional parameters.

InboundRulesListByNatGatewayOptionalParams

Optional parameters.

InboundRulesOperations

Interface representing a InboundRules operations.

InstanceViewStatus

Instance view status.

InterfaceDNSSettings

DNS Settings of the interface

LoadBalancer

The LoadBalancer resource definition.

LoadBalancerBackendAddress

LoadBalancer Backend Address

LoadBalancerBackendAddressPoolReference

Reference to a LoadBalancer backend address pool reference

LoadBalancerBackendAddressProperties

LoadBalancer Backend Address properties

LoadBalancerFrontendIPConfigurationReference

Reference to a LoadBalancer Frontend IPConfiguration

LoadBalancerProbeReference

Reference to a LoadBalancer health probe

LoadBalancerProperties

Load Balancer resource properties

LoadBalancerRule

LoadBalancer Rules

LoadBalancerRuleProperties

Properties for LoadBalancerRules

LoadBalancerStatus

The observed status of the virtual network

LoadBalancerStatusProvisioningStatus

Status of load balancer operations

LoadBalancerTagsUpdate

The type used for updating tags in LoadBalancer resources.

LoadBalancersCreateOrUpdateOptionalParams

Optional parameters.

LoadBalancersDeleteOptionalParams

Optional parameters.

LoadBalancersGetOptionalParams

Optional parameters.

LoadBalancersListAllOptionalParams

Optional parameters.

LoadBalancersListByResourceGroupOptionalParams

Optional parameters.

LoadBalancersOperations

Interface representing a LoadBalancers operations.

LoadBalancersUpdateTagsOptionalParams

Optional parameters.

LogicalNetwork

The logical network resource definition.

LogicalNetworkArmReference

The Azure Resource ID for a Logical Network.

LogicalNetworkProperties

Properties under the logical network resource

LogicalNetworkPropertiesDhcpOptions

DhcpOptions contains an array of DNS servers available to VMs deployed in the logical network. Standard DHCP option for a subnet overrides logical network DHCP options.

LogicalNetworkStatus

The observed state of logical networks

LogicalNetworkStatusProvisioningStatus

Describes the status of the provisioning.

LogicalNetworksCreateOrUpdateOptionalParams

Optional parameters.

LogicalNetworksDeleteOptionalParams

Optional parameters.

LogicalNetworksGetOptionalParams

Optional parameters.

LogicalNetworksListAllOptionalParams

Optional parameters.

LogicalNetworksListByResourceGroupOptionalParams

Optional parameters.

LogicalNetworksOperations

Interface representing a LogicalNetworks operations.

LogicalNetworksUpdateOptionalParams

Optional parameters.

LogicalNetworksUpdateRequest

The logical network resource patch definition.

ManagedNetworkFabricArmReference

The Azure Resource ID for a Managed Network Fabric L2ISD or L3ISD internal network

ManagedServiceIdentity

Managed service identity (system assigned and/or user assigned identities)

MarketplaceGalleryImage

The marketplace gallery image resource definition.

MarketplaceGalleryImageProperties

Properties under the marketplace gallery image resource

MarketplaceGalleryImageStatus

The observed state of marketplace gallery images

MarketplaceGalleryImageStatusDownloadStatus

The download status of the gallery image

MarketplaceGalleryImageStatusProvisioningStatus

Marketplace GalleryImage provisioning status

MarketplaceGalleryImageTagsUpdate

The type used for updating tags in MarketplaceGalleryImage resources.

MarketplaceGalleryImagesCreateOrUpdateOptionalParams

Optional parameters.

MarketplaceGalleryImagesDeleteOptionalParams

Optional parameters.

MarketplaceGalleryImagesGetOptionalParams

Optional parameters.

MarketplaceGalleryImagesListAllOptionalParams

Optional parameters.

MarketplaceGalleryImagesListByResourceGroupOptionalParams

Optional parameters.

MarketplaceGalleryImagesOperations

Interface representing a MarketplaceGalleryImages operations.

MarketplaceGalleryImagesUpdateOptionalParams

Optional parameters.

NatGateway

The NatGateway resource definition.

NatGatewayArmReference

The ARM ID for a Network Security Group.

NatGatewayProperties

Nat Gateway resource properties

NatGatewayStatus

Nat Gateway resource status

NatGatewayStatusProvisioningStatus

Provisioning status of Nat Gateway

NatGatewayTagsUpdate

The type used for updating tags in NatGateway resources.

NatGatewaysCreateOrUpdateOptionalParams

Optional parameters.

NatGatewaysDeleteOptionalParams

Optional parameters.

NatGatewaysGetOptionalParams

Optional parameters.

NatGatewaysListAllOptionalParams

Optional parameters.

NatGatewaysListByResourceGroupOptionalParams

Optional parameters.

NatGatewaysOperations

Interface representing a NatGateways operations.

NatGatewaysUpdateTagsOptionalParams

Optional parameters.

NetworkInterface

The network interface resource definition.

NetworkInterfaceArmReference

The Azure Resource ID for a Network Interface.

NetworkInterfaceProperties

Properties under the network interface resource

NetworkInterfaceStatus

The observed state of network interfaces

NetworkInterfaceStatusProvisioningStatus

Network interface provisioning status

NetworkInterfacesCreateOrUpdateOptionalParams

Optional parameters.

NetworkInterfacesDeleteOptionalParams

Optional parameters.

NetworkInterfacesGetOptionalParams

Optional parameters.

NetworkInterfacesListAllOptionalParams

Optional parameters.

NetworkInterfacesListByResourceGroupOptionalParams

Optional parameters.

NetworkInterfacesOperations

Interface representing a NetworkInterfaces operations.

NetworkInterfacesUpdateOptionalParams

Optional parameters.

NetworkInterfacesUpdateProperties

Defines the resource properties for the update.

NetworkInterfacesUpdateRequest

The network interface resource patch definition.

NetworkProfileUpdate

NetworkProfile - describes the network update configuration the virtual machine instance

NetworkSecurityGroup

NetworkSecurityGroup resource.

NetworkSecurityGroupArmReference

The Azure Resource ID for a Network Security Group.

NetworkSecurityGroupProperties

Network Security Group resource.

NetworkSecurityGroupStatus

The observed state of network security group

NetworkSecurityGroupStatusProvisioningStatus

network security group provisioning status

NetworkSecurityGroupTagsUpdate

The type used for updating tags in NetworkSecurityGroup resources.

NetworkSecurityGroupsCreateOrUpdateOptionalParams

Optional parameters.

NetworkSecurityGroupsDeleteOptionalParams

Optional parameters.

NetworkSecurityGroupsGetOptionalParams

Optional parameters.

NetworkSecurityGroupsListAllOptionalParams

Optional parameters.

NetworkSecurityGroupsListByResourceGroupOptionalParams

Optional parameters.

NetworkSecurityGroupsOperations

Interface representing a NetworkSecurityGroups operations.

NetworkSecurityGroupsUpdateTagsOptionalParams

Optional parameters.

Operation

Details of a REST API operation, returned from the Resource Provider Operations API

OperationDisplay

Localized display information for an operation.

OperationStatusResult

The current status of an async operation.

OperationStepResult

The observed result of a step in a resource operation.

OperationsListOptionalParams

Optional parameters.

OperationsOperations

Interface representing a Operations operations.

OsProfileUpdate

OsProfile - describes the update configuration of the operating system

OsProfileUpdateLinuxConfiguration

OSProfile update linux configuration

OsProfileUpdateWindowsConfiguration

OSProfile update windows configuration

PageSettings

Options for the byPage method

PagedAsyncIterableIterator

An interface that allows async iterable iteration both to completion and by page.

PowerOffVirtualMachineOptions

The operation gracefully shuts down a virtual machine by requesting the operating system to shut down. The virtual machine can be restarted with the same provisioned resources. To force an immediate shut down, see the skipShutdown flag.

Probe

Load balancer health probes

ProbeProperties

properties for LoadBalancer health probes

ProxyResource

The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location

PublicIPAddress

The publicIP resource definition.

PublicIPAddressArmReference

The Azure Resource ID of a Public IP resource

PublicIPAddressProperties

Public IP Properties resource.

PublicIPAddressTagsUpdate

The type used for updating tags in PublicIPAddress resources.

PublicIPAddressesCreateOrUpdateOptionalParams

Optional parameters.

PublicIPAddressesDeleteOptionalParams

Optional parameters.

PublicIPAddressesGetOptionalParams

Optional parameters.

PublicIPAddressesListAllOptionalParams

Optional parameters.

PublicIPAddressesListByResourceGroupOptionalParams

Optional parameters.

PublicIPAddressesOperations

Interface representing a PublicIPAddresses operations.

PublicIPAddressesUpdateTagsOptionalParams

Optional parameters.

Resource

Common fields that are returned in the response for all Azure Resource Manager resources

RestorePollerOptions
Route

Route - Route resource.

RouteProperties

RoutePropertiesFormat - Route resource.

RouteTable

Route table resource.

RouteTableProperties

RouteTablePropertiesFormat - Route Table resource.

SecurityRule

Security Rule resource.

SecurityRuleProperties

Security rule resource.

SecurityRulesCreateOrUpdateOptionalParams

Optional parameters.

SecurityRulesDeleteOptionalParams

Optional parameters.

SecurityRulesGetOptionalParams

Optional parameters.

SecurityRulesListByNetworkSecurityGroupOptionalParams

Optional parameters.

SecurityRulesOperations

Interface representing a SecurityRules operations.

Snapshot

The snapshot resource definition.

SnapshotProperties

Properties under the snapshot resource

SnapshotStatus

The observed state of snapshots

SnapshotStatusProvisioningStatus

Snapshot Status provisioning status

SnapshotTagsUpdate

The type used for updating tags in Snapshot resources.

SnapshotsCreateOrUpdateOptionalParams

Optional parameters.

SnapshotsDeleteOptionalParams

Optional parameters.

SnapshotsGetOptionalParams

Optional parameters.

SnapshotsListAllOptionalParams

Optional parameters.

SnapshotsListByResourceGroupOptionalParams

Optional parameters.

SnapshotsOperations

Interface representing a Snapshots operations.

SnapshotsUpdateOptionalParams

Optional parameters.

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.

StorageContainer

The storage container resource definition.

StorageContainerProperties

Properties under the storage container resource

StorageContainerStatus

The observed state of storage containers

StorageContainerStatusProvisioningStatus

Storage container provisioning status

StorageContainerTagsUpdate

The type used for updating tags in StorageContainer resources.

StorageContainersCreateOrUpdateOptionalParams

Optional parameters.

StorageContainersDeleteOptionalParams

Optional parameters.

StorageContainersGetOptionalParams

Optional parameters.

StorageContainersListAllOptionalParams

Optional parameters.

StorageContainersListByResourceGroupOptionalParams

Optional parameters.

StorageContainersOperations

Interface representing a StorageContainers operations.

StorageContainersUpdateOptionalParams

Optional parameters.

StorageProfileUpdate

Storage profile update

Subnet

Properties of the subnet.

SubnetIpConfigurationReference

The Azure Resource ID for a Network Interface.

SubnetProperties

Properties of the subnet.

SystemData

Metadata pertaining to creation and last modification of the resource.

TrackedResource

The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'

UserAssignedIdentity

User assigned identity properties

VMDiskSecurityProfile

Specifies the security profile settings for the managed disk. NOTE: It can only be set for Confidential VMs

VirtualHardDisk

The virtual hard disk resource definition.

VirtualHardDiskArmReference

The Azure Resource ID for a Virtual Hard Disk.

VirtualHardDiskDownloadStatus

The download status of the virtual hard disk

VirtualHardDiskProperties

Properties under the virtual hard disk resource

VirtualHardDiskStatus

The observed state of virtual hard disks

VirtualHardDiskStatusProvisioningStatus

VHD Status provisioning status

VirtualHardDiskUploadRequest

Request for uploading virtual hard disk.

VirtualHardDiskUploadResponse

Response for uploading virtual hard disk.

VirtualHardDiskUploadStatus

The upload status of the virtual hard disk

VirtualHardDisksCreateOrUpdateOptionalParams

Optional parameters.

VirtualHardDisksDeleteOptionalParams

Optional parameters.

VirtualHardDisksGetOptionalParams

Optional parameters.

VirtualHardDisksListAllOptionalParams

Optional parameters.

VirtualHardDisksListByResourceGroupOptionalParams

Optional parameters.

VirtualHardDisksOperations

Interface representing a VirtualHardDisks operations.

VirtualHardDisksUpdateOptionalParams

Optional parameters.

VirtualHardDisksUpdateProperties

Defines the resource properties for the update.

VirtualHardDisksUpdateRequest

The virtual hard disk resource patch definition.

VirtualHardDisksUploadOptionalParams

Optional parameters.

VirtualMachineConfigAgentInstanceView

The instance view of the VM Config Agent running on the virtual machine.

VirtualMachineInstance

The virtual machine instance resource definition.

VirtualMachineInstanceManagedDiskParameters

The parameters of a managed disk.

VirtualMachineInstanceProperties

Properties under the virtual machine instance resource

VirtualMachineInstancePropertiesHardwareProfile

HardwareProfile - Specifies the hardware settings for the virtual machine instance.

VirtualMachineInstancePropertiesHardwareProfileDynamicMemoryConfig

Dynamic memory config

VirtualMachineInstancePropertiesHardwareProfileVirtualMachineGPU

GPU properties - describes the GPU configuration.

VirtualMachineInstancePropertiesNetworkProfile

NetworkProfile - describes the network configuration the virtual machine instance

VirtualMachineInstancePropertiesOsProfile

OsProfile - describes the configuration of the operating system and sets login data

VirtualMachineInstancePropertiesOsProfileLinuxConfiguration

LinuxConfiguration - linux specific configuration values for the virtual machine instance

VirtualMachineInstancePropertiesOsProfileWindowsConfiguration

Windows Configuration for the virtual machine instance

VirtualMachineInstancePropertiesPlacementProfile

PlacementProfile - Specifies the placement related settings for the virtual machine.

VirtualMachineInstancePropertiesSecurityProfile

SecurityProfile - Specifies the security settings for the virtual machine instance.

VirtualMachineInstancePropertiesSecurityProfileUefiSettings

Uefi settings - Specifies whether secure boot should be enabled on the virtual machine instance.

VirtualMachineInstancePropertiesStorageProfile

StorageProfile - contains information about the disks and storage information for the virtual machine instance

VirtualMachineInstancePropertiesStorageProfileOsDisk

VHD to attach as OS disk

VirtualMachineInstanceStatus

The observed state of virtual machine instances

VirtualMachineInstanceStatusProvisioningStatus

Virtual machine instance provisioning status.

VirtualMachineInstanceUpdateProperties

Defines the resource properties for the update.

VirtualMachineInstanceUpdateRequest

The virtual machine instance resource patch definition.

VirtualMachineInstanceView

The instance view of a virtual machine.

VirtualMachineInstancesCreateOrUpdateOptionalParams

Optional parameters.

VirtualMachineInstancesDeleteOptionalParams

Optional parameters.

VirtualMachineInstancesGetOptionalParams

Optional parameters.

VirtualMachineInstancesListOptionalParams

Optional parameters.

VirtualMachineInstancesOperations

Interface representing a VirtualMachineInstances operations.

VirtualMachineInstancesPauseOptionalParams

Optional parameters.

VirtualMachineInstancesPowerOffOptionalParams

Optional parameters.

VirtualMachineInstancesRestartOptionalParams

Optional parameters.

VirtualMachineInstancesSaveOptionalParams

Optional parameters.

VirtualMachineInstancesStartOptionalParams

Optional parameters.

VirtualMachineInstancesStopOptionalParams

Optional parameters.

VirtualMachineInstancesUpdateOptionalParams

Optional parameters.

VirtualNetwork

The virtual network resource definition.

VirtualNetworkAddressSpace

Address Space Information

VirtualNetworkArmReference

The Azure Resource ID for a Virtual Network

VirtualNetworkDhcpOptions

DHCP options for virtual networks

VirtualNetworkProperties

Virtual network resource properties

VirtualNetworkStatus

The observed status of the virtual network

VirtualNetworkStatusProvisioningStatus

Status of virtual network operations

VirtualNetworkSubnet

The virtual network resource definition.

VirtualNetworkSubnetArmReference

The Azure Resource ID for a Virtual Network subnet

VirtualNetworkSubnetIpConfigurationReference

The Azure Resource ID for a resource consuming IP on a subnet

VirtualNetworkSubnetProperties

VirtualNetwork subnet resource

VirtualNetworkSubnetStatus

Status of virtual network subnet operations

VirtualNetworkSubnetStatusProvisioningStatus

Status of virtual network subnet operations

VirtualNetworkSubnetUpdateProperties

The virtual network subnet resource patch properties definition.

VirtualNetworkSubnetUpdateRequest

The virtual network subnet resource patch definition.

VirtualNetworkSubnetsCreateOrUpdateOptionalParams

Optional parameters.

VirtualNetworkSubnetsDeleteOptionalParams

Optional parameters.

VirtualNetworkSubnetsGetOptionalParams

Optional parameters.

VirtualNetworkSubnetsListByVirtualNetworkOptionalParams

Optional parameters.

VirtualNetworkSubnetsOperations

Interface representing a VirtualNetworkSubnets operations.

VirtualNetworkSubnetsUpdateOptionalParams

Optional parameters.

VirtualNetworkTagsUpdate

The type used for updating tags in VirtualNetwork resources.

VirtualNetworksCreateOrUpdateOptionalParams

Optional parameters.

VirtualNetworksDeleteOptionalParams

Optional parameters.

VirtualNetworksGetOptionalParams

Optional parameters.

VirtualNetworksListAllOptionalParams

Optional parameters.

VirtualNetworksListByResourceGroupOptionalParams

Optional parameters.

VirtualNetworksOperations

Interface representing a VirtualNetworks operations.

VirtualNetworksUpdateTagsOptionalParams

Optional parameters.

Type Aliases

ActionType

Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports.

Known values supported by the service

Internal: Actions are for internal-only APIs.

AttestBootIntegrityPropertyEnum

The status of whether the list of boot integrity properties is validated.
KnownAttestBootIntegrityPropertyEnum can be used interchangeably with AttestBootIntegrityPropertyEnum, this enum contains the known values that the service supports.

Known values supported by the service

Valid: Boot integrity properties are valid
Invalid: Boot integrity properties are invalid
Unknown: Boot integrity properties status is unknown

AttestCertPropertyEnum

The status of whether attestation certificate is validated.
KnownAttestCertPropertyEnum can be used interchangeably with AttestCertPropertyEnum, this enum contains the known values that the service supports.

Known values supported by the service

Valid: Attestation certificate is valid
Invalid: Attestation certificate is invalid
Unknown: Attestation certificate status is unknown

AttestDiskSecurityEncryptionTypeEnum

Defines type of managed disk security encryption type from attestation token.
KnownAttestDiskSecurityEncryptionTypeEnum can be used interchangeably with AttestDiskSecurityEncryptionTypeEnum, this enum contains the known values that the service supports.

Known values supported by the service

NonPersistedTPM: Disk security encryption type is non-persisted Trusted Platform Module (TPM)
Unknown: Disk security encryption type is unknown

AttestHWPlatformEnum

Defines type of hardware platform from attestation token.
KnownAttestHWPlatformEnum can be used interchangeably with AttestHWPlatformEnum, this enum contains the known values that the service supports.

Known values supported by the service

SEVSNP: AttestHWPlatform is Secure Encrypted Virtualization Secure Nested Paging (SEVSNP)
Unknown: AttestHWPlatform is unknown

AttestHealthStatusEnum

The health status of attestation validation and parsing
KnownAttestHealthStatusEnum can be used interchangeably with AttestHealthStatusEnum, this enum contains the known values that the service supports.

Known values supported by the service

Pending: Attestation validation and parsing pending
Healthy: Attestation validation and parsing healthy
Unhealthy: Attestation validation and parsing unhealthy
Unknown: Attestation validation and parsing status is unknown

AttestSecureBootPropertyEnum

The status of whether secure boot is enabled.
KnownAttestSecureBootPropertyEnum can be used interchangeably with AttestSecureBootPropertyEnum, this enum contains the known values that the service supports.

Known values supported by the service

Enabled: Secure boot enabled
Disabled: Secure boot disabled
Unknown: Secure boot status is unknown

AzureSupportedClouds

The supported values for cloud setting as a string literal type

CloudInitDataSource

Datasource for the gallery image when provisioning with cloud-init [NoCloud, Azure]
KnownCloudInitDataSource can be used interchangeably with CloudInitDataSource, this enum contains the known values that the service supports.

Known values supported by the service

NoCloud: NoCloud is used as the datasource
Azure: Azure is used as the datasource

ContinuablePage

An interface that describes a page of results.

CreatedByType

The kind of entity that created the resource.
KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports.

Known values supported by the service

User: The entity was created by a user.
Application: The entity was created by an application.
ManagedIdentity: The entity was created by a managed identity.
Key: The entity was created by a key.

DiskCreateOption

Disk creation option values [Copy, Empty]
KnownDiskCreateOption can be used interchangeably with DiskCreateOption, this enum contains the known values that the service supports.

Known values supported by the service

Copy: Create a disk by copying from a source resource
Empty: Create an empty disk

DiskFileFormat

The format of the actual VHD file [vhd, vhdx]
KnownDiskFileFormat can be used interchangeably with DiskFileFormat, this enum contains the known values that the service supports.

Known values supported by the service

vhdx: VHDX file format
vhd: VHD file format

ExtendedLocationTypes

The type of extendedLocation.
KnownExtendedLocationTypes can be used interchangeably with ExtendedLocationTypes, this enum contains the known values that the service supports.

Known values supported by the service

CustomLocation: Custom extended location type

FabricConnectionHealthEnum

Fabric connection health state type
KnownFabricConnectionHealthEnum can be used interchangeably with FabricConnectionHealthEnum, this enum contains the known values that the service supports.

Known values supported by the service

Healthy: Fabric connection health state - healthy type
Warning: Fabric connection health state - warning type
Error: Fabric connection health state - error type
Unknown: Fabric connection health state - unknown type

FabricIntegrationStateEnum

Fabric integration state type
KnownFabricIntegrationStateEnum can be used interchangeably with FabricIntegrationStateEnum, this enum contains the known values that the service supports.

Known values supported by the service

Connected: Fabric integration state - connected type
Disconnected: Fabric integration state - disconnected type
Misconfigured: Fabric integration state - misconfigured type
NotApplicable: Fabric integration state - notapplicable type
Connecting: Fabric integration state - connecting type

FabricResourceTypeEnum

Fabric resource type
KnownFabricResourceTypeEnum can be used interchangeably with FabricResourceTypeEnum, this enum contains the known values that the service supports.

Known values supported by the service

L2IsolationDomain: Fabric resource of L2IsolationDomain type
L3InternalNetwork: Fabric resource of L3InternalNetwork type

GpuAssignmentTypeEnum

Gpu Assignment types
KnownGpuAssignmentTypeEnum can be used interchangeably with GpuAssignmentTypeEnum, this enum contains the known values that the service supports.

Known values supported by the service

GpuDDA: Attach Graphics Processing Unit (GPU) using Discrete Device Assignment (DDA)
GpuP: Attach Graphics Processing Unit (GPU) using GPU Partitioning

HyperVGeneration

The hypervisor generation of the Virtual Machine [V1, V2]
KnownHyperVGeneration can be used interchangeably with HyperVGeneration, this enum contains the known values that the service supports.

Known values supported by the service

V1: Generation 1 (V1) hypervisor
V2: Generation 2 (V2) hypervisor
NA: Not applicable/determined by platform

IPPoolTypeEnum

Type of the IP Pool [vm, vippool]
KnownIPPoolTypeEnum can be used interchangeably with IPPoolTypeEnum, this enum contains the known values that the service supports.

Known values supported by the service

vm: Virtual Machine IP Pool
vippool: VIP Pool

InboundNATRuleProtocol

Protocol for inbound NAT rules
KnownInboundNATRuleProtocol can be used interchangeably with InboundNATRuleProtocol, this enum contains the known values that the service supports.

Known values supported by the service

Tcp: TCP - load balance only tcp traffic
Udp: Udp - load balance only UDP traffic

IpAllocationMethodEnum

IPAllocationMethod - The IP address allocation method. Possible values include: 'Static', 'Dynamic'
KnownIpAllocationMethodEnum can be used interchangeably with IpAllocationMethodEnum, this enum contains the known values that the service supports.

Known values supported by the service

Dynamic: Dynamic IP allocation method
Static: Static IP allocation method

LoadBalancerBackendAddressAdminState

Backend Address Admin states
KnownLoadBalancerBackendAddressAdminState can be used interchangeably with LoadBalancerBackendAddressAdminState, this enum contains the known values that the service supports.

Known values supported by the service

Up: Up - forced admin state up
Down: Down - forced admin state down

LoadBalancerProbeProtocol

Protocol for health probes
KnownLoadBalancerProbeProtocol can be used interchangeably with LoadBalancerProbeProtocol, this enum contains the known values that the service supports.

Known values supported by the service

Tcp: TCP - TCP port checking
Http: HTTP - HTTP request

LoadBalancerRuleSessionPersistenceType

Type of session persistence [Default, SourceIP, SourceIPProtocol]
KnownLoadBalancerRuleSessionPersistenceType can be used interchangeably with LoadBalancerRuleSessionPersistenceType, this enum contains the known values that the service supports.

Known values supported by the service

Default: Default - 5-tuple hashing
SourceIP: Source IP - 2-tuple hashing looking at src-dst ip
SourceIPProtocol: SourceIPProtocol - 3-tuple hashing looking at src-dst ip and ip protocol

LoadBalancerRuleTransportProtocol

Protocol for load balancing rules
KnownLoadBalancerRuleTransportProtocol can be used interchangeably with LoadBalancerRuleTransportProtocol, this enum contains the known values that the service supports.

Known values supported by the service

Tcp: TCP - load balance only tcp traffic
Udp: Udp - load balance only UDP traffic
All: All - load balance all UDP and TCP traffic

LogicalNetworkTypeEnum

Type of Logical Network
KnownLogicalNetworkTypeEnum can be used interchangeably with LogicalNetworkTypeEnum, this enum contains the known values that the service supports.

Known values supported by the service

Workload: Logical Network of type Workload
Infrastructure: Logical Network of type Infrastructure

ManagedServiceIdentityType

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
KnownManagedServiceIdentityType can be used interchangeably with ManagedServiceIdentityType, this enum contains the known values that the service supports.

Known values supported by the service

None: No managed identity.
SystemAssigned: System assigned managed identity.
UserAssigned: User assigned managed identity.
SystemAssigned,UserAssigned: System and user assigned managed identity.

OperatingSystemTypes

Operating system type that the gallery image uses [Windows, Linux]
KnownOperatingSystemTypes can be used interchangeably with OperatingSystemTypes, this enum contains the known values that the service supports.

Known values supported by the service

Windows: Windows operating system
Linux: Linux operating system

Origin

The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports.

Known values supported by the service

user: Indicates the operation is initiated by a user.
system: Indicates the operation is initiated by a system.
user,system: Indicates the operation is initiated by a user or system.

PowerStateEnum

The power state of the virtual machine instance
KnownPowerStateEnum can be used interchangeably with PowerStateEnum, this enum contains the known values that the service supports.

Known values supported by the service

Deallocated: Virtual machine deallocated
Deallocating: Virtual machine deallocating
Running: Virtual machine running
Starting: Virtual machine starting
Stopped: Virtual machine stopped
Stopping: Virtual machine stopping
Paused: Virtual machine paused
Saved: Virtual machine Saved,
Unknown: Power state of the virtual machine is unknown

ProvisioningAction

Defines the different types of operations for guest agent.
KnownProvisioningAction can be used interchangeably with ProvisioningAction, this enum contains the known values that the service supports.

Known values supported by the service

install: Install guest agent
uninstall: Uninstall guest agent
repair: Repair guest agent

ProvisioningStateEnum

Provisioning state of the resource.
KnownProvisioningStateEnum can be used interchangeably with ProvisioningStateEnum, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded: Provisioning has succeeded
Failed: Provisioning has failed
InProgress: Provisioning is in progress
Accepted: Provisioning has been accepted
Deleting: Deletion of the resource is in progress
Canceled: Provisioning has been canceled

PublicIPAddressType

Type of public IP addresses
KnownPublicIPAddressType can be used interchangeably with PublicIPAddressType, this enum contains the known values that the service supports.

Known values supported by the service

IPv4: IPv4 IP Address
IPv6: IPv6 IP Address

SecurityEncryptionType

Encryption type of the managed disk enum.
KnownSecurityEncryptionType can be used interchangeably with SecurityEncryptionType, this enum contains the known values that the service supports.

Known values supported by the service

NonPersistedTPM: Non-persisted TPM encryption type

SecurityRuleAccess

Whether network traffic is allowed or denied.
KnownSecurityRuleAccess can be used interchangeably with SecurityRuleAccess, this enum contains the known values that the service supports.

Known values supported by the service

Allow: Network traffic is allowed
Deny: Network traffic is denied

SecurityRuleDirection

The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic.
KnownSecurityRuleDirection can be used interchangeably with SecurityRuleDirection, this enum contains the known values that the service supports.

Known values supported by the service

Inbound: Rule is evaluated on incoming traffic
Outbound: Rule is evaluated on outgoing traffic

SecurityRuleProtocol

Network protocol this rule applies to.
KnownSecurityRuleProtocol can be used interchangeably with SecurityRuleProtocol, this enum contains the known values that the service supports.

Known values supported by the service

Tcp: Transmission Control Protocol
Udp: User Datagram Protocol
Icmp: Internet Control Message Protocol
*****: Wildcard rule for all protocols

SecurityTypes

Specifies the SecurityType of the virtual machine. EnableTPM and SecureBootEnabled must be set to true for SecurityType to function.
KnownSecurityTypes can be used interchangeably with SecurityTypes, this enum contains the known values that the service supports.

Known values supported by the service

TrustedLaunch: Trusted Launch security type
ConfidentialVM: Confidential VM security type

Status

The status of the operation performed on the resource [Succeeded, Failed, InProgress]
KnownStatus can be used interchangeably with Status, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded: Operation succeeded
Failed: Operation failed
InProgress: Operation is in progress

StatusLevelTypes

The level code.
KnownStatusLevelTypes can be used interchangeably with StatusLevelTypes, this enum contains the known values that the service supports.

Known values supported by the service

Info: Informational status level
Warning: Warning status level
Error: Error status level

StatusTypes

The installation status of the hybrid machine agent installation.
KnownStatusTypes can be used interchangeably with StatusTypes, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded: Installation succeeded
InProgress: Installation in progress
Failed: Installation failed

VmSizeEnum

VM Sizes
KnownVmSizeEnum can be used interchangeably with VmSizeEnum, this enum contains the known values that the service supports.

Known values supported by the service

Default: Default virtual machine size
Standard_A2_v2: Standard A2 v2 virtual machine size
Standard_A4_v2: Standard A4 v2 virtual machine size
Standard_D2s_v3: Standard D2s v3 virtual machine size
Standard_D4s_v3: Standard D4s v3 virtual machine size
Standard_D8s_v3: Standard D8s v3 virtual machine size
Standard_D16s_v3: Standard D16s v3 virtual machine size
Standard_D32s_v3: Standard D32s v3 virtual machine size
Standard_DS2_v2: Standard DS2 v2 virtual machine size
Standard_DS3_v2: Standard DS3 v2 virtual machine size
Standard_DS4_v2: Standard DS4 v2 virtual machine size
Standard_DS5_v2: Standard DS5 v2 virtual machine size
Standard_DS13_v2: Standard DS13 v2 virtual machine size
Standard_K8S_v1: Standard K8S v1 virtual machine size
Standard_K8S2_v1: Standard K8S2 v1 virtual machine size
Standard_K8S3_v1: Standard K8S3 v1 virtual machine size
Standard_K8S4_v1: Standard K8S4 v1 virtual machine size
Standard_NK6: Standard NK6 virtual machine size
Standard_NK12: Standard NK12 virtual machine size
Standard_NV6: Standard NV6 virtual machine size
Standard_NV12: Standard NV12 virtual machine size
Standard_K8S5_v1: Standard K8S5 v1 virtual machine size
Custom: Custom virtual machine size

Enums

AzureClouds

An enum to describe Azure Cloud environments.

KnownActionType

Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.

KnownAttestBootIntegrityPropertyEnum

The status of whether the list of boot integrity properties is validated.

KnownAttestCertPropertyEnum

The status of whether attestation certificate is validated.

KnownAttestDiskSecurityEncryptionTypeEnum

Defines type of managed disk security encryption type from attestation token.

KnownAttestHealthStatusEnum

The health status of attestation validation and parsing

KnownAttestHWPlatformEnum

Defines type of hardware platform from attestation token.

KnownAttestSecureBootPropertyEnum

The status of whether secure boot is enabled.

KnownCloudInitDataSource

Datasource for the gallery image when provisioning with cloud-init [NoCloud, Azure]

KnownCreatedByType

The kind of entity that created the resource.

KnownDiskCreateOption

Disk creation option values [Copy, Empty]

KnownDiskFileFormat

The format of the actual VHD file [vhd, vhdx]

KnownExtendedLocationTypes

The type of extendedLocation.

KnownFabricConnectionHealthEnum

Fabric connection health state type

KnownFabricIntegrationStateEnum

Fabric integration state type

KnownFabricResourceTypeEnum

Fabric resource type

KnownGpuAssignmentTypeEnum

Gpu Assignment types

KnownHyperVGeneration

The hypervisor generation of the Virtual Machine [V1, V2]

KnownInboundNATRuleProtocol

Protocol for inbound NAT rules

KnownIpAllocationMethodEnum

IPAllocationMethod - The IP address allocation method. Possible values include: 'Static', 'Dynamic'

KnownIPPoolTypeEnum

Type of the IP Pool [vm, vippool]

KnownLoadBalancerBackendAddressAdminState

Backend Address Admin states

KnownLoadBalancerProbeProtocol

Protocol for health probes

KnownLoadBalancerRuleSessionPersistenceType

Type of session persistence [Default, SourceIP, SourceIPProtocol]

KnownLoadBalancerRuleTransportProtocol

Protocol for load balancing rules

KnownLogicalNetworkTypeEnum

Type of Logical Network

KnownManagedServiceIdentityType

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

KnownOperatingSystemTypes

Operating system type that the gallery image uses [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"

KnownPowerStateEnum

The power state of the virtual machine instance

KnownProvisioningAction

Defines the different types of operations for guest agent.

KnownProvisioningStateEnum

Provisioning state of the resource.

KnownPublicIPAddressType

Type of public IP addresses

KnownSecurityEncryptionType

Encryption type of the managed disk enum.

KnownSecurityRuleAccess

Whether network traffic is allowed or denied.

KnownSecurityRuleDirection

The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic.

KnownSecurityRuleProtocol

Network protocol this rule applies to.

KnownSecurityTypes

Specifies the SecurityType of the virtual machine. EnableTPM and SecureBootEnabled must be set to true for SecurityType to function.

KnownStatus

The status of the operation performed on the resource [Succeeded, Failed, InProgress]

KnownStatusLevelTypes

The level code.

KnownStatusTypes

The installation status of the hybrid machine agent installation.

KnownVersions

The available API versions.

KnownVmSizeEnum

VM Sizes

Functions

isRestError(unknown)

Typeguard for RestError

restorePoller<TResponse, TResult>(AzureStackHCIVMManagementClient, 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.

Variables

RestError

A custom error type for failed pipeline requests.

Function Details

isRestError(unknown)

Typeguard for RestError

function isRestError(e: unknown): e is RestError

Parameters

e

unknown

Something caught by a catch clause.

Returns

e is RestError

restorePoller<TResponse, TResult>(AzureStackHCIVMManagementClient, 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: AzureStackHCIVMManagementClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

Returns

PollerLike<OperationState<TResult>, TResult>

Variable Details

RestError

A custom error type for failed pipeline requests.

RestError: RestErrorConstructor

Type