@azure/arm-scvmm package

Classes

ScVmm

Interfaces

AvailabilitySet	The AvailabilitySets resource definition.
AvailabilitySetListItem	Availability Set model
AvailabilitySetListResult	The response of a AvailabilitySet list operation.
AvailabilitySetProperties	Defines the resource properties.
AvailabilitySetTagsUpdate	The type used for updating tags in AvailabilitySet resources.
AvailabilitySets	Interface representing a AvailabilitySets.
AvailabilitySetsCreateOrUpdateHeaders	Defines headers for AvailabilitySets_createOrUpdate operation.
AvailabilitySetsCreateOrUpdateOptionalParams	Optional parameters.
AvailabilitySetsDeleteHeaders	Defines headers for AvailabilitySets_delete operation.
AvailabilitySetsDeleteOptionalParams	Optional parameters.
AvailabilitySetsGetOptionalParams	Optional parameters.
AvailabilitySetsListByResourceGroupNextOptionalParams	Optional parameters.
AvailabilitySetsListByResourceGroupOptionalParams	Optional parameters.
AvailabilitySetsListBySubscriptionNextOptionalParams	Optional parameters.
AvailabilitySetsListBySubscriptionOptionalParams	Optional parameters.
AvailabilitySetsUpdateHeaders	Defines headers for AvailabilitySets_update operation.
AvailabilitySetsUpdateOptionalParams	Optional parameters.
Checkpoint	Defines the resource properties.
Cloud	The Clouds resource definition.
CloudCapacity	Cloud Capacity model
CloudInventoryItem	The Cloud inventory item.
CloudListResult	The response of a Cloud list operation.
CloudProperties	Defines the resource properties.
CloudTagsUpdate	The type used for updating tags in Cloud resources.
Clouds	Interface representing a Clouds.
CloudsCreateOrUpdateHeaders	Defines headers for Clouds_createOrUpdate operation.
CloudsCreateOrUpdateOptionalParams	Optional parameters.
CloudsDeleteHeaders	Defines headers for Clouds_delete operation.
CloudsDeleteOptionalParams	Optional parameters.
CloudsGetOptionalParams	Optional parameters.
CloudsListByResourceGroupNextOptionalParams	Optional parameters.
CloudsListByResourceGroupOptionalParams	Optional parameters.
CloudsListBySubscriptionNextOptionalParams	Optional parameters.
CloudsListBySubscriptionOptionalParams	Optional parameters.
CloudsUpdateHeaders	Defines headers for Clouds_update operation.
CloudsUpdateOptionalParams	Optional parameters.
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. (This also follows the OData error response format.).
ExtendedLocation	The extended location.
GuestAgent	Defines the GuestAgent.
GuestAgentListResult	The response of a GuestAgent list operation.
GuestAgentProperties	Defines the resource properties.
GuestAgents	Interface representing a GuestAgents.
GuestAgentsCreateHeaders	Defines headers for GuestAgents_create operation.
GuestAgentsCreateOptionalParams	Optional parameters.
GuestAgentsDeleteOptionalParams	Optional parameters.
GuestAgentsGetOptionalParams	Optional parameters.
GuestAgentsListByVirtualMachineInstanceNextOptionalParams	Optional parameters.
GuestAgentsListByVirtualMachineInstanceOptionalParams	Optional parameters.
GuestCredential	Username / Password Credentials to connect to guest.
HardwareProfile	Defines the resource properties.
HardwareProfileUpdate	Defines the resource update properties.
HttpProxyConfiguration	HTTP Proxy configuration for the VM.
InfrastructureProfile	Specifies the vmmServer infrastructure specific settings for the virtual machine instance.
InfrastructureProfileUpdate	Specifies the vmmServer infrastructure specific update settings for the virtual machine instance.
InventoryItem	Defines the inventory item.
InventoryItemDetails	Defines the resource properties.
InventoryItemListResult	The response of a InventoryItem list operation.
InventoryItemProperties	Defines the resource properties.
InventoryItems	Interface representing a InventoryItems.
InventoryItemsCreateOptionalParams	Optional parameters.
InventoryItemsDeleteOptionalParams	Optional parameters.
InventoryItemsGetOptionalParams	Optional parameters.
InventoryItemsListByVmmServerNextOptionalParams	Optional parameters.
InventoryItemsListByVmmServerOptionalParams	Optional parameters.
NetworkInterface	Network Interface model
NetworkInterfaceUpdate	Network Interface Update model
NetworkProfile	Defines the resource properties.
NetworkProfileUpdate	Defines the resource update properties.
Operation	Details of a REST API operation, returned from the Resource Provider Operations API
OperationDisplay	Localized display information for this particular operation.
OperationListResult	A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.
Operations	Interface representing a Operations.
OperationsListNextOptionalParams	Optional parameters.
OperationsListOptionalParams	Optional parameters.
OsProfileForVmInstance	Defines the resource properties.
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
ScVmmOptionalParams	Optional parameters.
StopVirtualMachineOptions	Defines the stop action properties.
StorageProfile	Defines the resource properties.
StorageProfileUpdate	Defines the resource update properties.
StorageQosPolicy	The StorageQoSPolicy definition.
StorageQosPolicyDetails	The StorageQoSPolicyDetails definition.
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'
VirtualDisk	Virtual disk model
VirtualDiskUpdate	Virtual Disk Update model
VirtualMachineCreateCheckpoint	Defines the create checkpoint action properties.
VirtualMachineDeleteCheckpoint	Defines the delete checkpoint action properties.
VirtualMachineInstance	Define the virtualMachineInstance.
VirtualMachineInstanceListResult	The response of a VirtualMachineInstance list operation.
VirtualMachineInstanceProperties	Defines the resource properties.
VirtualMachineInstanceUpdate	The type used for update operations of the VirtualMachineInstance.
VirtualMachineInstanceUpdateProperties	Virtual Machine Instance Properties Update model
VirtualMachineInstances	Interface representing a VirtualMachineInstances.
VirtualMachineInstancesCreateCheckpointHeaders	Defines headers for VirtualMachineInstances_createCheckpoint operation.
VirtualMachineInstancesCreateCheckpointOptionalParams	Optional parameters.
VirtualMachineInstancesCreateOrUpdateHeaders	Defines headers for VirtualMachineInstances_createOrUpdate operation.
VirtualMachineInstancesCreateOrUpdateOptionalParams	Optional parameters.
VirtualMachineInstancesDeleteCheckpointHeaders	Defines headers for VirtualMachineInstances_deleteCheckpoint operation.
VirtualMachineInstancesDeleteCheckpointOptionalParams	Optional parameters.
VirtualMachineInstancesDeleteHeaders	Defines headers for VirtualMachineInstances_delete operation.
VirtualMachineInstancesDeleteOptionalParams	Optional parameters.
VirtualMachineInstancesGetOptionalParams	Optional parameters.
VirtualMachineInstancesListNextOptionalParams	Optional parameters.
VirtualMachineInstancesListOptionalParams	Optional parameters.
VirtualMachineInstancesRestartHeaders	Defines headers for VirtualMachineInstances_restart operation.
VirtualMachineInstancesRestartOptionalParams	Optional parameters.
VirtualMachineInstancesRestoreCheckpointHeaders	Defines headers for VirtualMachineInstances_restoreCheckpoint operation.
VirtualMachineInstancesRestoreCheckpointOptionalParams	Optional parameters.
VirtualMachineInstancesStartHeaders	Defines headers for VirtualMachineInstances_start operation.
VirtualMachineInstancesStartOptionalParams	Optional parameters.
VirtualMachineInstancesStopHeaders	Defines headers for VirtualMachineInstances_stop operation.
VirtualMachineInstancesStopOptionalParams	Optional parameters.
VirtualMachineInstancesUpdateHeaders	Defines headers for VirtualMachineInstances_update operation.
VirtualMachineInstancesUpdateOptionalParams	Optional parameters.
VirtualMachineInventoryItem	The Virtual machine inventory item.
VirtualMachineRestoreCheckpoint	Defines the restore checkpoint action properties.
VirtualMachineTemplate	The VirtualMachineTemplates resource definition.
VirtualMachineTemplateInventoryItem	The Virtual machine template inventory item.
VirtualMachineTemplateListResult	The response of a VirtualMachineTemplate list operation.
VirtualMachineTemplateProperties	Defines the resource properties.
VirtualMachineTemplateTagsUpdate	The type used for updating tags in VirtualMachineTemplate resources.
VirtualMachineTemplates	Interface representing a VirtualMachineTemplates.
VirtualMachineTemplatesCreateOrUpdateHeaders	Defines headers for VirtualMachineTemplates_createOrUpdate operation.
VirtualMachineTemplatesCreateOrUpdateOptionalParams	Optional parameters.
VirtualMachineTemplatesDeleteHeaders	Defines headers for VirtualMachineTemplates_delete operation.
VirtualMachineTemplatesDeleteOptionalParams	Optional parameters.
VirtualMachineTemplatesGetOptionalParams	Optional parameters.
VirtualMachineTemplatesListByResourceGroupNextOptionalParams	Optional parameters.
VirtualMachineTemplatesListByResourceGroupOptionalParams	Optional parameters.
VirtualMachineTemplatesListBySubscriptionNextOptionalParams	Optional parameters.
VirtualMachineTemplatesListBySubscriptionOptionalParams	Optional parameters.
VirtualMachineTemplatesUpdateHeaders	Defines headers for VirtualMachineTemplates_update operation.
VirtualMachineTemplatesUpdateOptionalParams	Optional parameters.
VirtualNetwork	The VirtualNetworks resource definition.
VirtualNetworkInventoryItem	The Virtual network inventory item.
VirtualNetworkListResult	The response of a VirtualNetwork list operation.
VirtualNetworkProperties	Defines the resource properties.
VirtualNetworkTagsUpdate	The type used for updating tags in VirtualNetwork resources.
VirtualNetworks	Interface representing a VirtualNetworks.
VirtualNetworksCreateOrUpdateHeaders	Defines headers for VirtualNetworks_createOrUpdate operation.
VirtualNetworksCreateOrUpdateOptionalParams	Optional parameters.
VirtualNetworksDeleteHeaders	Defines headers for VirtualNetworks_delete operation.
VirtualNetworksDeleteOptionalParams	Optional parameters.
VirtualNetworksGetOptionalParams	Optional parameters.
VirtualNetworksListByResourceGroupNextOptionalParams	Optional parameters.
VirtualNetworksListByResourceGroupOptionalParams	Optional parameters.
VirtualNetworksListBySubscriptionNextOptionalParams	Optional parameters.
VirtualNetworksListBySubscriptionOptionalParams	Optional parameters.
VirtualNetworksUpdateHeaders	Defines headers for VirtualNetworks_update operation.
VirtualNetworksUpdateOptionalParams	Optional parameters.
VmInstanceHybridIdentityMetadata	Defines the HybridIdentityMetadata.
VmInstanceHybridIdentityMetadataListResult	The response of a VmInstanceHybridIdentityMetadata list operation.
VmInstanceHybridIdentityMetadataProperties	Describes the properties of Hybrid Identity Metadata for a Virtual Machine.
VmInstanceHybridIdentityMetadatas	Interface representing a VmInstanceHybridIdentityMetadatas.
VmInstanceHybridIdentityMetadatasGetOptionalParams	Optional parameters.
VmInstanceHybridIdentityMetadatasListByVirtualMachineInstanceNextOptionalParams	Optional parameters.
VmInstanceHybridIdentityMetadatasListByVirtualMachineInstanceOptionalParams	Optional parameters.
VmmCredential	Credentials to connect to VmmServer.
VmmServer	The VmmServers resource definition.
VmmServerListResult	The response of a VmmServer list operation.
VmmServerProperties	Defines the resource properties.
VmmServerTagsUpdate	The type used for updating tags in VmmServer resources.
VmmServers	Interface representing a VmmServers.
VmmServersCreateOrUpdateHeaders	Defines headers for VmmServers_createOrUpdate operation.
VmmServersCreateOrUpdateOptionalParams	Optional parameters.
VmmServersDeleteHeaders	Defines headers for VmmServers_delete operation.
VmmServersDeleteOptionalParams	Optional parameters.
VmmServersGetOptionalParams	Optional parameters.
VmmServersListByResourceGroupNextOptionalParams	Optional parameters.
VmmServersListByResourceGroupOptionalParams	Optional parameters.
VmmServersListBySubscriptionNextOptionalParams	Optional parameters.
VmmServersListBySubscriptionOptionalParams	Optional parameters.
VmmServersUpdateHeaders	Defines headers for VmmServers_update operation.
VmmServersUpdateOptionalParams	Optional parameters.

