@azure/arm-avs package

Classes

AzureVMwareSolutionAPI

Interfaces

Addon	An addon resource
AddonArcProperties	The properties of an Arc addon
AddonHcxProperties	The properties of an HCX addon
AddonProperties	The properties of an addon
AddonSrmProperties	The properties of a Site Recovery Manager (SRM) addon
AddonVrProperties	The properties of a vSphere Replication (VR) addon
AddonsCreateOrUpdateOptionalParams	Optional parameters.
AddonsDeleteOptionalParams	Optional parameters.
AddonsGetOptionalParams	Optional parameters.
AddonsListOptionalParams	Optional parameters.
AddonsOperations	Interface representing a Addons operations.
AdminCredentials	Administrative credentials for accessing vCenter and NSX-T
AuthorizationsCreateOrUpdateOptionalParams	Optional parameters.
AuthorizationsDeleteOptionalParams	Optional parameters.
AuthorizationsGetOptionalParams	Optional parameters.
AuthorizationsListOptionalParams	Optional parameters.
AuthorizationsOperations	Interface representing a Authorizations operations.
AvailabilityProperties	The properties describing private cloud availability zone distribution
AzureVMwareSolutionAPIOptionalParams	Optional parameters for the client.
Circuit	An ExpressRoute Circuit
CloudLink	A cloud link resource
CloudLinkProperties	The properties of a cloud link.
CloudLinksCreateOrUpdateOptionalParams	Optional parameters.
CloudLinksDeleteOptionalParams	Optional parameters.
CloudLinksGetOptionalParams	Optional parameters.
CloudLinksListOptionalParams	Optional parameters.
CloudLinksOperations	Interface representing a CloudLinks operations.
Cluster	A cluster resource
ClusterProperties	The properties of a cluster
ClusterUpdate	An update of a cluster resource
ClusterUpdateProperties	The properties of a cluster that may be updated
ClusterZone	Zone and associated hosts info
ClusterZoneList	List of all zones and associated hosts for a cluster
ClustersCreateOrUpdateOptionalParams	Optional parameters.
ClustersDeleteOptionalParams	Optional parameters.
ClustersGetOptionalParams	Optional parameters.
ClustersListOptionalParams	Optional parameters.
ClustersListZonesOptionalParams	Optional parameters.
ClustersOperations	Interface representing a Clusters operations.
ClustersUpdateOptionalParams	Optional parameters.
Datastore	A datastore resource
DatastoreProperties	The properties of a datastore
DatastoresCreateOrUpdateOptionalParams	Optional parameters.
DatastoresDeleteOptionalParams	Optional parameters.
DatastoresGetOptionalParams	Optional parameters.
DatastoresListOptionalParams	Optional parameters.
DatastoresOperations	Interface representing a Datastores operations.
DiskPoolVolume	An iSCSI volume from Microsoft.StoragePool provider
ElasticSanVolume	An Elastic SAN volume from Microsoft.ElasticSan provider
Encryption	The properties of customer managed encryption key
EncryptionKeyVaultProperties	An Encryption Key
Endpoints	Endpoint addresses
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.
ExpressRouteAuthorization	ExpressRoute Circuit Authorization
ExpressRouteAuthorizationProperties	The properties of an ExpressRoute Circuit Authorization resource
GeneralHostProperties	The properties of a general host.
GlobalReachConnection	A global reach connection resource
GlobalReachConnectionProperties	The properties of a global reach connection
GlobalReachConnectionsCreateOrUpdateOptionalParams	Optional parameters.
GlobalReachConnectionsDeleteOptionalParams	Optional parameters.
GlobalReachConnectionsGetOptionalParams	Optional parameters.
GlobalReachConnectionsListOptionalParams	Optional parameters.
GlobalReachConnectionsOperations	Interface representing a GlobalReachConnections operations.
HcxEnterpriseSite	An HCX Enterprise Site resource
HcxEnterpriseSiteProperties	The properties of an HCX Enterprise Site
HcxEnterpriseSitesCreateOrUpdateOptionalParams	Optional parameters.
HcxEnterpriseSitesDeleteOptionalParams	Optional parameters.
HcxEnterpriseSitesGetOptionalParams	Optional parameters.
HcxEnterpriseSitesListOptionalParams	Optional parameters.
HcxEnterpriseSitesOperations	Interface representing a HcxEnterpriseSites operations.
Host	A host resource
HostProperties	The properties of a host.
HostsGetOptionalParams	Optional parameters.
HostsListOptionalParams	Optional parameters.
HostsOperations	Interface representing a Hosts operations.
IdentitySource	vCenter Single Sign On Identity Source
IscsiPath	An iSCSI path resource
IscsiPathProperties	The properties of an iSCSI path resource
IscsiPathsCreateOrUpdateOptionalParams	Optional parameters.
IscsiPathsDeleteOptionalParams	Optional parameters.
IscsiPathsGetOptionalParams	Optional parameters.
IscsiPathsListByPrivateCloudOptionalParams	Optional parameters.
IscsiPathsOperations	Interface representing a IscsiPaths operations.
LocationsCheckQuotaAvailabilityOptionalParams	Optional parameters.
LocationsCheckTrialAvailabilityOptionalParams	Optional parameters.
LocationsOperations	Interface representing a Locations operations.
ManagementCluster	The properties of a management cluster
NetAppVolume	An Azure NetApp Files volume from Microsoft.NetApp provider
Operation	Details of a REST API operation, returned from the Resource Provider Operations API
OperationDisplay	Localized display information for and operation.
OperationsListOptionalParams	Optional parameters.
OperationsOperations	Interface representing a Operations operations.
PSCredentialExecutionParameter	a powershell credential object
PageSettings	Options for the byPage method
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
PlacementPoliciesCreateOrUpdateOptionalParams	Optional parameters.
PlacementPoliciesDeleteOptionalParams	Optional parameters.
PlacementPoliciesGetOptionalParams	Optional parameters.
PlacementPoliciesListOptionalParams	Optional parameters.
PlacementPoliciesOperations	Interface representing a PlacementPolicies operations.
PlacementPoliciesUpdateOptionalParams	Optional parameters.
PlacementPolicy	A vSphere Distributed Resource Scheduler (DRS) placement policy
PlacementPolicyProperties	Abstract placement policy properties
PlacementPolicyUpdate	An update of a DRS placement policy resource
PlacementPolicyUpdateProperties	The properties of a placement policy resource that may be updated
PrivateCloud	A private cloud resource
PrivateCloudIdentity	Managed service identity (either system assigned, or none)
PrivateCloudProperties	The properties of a private cloud resource
PrivateCloudUpdate	An update to a private cloud resource
PrivateCloudUpdateProperties	The properties of a private cloud resource that may be updated
PrivateCloudsCreateOrUpdateOptionalParams	Optional parameters.
PrivateCloudsDeleteOptionalParams	Optional parameters.
PrivateCloudsGetOptionalParams	Optional parameters.
PrivateCloudsListAdminCredentialsOptionalParams	Optional parameters.
PrivateCloudsListInSubscriptionOptionalParams	Optional parameters.
PrivateCloudsListOptionalParams	Optional parameters.
PrivateCloudsOperations	Interface representing a PrivateClouds operations.
PrivateCloudsRotateNsxtPasswordOptionalParams	Optional parameters.
PrivateCloudsRotateVcenterPasswordOptionalParams	Optional parameters.
PrivateCloudsUpdateOptionalParams	Optional parameters.
ProvisionedNetwork	A provisioned network resource
ProvisionedNetworkProperties	The properties of a provisioned network.
ProvisionedNetworksGetOptionalParams	Optional parameters.
ProvisionedNetworksListOptionalParams	Optional parameters.
ProvisionedNetworksOperations	Interface representing a ProvisionedNetworks operations.
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
PureStoragePoliciesCreateOrUpdateOptionalParams	Optional parameters.
PureStoragePoliciesDeleteOptionalParams	Optional parameters.
PureStoragePoliciesGetOptionalParams	Optional parameters.
PureStoragePoliciesListOptionalParams	Optional parameters.
PureStoragePoliciesOperations	Interface representing a PureStoragePolicies operations.
PureStoragePolicy	An instance describing a Pure Storage Policy Based Management policy
PureStoragePolicyProperties	Properties of a Pure Storage Policy Based Management policy
PureStorageVolume	A Pure Storage volume from PureStorage.Block provider
Quota	Subscription quotas
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
ResourceSku	A SKU for a resource.
ResourceSkuCapabilities	Describes The SKU capabilities object.
ResourceSkuLocationInfo	Describes an available Compute SKU Location Information.
ResourceSkuRestrictionInfo	Describes an available Compute SKU Restriction Information.
ResourceSkuRestrictions	The restrictions of the SKU.
ResourceSkuZoneDetails	Describes The zonal capabilities of a SKU.
RestorePollerOptions
ScriptCmdlet	A cmdlet available for script execution
ScriptCmdletProperties	Properties of a pre-canned script
ScriptCmdletsGetOptionalParams	Optional parameters.
ScriptCmdletsListOptionalParams	Optional parameters.
ScriptCmdletsOperations	Interface representing a ScriptCmdlets operations.
ScriptExecution	An instance of a script executed by a user - custom or AVS
ScriptExecutionParameter	The arguments passed in to the execution
ScriptExecutionProperties	Properties of a user-invoked script
ScriptExecutionsCreateOrUpdateOptionalParams	Optional parameters.
ScriptExecutionsDeleteOptionalParams	Optional parameters.
ScriptExecutionsGetExecutionLogsOptionalParams	Optional parameters.
ScriptExecutionsGetOptionalParams	Optional parameters.
ScriptExecutionsListOptionalParams	Optional parameters.
ScriptExecutionsOperations	Interface representing a ScriptExecutions operations.
ScriptPackage	Script Package resources available for execution
ScriptPackageProperties	Properties of a Script Package subresource
ScriptPackagesGetOptionalParams	Optional parameters.
ScriptPackagesListOptionalParams	Optional parameters.
ScriptPackagesOperations	Interface representing a ScriptPackages operations.
ScriptParameter	An parameter that the script will accept
ScriptSecureStringExecutionParameter	a plain text value execution parameter
ScriptStringExecutionParameter	a plain text value execution parameter
Sku	The resource model definition representing SKU
SkusListOptionalParams	Optional parameters.
SkusOperations	Interface representing a Skus operations.
SpecializedHostProperties	The properties of a specialized host.
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'
Trial	Subscription trial availability
VirtualMachine	Virtual Machine
VirtualMachineProperties	Virtual Machine Properties
VirtualMachineRestrictMovement	Set VM DRS-driven movement to restricted (enabled) or not (disabled)
VirtualMachinesGetOptionalParams	Optional parameters.
VirtualMachinesListOptionalParams	Optional parameters.
VirtualMachinesOperations	Interface representing a VirtualMachines operations.
VirtualMachinesRestrictMovementOptionalParams	Optional parameters.
VmHostPlacementPolicyProperties	VM-Host placement policy properties
VmPlacementPolicyProperties	VM-VM placement policy properties
WorkloadNetwork	Workload Network
WorkloadNetworkDhcp	NSX DHCP
WorkloadNetworkDhcpEntity	Base class for WorkloadNetworkDhcpServer and WorkloadNetworkDhcpRelay to inherit from
WorkloadNetworkDhcpRelay	NSX DHCP Relay
WorkloadNetworkDhcpServer	NSX DHCP Server
WorkloadNetworkDnsService	NSX DNS Service
WorkloadNetworkDnsServiceProperties	NSX DNS Service Properties
WorkloadNetworkDnsZone	NSX DNS Zone
WorkloadNetworkDnsZoneProperties	NSX DNS Zone Properties
WorkloadNetworkGateway	NSX Gateway.
WorkloadNetworkGatewayProperties	Properties of a NSX Gateway.
WorkloadNetworkPortMirroring	NSX Port Mirroring
WorkloadNetworkPortMirroringProperties	NSX Port Mirroring Properties
WorkloadNetworkProperties	The properties of a workload network
WorkloadNetworkPublicIP	NSX Public IP Block
WorkloadNetworkPublicIPProperties	NSX Public IP Block Properties
WorkloadNetworkSegment	NSX Segment
WorkloadNetworkSegmentPortVif	Ports and any VIF attached to segment.
WorkloadNetworkSegmentProperties	NSX Segment Properties
WorkloadNetworkSegmentSubnet	Subnet configuration for segment
WorkloadNetworkVMGroup	NSX VM Group
WorkloadNetworkVMGroupProperties	NSX VM Group Properties
WorkloadNetworkVirtualMachine	NSX Virtual Machine
WorkloadNetworkVirtualMachineProperties	NSX Virtual Machine Properties
WorkloadNetworksCreateDhcpOptionalParams	Optional parameters.
WorkloadNetworksCreateDnsServiceOptionalParams	Optional parameters.
WorkloadNetworksCreateDnsZoneOptionalParams	Optional parameters.
WorkloadNetworksCreatePortMirroringOptionalParams	Optional parameters.
WorkloadNetworksCreatePublicIPOptionalParams	Optional parameters.
WorkloadNetworksCreateSegmentsOptionalParams	Optional parameters.
WorkloadNetworksCreateVMGroupOptionalParams	Optional parameters.
WorkloadNetworksDeleteDhcpOptionalParams	Optional parameters.
WorkloadNetworksDeleteDnsServiceOptionalParams	Optional parameters.
WorkloadNetworksDeleteDnsZoneOptionalParams	Optional parameters.
WorkloadNetworksDeletePortMirroringOptionalParams	Optional parameters.
WorkloadNetworksDeletePublicIPOptionalParams	Optional parameters.
WorkloadNetworksDeleteSegmentOptionalParams	Optional parameters.
WorkloadNetworksDeleteVMGroupOptionalParams	Optional parameters.
WorkloadNetworksGetDhcpOptionalParams	Optional parameters.
WorkloadNetworksGetDnsServiceOptionalParams	Optional parameters.
WorkloadNetworksGetDnsZoneOptionalParams	Optional parameters.
WorkloadNetworksGetGatewayOptionalParams	Optional parameters.
WorkloadNetworksGetOptionalParams	Optional parameters.
WorkloadNetworksGetPortMirroringOptionalParams	Optional parameters.
WorkloadNetworksGetPublicIPOptionalParams	Optional parameters.
WorkloadNetworksGetSegmentOptionalParams	Optional parameters.
WorkloadNetworksGetVMGroupOptionalParams	Optional parameters.
WorkloadNetworksGetVirtualMachineOptionalParams	Optional parameters.
WorkloadNetworksListDhcpOptionalParams	Optional parameters.
WorkloadNetworksListDnsServicesOptionalParams	Optional parameters.
WorkloadNetworksListDnsZonesOptionalParams	Optional parameters.
WorkloadNetworksListGatewaysOptionalParams	Optional parameters.
WorkloadNetworksListOptionalParams	Optional parameters.
WorkloadNetworksListPortMirroringOptionalParams	Optional parameters.
WorkloadNetworksListPublicIPsOptionalParams	Optional parameters.
WorkloadNetworksListSegmentsOptionalParams	Optional parameters.
WorkloadNetworksListVMGroupsOptionalParams	Optional parameters.
WorkloadNetworksListVirtualMachinesOptionalParams	Optional parameters.
WorkloadNetworksOperations	Interface representing a WorkloadNetworks operations.
WorkloadNetworksUpdateDhcpOptionalParams	Optional parameters.
WorkloadNetworksUpdateDnsServiceOptionalParams	Optional parameters.
WorkloadNetworksUpdateDnsZoneOptionalParams	Optional parameters.
WorkloadNetworksUpdatePortMirroringOptionalParams	Optional parameters.
WorkloadNetworksUpdateSegmentsOptionalParams	Optional parameters.
WorkloadNetworksUpdateVMGroupOptionalParams	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.
AddonPropertiesUnion	Alias for AddonPropertiesUnion
AddonProvisioningState	Addon provisioning state KnownAddonProvisioningState can be used interchangeably with AddonProvisioningState, 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. Cancelled: is cancelled Building: is building Deleting: is deleting Updating: is updating
AddonType	Addon type KnownAddonType can be used interchangeably with AddonType, this enum contains the known values that the service supports. Known values supported by the service SRM VR HCX Arc
AffinityStrength	Affinity Strength KnownAffinityStrength can be used interchangeably with AffinityStrength, this enum contains the known values that the service supports. Known values supported by the service Should: is should Must: is must
AffinityType	Affinity type KnownAffinityType can be used interchangeably with AffinityType, this enum contains the known values that the service supports. Known values supported by the service Affinity: is affinity AntiAffinity: is anti-affinity
AvailabilityStrategy	Whether the private clouds is available in a single zone or two zones KnownAvailabilityStrategy can be used interchangeably with AvailabilityStrategy, this enum contains the known values that the service supports. Known values supported by the service SingleZone: in single zone DualZone: in two zones
AzureHybridBenefitType	Azure Hybrid Benefit type KnownAzureHybridBenefitType can be used interchangeably with AzureHybridBenefitType, this enum contains the known values that the service supports. Known values supported by the service SqlHost: is SqlHost None: is None
CloudLinkProvisioningState	cloud link provisioning state KnownCloudLinkProvisioningState can be used interchangeably with CloudLinkProvisioningState, 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.
CloudLinkStatus	Cloud Link status KnownCloudLinkStatus can be used interchangeably with CloudLinkStatus, this enum contains the known values that the service supports. Known values supported by the service Active: is active Building: is building Deleting: is deleting Failed: is failed Disconnected: is disconnected
ClusterProvisioningState	Cluster provisioning state KnownClusterProvisioningState can be used interchangeably with ClusterProvisioningState, 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. Cancelled: is cancelled Deleting: is deleting Updating: is updating
ContinuablePage	An interface that describes a page of results.
CreatedByType	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.
DatastoreProvisioningState	datastore provisioning state KnownDatastoreProvisioningState can be used interchangeably with DatastoreProvisioningState, 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. Cancelled: is cancelled Pending: is pending Creating: is creating Updating: is updating Deleting: is deleting
DatastoreStatus	datastore status KnownDatastoreStatus can be used interchangeably with DatastoreStatus, this enum contains the known values that the service supports. Known values supported by the service Unknown: is unknown Accessible: is accessible Inaccessible: is inaccessible Attached: is attached Detached: is detached LostCommunication: is lost communication DeadOrError: is dead or error
DhcpTypeEnum	Type of DHCP: SERVER or RELAY. KnownDhcpTypeEnum can be used interchangeably with DhcpTypeEnum, this enum contains the known values that the service supports. Known values supported by the service SERVER RELAY
DnsServiceLogLevelEnum	DNS service log level KnownDnsServiceLogLevelEnum can be used interchangeably with DnsServiceLogLevelEnum, this enum contains the known values that the service supports. Known values supported by the service DEBUG: is debug INFO: is info WARNING: is warning ERROR: is error FATAL: is fatal
DnsServiceStatusEnum	DNS service status KnownDnsServiceStatusEnum can be used interchangeably with DnsServiceStatusEnum, this enum contains the known values that the service supports. Known values supported by the service SUCCESS: is success FAILURE: is failure
DnsZoneType	The type of DNS zone. KnownDnsZoneType can be used interchangeably with DnsZoneType, this enum contains the known values that the service supports. Known values supported by the service Public: Primary DNS zone. Private: Private DNS zone.
EncryptionKeyStatus	Whether the the encryption key is connected or access denied KnownEncryptionKeyStatus can be used interchangeably with EncryptionKeyStatus, this enum contains the known values that the service supports. Known values supported by the service Connected: is connected AccessDenied: is access denied
EncryptionState	Whether encryption is enabled or disabled KnownEncryptionState can be used interchangeably with EncryptionState, this enum contains the known values that the service supports. Known values supported by the service Enabled: is enabled Disabled: is disabled
EncryptionVersionType	Whether the encryption version is fixed or auto-detected KnownEncryptionVersionType can be used interchangeably with EncryptionVersionType, this enum contains the known values that the service supports. Known values supported by the service Fixed: is fixed AutoDetected: is auto-detected
ExpressRouteAuthorizationProvisioningState	Express Route Circuit Authorization provisioning state KnownExpressRouteAuthorizationProvisioningState can be used interchangeably with ExpressRouteAuthorizationProvisioningState, 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. Updating: is updating
GlobalReachConnectionProvisioningState	Global Reach Connection provisioning state KnownGlobalReachConnectionProvisioningState can be used interchangeably with GlobalReachConnectionProvisioningState, 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. Updating: is updating
GlobalReachConnectionStatus	Global Reach Connection status KnownGlobalReachConnectionStatus can be used interchangeably with GlobalReachConnectionStatus, this enum contains the known values that the service supports. Known values supported by the service Connected: is connected Connecting: is connecting Disconnected: is disconnected
HcxEnterpriseSiteProvisioningState	HCX Enterprise Site provisioning state KnownHcxEnterpriseSiteProvisioningState can be used interchangeably with HcxEnterpriseSiteProvisioningState, 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.
HcxEnterpriseSiteStatus	HCX Enterprise Site status KnownHcxEnterpriseSiteStatus can be used interchangeably with HcxEnterpriseSiteStatus, this enum contains the known values that the service supports. Known values supported by the service Available: is available Consumed: is consumed Deactivated: is deactivated Deleted: is deleted
HostKind	The kind of host. KnownHostKind can be used interchangeably with HostKind, this enum contains the known values that the service supports. Known values supported by the service General Specialized
HostMaintenance	The reason for host maintenance. KnownHostMaintenance can be used interchangeably with HostMaintenance, this enum contains the known values that the service supports. Known values supported by the service Replacement: The host is a replacement host. Upgrade: The host is for an upgrade, such as an upgrade to ESXi, NSX-T, or other component.
HostPropertiesUnion	Alias for HostPropertiesUnion
HostProvisioningState	provisioning state of the host KnownHostProvisioningState can be used interchangeably with HostProvisioningState, 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.
InternetEnum	Whether internet is enabled or disabled KnownInternetEnum can be used interchangeably with InternetEnum, this enum contains the known values that the service supports. Known values supported by the service Enabled: is enabled Disabled: is disabled
IscsiPathProvisioningState	private cloud provisioning state KnownIscsiPathProvisioningState can be used interchangeably with IscsiPathProvisioningState, 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. Pending: is pending Building: is building Deleting: is deleting Updating: is updating
MountOptionEnum	mount option KnownMountOptionEnum can be used interchangeably with MountOptionEnum, this enum contains the known values that the service supports. Known values supported by the service MOUNT: is mount ATTACH: is attach
NsxPublicIpQuotaRaisedEnum	NSX public IP quota raised KnownNsxPublicIpQuotaRaisedEnum can be used interchangeably with NsxPublicIpQuotaRaisedEnum, this enum contains the known values that the service supports. Known values supported by the service Enabled: is enabled Disabled: is disabled
OptionalParamEnum	Optional Param KnownOptionalParamEnum can be used interchangeably with OptionalParamEnum, this enum contains the known values that the service supports. Known values supported by the service Optional: is optional Required: is required
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.
PlacementPolicyPropertiesUnion	Alias for PlacementPolicyPropertiesUnion
PlacementPolicyProvisioningState	Placement Policy provisioning state KnownPlacementPolicyProvisioningState can be used interchangeably with PlacementPolicyProvisioningState, 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. Building: is building Deleting: is deleting Updating: is updating
PlacementPolicyState	Placement Policy state KnownPlacementPolicyState can be used interchangeably with PlacementPolicyState, this enum contains the known values that the service supports. Known values supported by the service Enabled: is enabled Disabled: is disabled
PlacementPolicyType	Placement Policy type KnownPlacementPolicyType can be used interchangeably with PlacementPolicyType, this enum contains the known values that the service supports. Known values supported by the service VmVm VmHost
PortMirroringDirectionEnum	Port Mirroring Direction KnownPortMirroringDirectionEnum can be used interchangeably with PortMirroringDirectionEnum, this enum contains the known values that the service supports. Known values supported by the service INGRESS: is ingress EGRESS: is egress BIDIRECTIONAL: is bidirectional
PortMirroringStatusEnum	Port Mirroring status KnownPortMirroringStatusEnum can be used interchangeably with PortMirroringStatusEnum, this enum contains the known values that the service supports. Known values supported by the service SUCCESS: is success FAILURE: is failure
PrivateCloudProvisioningState	private cloud provisioning state KnownPrivateCloudProvisioningState can be used interchangeably with PrivateCloudProvisioningState, 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. Cancelled: is cancelled Pending: is pending Building: is building Deleting: is deleting Updating: is updating
ProvisionedNetworkProvisioningState	provisioned network provisioning state KnownProvisionedNetworkProvisioningState can be used interchangeably with ProvisionedNetworkProvisioningState, 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.
ProvisionedNetworkTypes	The type of network provisioned. KnownProvisionedNetworkTypes can be used interchangeably with ProvisionedNetworkTypes, this enum contains the known values that the service supports. Known values supported by the service esxManagement: network for ESX management esxReplication: network for ESX replication hcxManagement: network for HCX management hcxUplink: network for HCX uplink vcenterManagement: network for vCenter management vmotion: network for vmotion vsan: network for vsan
PureStoragePolicyProvisioningState	Pure Storage Policy Based Management policy provisioning state KnownPureStoragePolicyProvisioningState can be used interchangeably with PureStoragePolicyProvisioningState, 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. Deleting: is deleting Updating: is updating
QuotaEnabled	quota enabled KnownQuotaEnabled can be used interchangeably with QuotaEnabled, this enum contains the known values that the service supports. Known values supported by the service Enabled: is enabled Disabled: is disabled
ResourceIdentityType	Type of managed service identity (either system assigned, or none). KnownResourceIdentityType can be used interchangeably with ResourceIdentityType, this enum contains the known values that the service supports. Known values supported by the service None: No managed system identity. SystemAssigned: System assigned managed system identity.
ResourceSkuResourceType	Describes the type of resource the SKU applies to. KnownResourceSkuResourceType can be used interchangeably with ResourceSkuResourceType, this enum contains the known values that the service supports. Known values supported by the service privateClouds: The SKU is for a private cloud. privateClouds/clusters: The SKU is for a private cloud cluster.
ResourceSkuRestrictionsReasonCode	Describes the reason for SKU restriction. KnownResourceSkuRestrictionsReasonCode can be used interchangeably with ResourceSkuRestrictionsReasonCode, this enum contains the known values that the service supports. Known values supported by the service QuotaId: The restriction is due to exceeding a quota limitation. NotAvailableForSubscription: The restriction is not available for this subscription.
ResourceSkuRestrictionsType	Describes the kind of SKU restrictions that can exist KnownResourceSkuRestrictionsType can be used interchangeably with ResourceSkuRestrictionsType, this enum contains the known values that the service supports. Known values supported by the service Location: SKU restricted by location. Zone: SKU restricted by availability zone.
ScriptCmdletAudience	Specifies whether a script cmdlet is intended to be invoked only through automation or visible to customers KnownScriptCmdletAudience can be used interchangeably with ScriptCmdletAudience, this enum contains the known values that the service supports. Known values supported by the service Automation: is automation Any: is any
ScriptCmdletProvisioningState	A script cmdlet provisioning state KnownScriptCmdletProvisioningState can be used interchangeably with ScriptCmdletProvisioningState, 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.
ScriptExecutionParameterType	script execution parameter type KnownScriptExecutionParameterType can be used interchangeably with ScriptExecutionParameterType, this enum contains the known values that the service supports. Known values supported by the service Value SecureValue Credential
ScriptExecutionParameterUnion	Alias for ScriptExecutionParameterUnion
ScriptExecutionProvisioningState	Script Execution provisioning state KnownScriptExecutionProvisioningState can be used interchangeably with ScriptExecutionProvisioningState, 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. Pending: is pending Running: is running Cancelling: is cancelling Cancelled: is cancelled Deleting: is deleting
ScriptOutputStreamType	Script Output Stream type KnownScriptOutputStreamType can be used interchangeably with ScriptOutputStreamType, this enum contains the known values that the service supports. Known values supported by the service Information: is information Warning: is warning Output: is output Error: is error
ScriptPackageProvisioningState	Script Package provisioning state KnownScriptPackageProvisioningState can be used interchangeably with ScriptPackageProvisioningState, 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.
ScriptParameterTypes	Script Parameter types KnownScriptParameterTypes can be used interchangeably with ScriptParameterTypes, this enum contains the known values that the service supports. Known values supported by the service String: is string SecureString: is secure string Credential: is credential Int: is int Bool: is bool Float: is float
SegmentStatusEnum	Segment status KnownSegmentStatusEnum can be used interchangeably with SegmentStatusEnum, this enum contains the known values that the service supports. Known values supported by the service SUCCESS: is success FAILURE: is failure
SkuTier	This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.
SslEnum	Whether SSL is enabled or disabled KnownSslEnum can be used interchangeably with SslEnum, this enum contains the known values that the service supports. Known values supported by the service Enabled: is enabled Disabled: is disabled
TrialStatus	trial status KnownTrialStatus can be used interchangeably with TrialStatus, this enum contains the known values that the service supports. Known values supported by the service TrialAvailable: is available TrialUsed: is used TrialDisabled: is disabled
VMGroupStatusEnum	VM group status KnownVMGroupStatusEnum can be used interchangeably with VMGroupStatusEnum, this enum contains the known values that the service supports. Known values supported by the service SUCCESS: is success FAILURE: is failure
VMTypeEnum	VM type KnownVMTypeEnum can be used interchangeably with VMTypeEnum, this enum contains the known values that the service supports. Known values supported by the service REGULAR: is regular EDGE: is edge SERVICE: is service
VirtualMachineProvisioningState	Virtual Machine provisioning state KnownVirtualMachineProvisioningState can be used interchangeably with VirtualMachineProvisioningState, 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.
VirtualMachineRestrictMovementState	Virtual Machine Restrict Movement state KnownVirtualMachineRestrictMovementState can be used interchangeably with VirtualMachineRestrictMovementState, this enum contains the known values that the service supports. Known values supported by the service Enabled: is enabled Disabled: is disabled
VisibilityParameterEnum	Visibility Parameter KnownVisibilityParameterEnum can be used interchangeably with VisibilityParameterEnum, this enum contains the known values that the service supports. Known values supported by the service Visible: is visible Hidden: is hidden
WorkloadNetworkDhcpEntityUnion	Alias for WorkloadNetworkDhcpEntityUnion
WorkloadNetworkDhcpProvisioningState	Workload Network DHCP provisioning state KnownWorkloadNetworkDhcpProvisioningState can be used interchangeably with WorkloadNetworkDhcpProvisioningState, 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. Building: is building Deleting: is deleting Updating: is updating
WorkloadNetworkDnsServiceProvisioningState	Workload Network DNS Service provisioning state KnownWorkloadNetworkDnsServiceProvisioningState can be used interchangeably with WorkloadNetworkDnsServiceProvisioningState, 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. Building: is building Deleting: is deleting Updating: is updating
WorkloadNetworkDnsZoneProvisioningState	Workload Network DNS Zone provisioning state KnownWorkloadNetworkDnsZoneProvisioningState can be used interchangeably with WorkloadNetworkDnsZoneProvisioningState, 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. Building: is building Deleting: is deleting Updating: is updating
WorkloadNetworkPortMirroringProvisioningState	Workload Network Port Mirroring provisioning state KnownWorkloadNetworkPortMirroringProvisioningState can be used interchangeably with WorkloadNetworkPortMirroringProvisioningState, 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. Building: is building Deleting: is deleting Updating: is updating
WorkloadNetworkProvisioningState	base Workload Network provisioning state KnownWorkloadNetworkProvisioningState can be used interchangeably with WorkloadNetworkProvisioningState, 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. Building: is building Deleting: is deleting Updating: is updating
WorkloadNetworkPublicIPProvisioningState	Workload Network Public IP provisioning state KnownWorkloadNetworkPublicIPProvisioningState can be used interchangeably with WorkloadNetworkPublicIPProvisioningState, 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. Building: is building Deleting: is deleting Updating: is updating
WorkloadNetworkSegmentProvisioningState	Workload Network Segment provisioning state KnownWorkloadNetworkSegmentProvisioningState can be used interchangeably with WorkloadNetworkSegmentProvisioningState, 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. Building: is building Deleting: is deleting Updating: is updating
WorkloadNetworkVMGroupProvisioningState	Workload Network VM Group provisioning state KnownWorkloadNetworkVMGroupProvisioningState can be used interchangeably with WorkloadNetworkVMGroupProvisioningState, 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. Building: is building Deleting: is deleting Updating: is updating

