@azure/arm-azurestackhcivm package

The attestation status of the virtual machine

Defines the attestation status properties

Optional parameters.

Interface representing a AttestationStatuses operations.

Optional parameters for the client.

The resource management error additional info.

The error detail.

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

The complex type of the extended location.

The base extension resource.

The gallery images resource definition.

This is the gallery image definition identifier.

Properties under the gallery image resource

The observed state of gallery images

The download status of the gallery image

The status of the operation performed on the gallery image

The type used for updating tags in GalleryImage resources.

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

Describes the properties of a gallery image version.

This is the storage profile of a Gallery Image Version.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a GalleryImages operations.

Optional parameters.

This is the OS disk image.

Defines the GuestAgent.

Defines the status of a guest agent installation.

Defines the resource properties.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a GuestAgents operations.

Username / Password Credentials to connect to guest.

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

HTTP Proxy configuration for the VM.

Defines the HybridIdentityMetadata.

Optional parameters.

Optional parameters.

Interface representing a HybridIdentityMetadata operations.

Defines the resource properties.

InterfaceIPConfiguration IPConfiguration in a network interface.

InterfaceIPConfigurationPropertiesFormat properties of IP configuration.

Describes IPPool

IP Pool info

Identity for the resource.

The ARM ID for a Gallery Image.

Instance view status.

DNS Settings of the interface

The logical network resource definition.

The ARM ID for a Logical Network.

Properties under the logical network resource

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.

The observed state of logical networks

Describes the status of the provisioning.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a LogicalNetworks operations.

Optional parameters.

The logical network resource patch definition.

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

The marketplace gallery image resource definition.

Properties under the marketplace gallery image resource

The observed state of marketplace gallery images

The download status of the gallery image

Marketplace GalleryImage provisioning status

The type used for updating tags in MarketplaceGalleryImage resources.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a MarketplaceGalleryImages operations.

Optional parameters.

The network interface resource definition.

The ARM ID for a Network Interface.

Properties under the network interface resource

The observed state of network interfaces

Network interface provisioning status

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a NetworkInterfaces operations.

Optional parameters.

Defines the resource properties for the update.

The network interface resource patch definition.

NetworkProfile - describes the network update configuration the virtual machine instance

NetworkSecurityGroup resource.

The ARM ID for a Network Security Group.

Network Security Group resource.

The observed state of network security group

network security group provisioning status

The type used for updating tags in NetworkSecurityGroup resources.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a NetworkSecurityGroups operations.

Optional parameters.

OsProfile - describes the update configuration of the operating system

OSProfile update linux configuration

OSProfile update windows configuration

Options for the byPage method

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

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

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

Route - Route resource.

RoutePropertiesFormat - Route resource.

Route table resource.

RouteTablePropertiesFormat - Route Table resource.

Security Rule resource.

Security rule resource.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a SecurityRules operations.

SSH configuration for Linux based VMs running on Azure

Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed.

The storage container resource definition.

Properties under the storage container resource

The observed state of storage containers

Storage container provisioning status

The type used for updating tags in StorageContainer resources.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a StorageContainers operations.

Optional parameters.

Storage profile update

Properties of the subnet.

The ARM ID for a Network Interface.

Properties of the subnet.

Metadata pertaining to creation and last modification of the resource.

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

User assigned identity properties

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

The virtual hard disk resource definition.

The ARM ID for a Virtual Hard Disk.

The download status of the virtual hard disk

Properties under the virtual hard disk resource

The observed state of virtual hard disks

VHD Status provisioning status

Request for uploading virtual hard disk.

Response for uploading virtual hard disk.

The upload status of the virtual hard disk

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a VirtualHardDisks operations.

Optional parameters.

Defines the resource properties for the update.

The virtual hard disk resource patch definition.

Optional parameters.

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

The virtual machine instance resource definition.

The parameters of a managed disk.

Properties under the virtual machine instance resource

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

Dynamic memory config

GPU properties - describes the GPU configuration.

NetworkProfile - describes the network configuration the virtual machine instance

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

LinuxConfiguration - linux specific configuration values for the virtual machine instance

Windows Configuration for the virtual machine instance

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

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

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

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

VHD to attach as OS disk

The observed state of virtual machine instances

Virtual machine instance provisioning status.

Defines the resource properties for the update.

The virtual machine instance resource patch definition.

The instance view of a virtual machine.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a VirtualMachineInstances operations.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

The credentials used to login to the image repository that has access to the specified image

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

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

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

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

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

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

The supported values for cloud setting as a string literal type

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

An interface that describes a page of results.

The kind of entity that created the resource.
<xref: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.

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

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

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

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

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

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

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

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.

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

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

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

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

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

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

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

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

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

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

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

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

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

An enum to describe Azure Cloud.

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

The status of whether attestation certificate is validated.

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

Defines type of hardware platform from attestation token.

The health status of attestation validation and parsing

The status of whether secure boot is enabled.

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

The kind of entity that created the resource.

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

The type of extendedLocation.

Gpu Assignment types

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

Type of the IP Pool [vm, vippool]

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

Type of Logical Network

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

Operating system type that the gallery image uses [Windows, Linux]

The power state of the virtual machine instance

Defines the different types of operations for guest agent.

Provisioning state of the resource.

Encryption type of the managed disk enum.

Whether network traffic is allowed or denied.

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

Network protocol this rule applies to.

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

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

The level code.

The installation status of the hybrid machine agent installation.

The available API versions.

VM Sizes

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.