Type Aliases

ActionType	Defines values for ActionType. KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports. Known values supported by the service Internal
AllocationMethod	Defines values for AllocationMethod. KnownAllocationMethod can be used interchangeably with AllocationMethod, this enum contains the known values that the service supports. Known values supported by the service Dynamic: Dynamically allocated address. Static: Statically allocated address.
AvailabilitySetsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
AvailabilitySetsDeleteResponse	Contains response data for the delete operation.
AvailabilitySetsGetResponse	Contains response data for the get operation.
AvailabilitySetsListByResourceGroupNextResponse	Contains response data for the listByResourceGroupNext operation.
AvailabilitySetsListByResourceGroupResponse	Contains response data for the listByResourceGroup operation.
AvailabilitySetsListBySubscriptionNextResponse	Contains response data for the listBySubscriptionNext operation.
AvailabilitySetsListBySubscriptionResponse	Contains response data for the listBySubscription operation.
AvailabilitySetsUpdateResponse	Contains response data for the update operation.
CloudsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
CloudsDeleteResponse	Contains response data for the delete operation.
CloudsGetResponse	Contains response data for the get operation.
CloudsListByResourceGroupNextResponse	Contains response data for the listByResourceGroupNext operation.
CloudsListByResourceGroupResponse	Contains response data for the listByResourceGroup operation.
CloudsListBySubscriptionNextResponse	Contains response data for the listBySubscriptionNext operation.
CloudsListBySubscriptionResponse	Contains response data for the listBySubscription operation.
CloudsUpdateResponse	Contains response data for the update operation.
CreateDiffDisk	Defines values for CreateDiffDisk. KnownCreateDiffDisk can be used interchangeably with CreateDiffDisk, this enum contains the known values that the service supports. Known values supported by the service true: Enable create diff disk. false: Disable create diff disk.
CreatedByType	Defines values for CreatedByType. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User Application ManagedIdentity Key
DeleteFromHost	Defines values for DeleteFromHost. KnownDeleteFromHost can be used interchangeably with DeleteFromHost, this enum contains the known values that the service supports. Known values supported by the service true: Enable delete from host. false: Disable delete from host.
DynamicMemoryEnabled	Defines values for DynamicMemoryEnabled. KnownDynamicMemoryEnabled can be used interchangeably with DynamicMemoryEnabled, this enum contains the known values that the service supports. Known values supported by the service true: Enable dynamic memory. false: Disable dynamic memory.
ForceDelete	Defines values for ForceDelete. KnownForceDelete can be used interchangeably with ForceDelete, this enum contains the known values that the service supports. Known values supported by the service true: Enable force delete. false: Disable force delete.
GuestAgentsCreateResponse	Contains response data for the create operation.
GuestAgentsGetResponse	Contains response data for the get operation.
GuestAgentsListByVirtualMachineInstanceNextResponse	Contains response data for the listByVirtualMachineInstanceNext operation.
GuestAgentsListByVirtualMachineInstanceResponse	Contains response data for the listByVirtualMachineInstance operation.
InventoryItemPropertiesUnion
InventoryItemsCreateResponse	Contains response data for the create operation.
InventoryItemsGetResponse	Contains response data for the get operation.
InventoryItemsListByVmmServerNextResponse	Contains response data for the listByVmmServerNext operation.
InventoryItemsListByVmmServerResponse	Contains response data for the listByVmmServer operation.
InventoryType	Defines values for InventoryType. KnownInventoryType can be used interchangeably with InventoryType, this enum contains the known values that the service supports. Known values supported by the service Cloud: Cloud inventory type VirtualNetwork: VirtualNetwork inventory type VirtualMachine: VirtualMachine inventory type VirtualMachineTemplate: VirtualMachineTemplate inventory type
IsCustomizable	Defines values for IsCustomizable. KnownIsCustomizable can be used interchangeably with IsCustomizable, this enum contains the known values that the service supports. Known values supported by the service true: Enable customizable. false: Disable customizable.
IsHighlyAvailable	Defines values for IsHighlyAvailable. KnownIsHighlyAvailable can be used interchangeably with IsHighlyAvailable, this enum contains the known values that the service supports. Known values supported by the service true: Enable highly available. false: Disable highly available.
LimitCpuForMigration	Defines values for LimitCpuForMigration. KnownLimitCpuForMigration can be used interchangeably with LimitCpuForMigration, this enum contains the known values that the service supports. Known values supported by the service true: Enable limit CPU for migration. false: Disable limit CPU for migration.
OperationsListNextResponse	Contains response data for the listNext operation.
OperationsListResponse	Contains response data for the list operation.
Origin	Defines values for Origin. KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports. Known values supported by the service user system user,system
OsType	Defines values for OsType. KnownOsType can be used interchangeably with OsType, this enum contains the known values that the service supports. Known values supported by the service Windows: Windows operating system. Linux: Linux operating system. Other: Other operating system.
ProvisioningAction	Defines values for ProvisioningAction. 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.
ProvisioningState	Defines values for ProvisioningState. KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Succeeded: Resource has been created. Failed: Resource creation failed. Canceled: Resource creation was canceled. Provisioning: The resource is provisioning. Updating: The resource is updating. Deleting: The resource is being deleted. Accepted: The resource has been accepted. Created: The resource was created.
SkipShutdown	Defines values for SkipShutdown. KnownSkipShutdown can be used interchangeably with SkipShutdown, this enum contains the known values that the service supports. Known values supported by the service true: Enable skip shutdown. false: Disable skip shutdown.
VirtualMachineInstancesCreateCheckpointResponse	Contains response data for the createCheckpoint operation.
VirtualMachineInstancesCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
VirtualMachineInstancesDeleteCheckpointResponse	Contains response data for the deleteCheckpoint operation.
VirtualMachineInstancesDeleteResponse	Contains response data for the delete operation.
VirtualMachineInstancesGetResponse	Contains response data for the get operation.
VirtualMachineInstancesListNextResponse	Contains response data for the listNext operation.
VirtualMachineInstancesListResponse	Contains response data for the list operation.
VirtualMachineInstancesRestartResponse	Contains response data for the restart operation.
VirtualMachineInstancesRestoreCheckpointResponse	Contains response data for the restoreCheckpoint operation.
VirtualMachineInstancesStartResponse	Contains response data for the start operation.
VirtualMachineInstancesStopResponse	Contains response data for the stop operation.
VirtualMachineInstancesUpdateResponse	Contains response data for the update operation.
VirtualMachineTemplatesCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
VirtualMachineTemplatesDeleteResponse	Contains response data for the delete operation.
VirtualMachineTemplatesGetResponse	Contains response data for the get operation.
VirtualMachineTemplatesListByResourceGroupNextResponse	Contains response data for the listByResourceGroupNext operation.
VirtualMachineTemplatesListByResourceGroupResponse	Contains response data for the listByResourceGroup operation.
VirtualMachineTemplatesListBySubscriptionNextResponse	Contains response data for the listBySubscriptionNext operation.
VirtualMachineTemplatesListBySubscriptionResponse	Contains response data for the listBySubscription operation.
VirtualMachineTemplatesUpdateResponse	Contains response data for the update operation.
VirtualNetworksCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
VirtualNetworksDeleteResponse	Contains response data for the delete operation.
VirtualNetworksGetResponse	Contains response data for the get operation.
VirtualNetworksListByResourceGroupNextResponse	Contains response data for the listByResourceGroupNext operation.
VirtualNetworksListByResourceGroupResponse	Contains response data for the listByResourceGroup operation.
VirtualNetworksListBySubscriptionNextResponse	Contains response data for the listBySubscriptionNext operation.
VirtualNetworksListBySubscriptionResponse	Contains response data for the listBySubscription operation.
VirtualNetworksUpdateResponse	Contains response data for the update operation.
VmInstanceHybridIdentityMetadatasGetResponse	Contains response data for the get operation.
VmInstanceHybridIdentityMetadatasListByVirtualMachineInstanceNextResponse	Contains response data for the listByVirtualMachineInstanceNext operation.
VmInstanceHybridIdentityMetadatasListByVirtualMachineInstanceResponse	Contains response data for the listByVirtualMachineInstance operation.
VmmServersCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
VmmServersDeleteResponse	Contains response data for the delete operation.
VmmServersGetResponse	Contains response data for the get operation.
VmmServersListByResourceGroupNextResponse	Contains response data for the listByResourceGroupNext operation.
VmmServersListByResourceGroupResponse	Contains response data for the listByResourceGroup operation.
VmmServersListBySubscriptionNextResponse	Contains response data for the listBySubscriptionNext operation.
VmmServersListBySubscriptionResponse	Contains response data for the listBySubscription operation.
VmmServersUpdateResponse	Contains response data for the update operation.