Enums

KnownActionType	Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
KnownAddonProvisioningState	Addon provisioning state
KnownAddonType	Addon type
KnownAffinityStrength	Affinity Strength
KnownAffinityType	Affinity type
KnownAvailabilityStrategy	Whether the private clouds is available in a single zone or two zones
KnownAzureHybridBenefitType	Azure Hybrid Benefit type
KnownCloudLinkProvisioningState	cloud link provisioning state
KnownCloudLinkStatus	Cloud Link status
KnownClusterProvisioningState	Cluster provisioning state
KnownCreatedByType	The kind of entity that created the resource.
KnownDatastoreProvisioningState	datastore provisioning state
KnownDatastoreStatus	datastore status
KnownDhcpTypeEnum	Type of DHCP: SERVER or RELAY.
KnownDnsServiceLogLevelEnum	DNS service log level
KnownDnsServiceStatusEnum	DNS service status
KnownDnsZoneType	The type of DNS zone.
KnownEncryptionKeyStatus	Whether the the encryption key is connected or access denied
KnownEncryptionState	Whether encryption is enabled or disabled
KnownEncryptionVersionType	Whether the encryption version is fixed or auto-detected
KnownExpressRouteAuthorizationProvisioningState	Express Route Circuit Authorization provisioning state
KnownGlobalReachConnectionProvisioningState	Global Reach Connection provisioning state
KnownGlobalReachConnectionStatus	Global Reach Connection status
KnownHcxEnterpriseSiteProvisioningState	HCX Enterprise Site provisioning state
KnownHcxEnterpriseSiteStatus	HCX Enterprise Site status
KnownHostKind	The kind of host.
KnownHostMaintenance	The reason for host maintenance.
KnownHostProvisioningState	provisioning state of the host
KnownInternetEnum	Whether internet is enabled or disabled
KnownIscsiPathProvisioningState	private cloud provisioning state
KnownMountOptionEnum	mount option
KnownNsxPublicIpQuotaRaisedEnum	NSX public IP quota raised
KnownOptionalParamEnum	Optional Param
KnownOrigin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
KnownPlacementPolicyProvisioningState	Placement Policy provisioning state
KnownPlacementPolicyState	Placement Policy state
KnownPlacementPolicyType	Placement Policy type
KnownPortMirroringDirectionEnum	Port Mirroring Direction
KnownPortMirroringStatusEnum	Port Mirroring status
KnownPrivateCloudProvisioningState	private cloud provisioning state
KnownProvisionedNetworkProvisioningState	provisioned network provisioning state
KnownProvisionedNetworkTypes	The type of network provisioned.
KnownPureStoragePolicyProvisioningState	Pure Storage Policy Based Management policy provisioning state
KnownQuotaEnabled	quota enabled
KnownResourceIdentityType	Type of managed service identity (either system assigned, or none).
KnownResourceSkuResourceType	Describes the type of resource the SKU applies to.
KnownResourceSkuRestrictionsReasonCode	Describes the reason for SKU restriction.
KnownResourceSkuRestrictionsType	Describes the kind of SKU restrictions that can exist
KnownScriptCmdletAudience	Specifies whether a script cmdlet is intended to be invoked only through automation or visible to customers
KnownScriptCmdletProvisioningState	A script cmdlet provisioning state
KnownScriptExecutionParameterType	script execution parameter type
KnownScriptExecutionProvisioningState	Script Execution provisioning state
KnownScriptOutputStreamType	Script Output Stream type
KnownScriptPackageProvisioningState	Script Package provisioning state
KnownScriptParameterTypes	Script Parameter types
KnownSegmentStatusEnum	Segment status
KnownSslEnum	Whether SSL is enabled or disabled
KnownTrialStatus	trial status
KnownVMGroupStatusEnum	VM group status
KnownVMTypeEnum	VM type
KnownVersions	Azure VMware Solution API versions.
KnownVirtualMachineProvisioningState	Virtual Machine provisioning state
KnownVirtualMachineRestrictMovementState	Virtual Machine Restrict Movement state
KnownVisibilityParameterEnum	Visibility Parameter
KnownWorkloadNetworkDhcpProvisioningState	Workload Network DHCP provisioning state
KnownWorkloadNetworkDnsServiceProvisioningState	Workload Network DNS Service provisioning state
KnownWorkloadNetworkDnsZoneProvisioningState	Workload Network DNS Zone provisioning state
KnownWorkloadNetworkPortMirroringProvisioningState	Workload Network Port Mirroring provisioning state
KnownWorkloadNetworkProvisioningState	base Workload Network provisioning state
KnownWorkloadNetworkPublicIPProvisioningState	Workload Network Public IP provisioning state
KnownWorkloadNetworkSegmentProvisioningState	Workload Network Segment provisioning state
KnownWorkloadNetworkVMGroupProvisioningState	Workload Network VM Group provisioning state

Functions

restorePoller<TResponse, TResult>(AzureVMwareSolutionAPI, 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 Details

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

Parameters

client

AzureVMwareSolutionAPI

serializedState

string

sourceOperation

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

options

RestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>