Enums

KnownActionType	Known values of ActionType that the service accepts.
KnownAllocationMethod	Known values of AllocationMethod that the service accepts.
KnownCreateDiffDisk	Known values of CreateDiffDisk that the service accepts.
KnownCreatedByType	Known values of CreatedByType that the service accepts.
KnownDeleteFromHost	Known values of DeleteFromHost that the service accepts.
KnownDynamicMemoryEnabled	Known values of DynamicMemoryEnabled that the service accepts.
KnownForceDelete	Known values of ForceDelete that the service accepts.
KnownInventoryType	Known values of InventoryType that the service accepts.
KnownIsCustomizable	Known values of IsCustomizable that the service accepts.
KnownIsHighlyAvailable	Known values of IsHighlyAvailable that the service accepts.
KnownLimitCpuForMigration	Known values of LimitCpuForMigration that the service accepts.
KnownOrigin	Known values of Origin that the service accepts.
KnownOsType	Known values of OsType that the service accepts.
KnownProvisioningAction	Known values of ProvisioningAction that the service accepts.
KnownProvisioningState	Known values of ProvisioningState that the service accepts.
KnownSkipShutdown	Known values of SkipShutdown that the service accepts.

Functions

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

Function Details

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

An object from accessing value on the IteratorResult from a byPage iterator.

Returns

string | undefined

The continuation token that can be passed into byPage() during future calls.