@azure/arm-hybridcompute package

Access rule.

Properties of an access rule.

Configurable properties that the user can set locally via the azcmagent config command, or remotely via ARM.

The info w.r.t Agent Upgrade.

Summarization of patches available for installation on the machine by classification.

The metadata of the cloud environment (Azure/GCP/AWS/OCI...).

Describes properties that can identify extensions.

model interface ConnectionDetail

Describes a disk on the machine

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.

ESU key

Describes the Update properties of a ESU License Profile.

Optional parameters.

Optional parameters.

Interface representing a ExtensionMetadata operations.

Optional parameters.

Optional parameters.

Interface representing a ExtensionMetadataV2 operations.

Describes an Extension Publisher.

Optional parameters.

Interface representing a ExtensionPublisher operations.

Describes the Machine Extension Target Version Properties

Describes an Extension Type.

Optional parameters.

Interface representing a ExtensionType operations.

Describes a Extension Metadata

Describes Extension Metadata properties

Describes an Extension Metadata.

Describes Extension Metadata properties.

Instance view status.

Describes the firmware of the machine

Describes an Arc Gateway.

Describes the properties of a Gateway Profile.

Describes a Gateway Update.

Describes the Update properties of a Gateway Profile.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a Gateways operations.

Optional parameters.

Describes the hardware of the machine

Optional parameters for the client.

An Azure Arc PrivateLinkScope definition.

Properties that define a Azure Arc PrivateLinkScope resource.

Describes properties of the IP address.

Describes a license in a hybrid machine.

Describes the properties of a License.

Describes a license profile in a hybrid machine.

Describes the properties of a License Profile ARM model.

Describes the properties of a License Profile ARM model.

Describes the properties of a Product License Profile ARM model.

License Profile Instance View in Machine Properties.

Properties for the Machine ESU profile.

model interface LicenseProfileMachineInstanceViewSoftwareAssurance

Describe the properties of a license profile.

model interface LicenseProfilePropertiesSoftwareAssurance

License profile storage model for ESU properties.

Describes a License Profile Update.

Describe the Update properties of a license profile.

model interface LicenseProfileUpdatePropertiesSoftwareAssurance

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a LicenseProfiles operations.

Optional parameters.

Describes the properties of a License Profile.

Describes a License Update.

Describes the Update properties of a License Profile.

model interface LicenseUpdatePropertiesLicenseDetails

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a Licenses operations.

Optional parameters.

Optional parameters.

Input for InstallPatches on a Linux VM, as directly received by the API

Metadata pertaining to the geographic location of the resource.

Describes a hybrid machine.

Describes the properties of an AssessPatches result.

Describes a Machine Extension.

Describes the Machine Extension Instance View.

Instance view status.

Describes the properties of a Machine Extension.

Describes a Machine Extension Update.

Describes the properties of a Machine Extension.

Describes the Machine Extension Upgrade Properties.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a MachineExtensions operations.

Optional parameters.

Input for InstallPatches as directly received by the API

The result summary of an installation operation.

Describes the properties of a hybrid machine.

Describes a Run Command

The instance view of a machine run command.

Describes the properties of a run command.

Describes the script sources for run command. Use only one of script, scriptUri, commandId.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a MachineRunCommands operations.

Describes a hybrid machine Update.

Describes the ARM updatable properties of a hybrid machine.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a Machines operations.

Optional parameters.

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

Describes a network interface.

Describes the network information on this machine.

Optional parameters.

Interface representing a NetworkProfileOperations operations.

Properties that define a Network Security Perimeter resource.

Properties that define a Network Security Perimeter resource.

Properties that define a Network Security Perimeter resource.

Result of network security perimeter configurations.

Optional parameters.

Optional parameters.

Interface representing a NetworkSecurityPerimeterConfigurations operations.

Optional parameters.

Network Security Perimeter profile

Specifies the operating system settings for the hybrid machine.

Specifies the linux configuration for update management.

Specifies the windows configuration for update management.

Describes the properties of a Compute Operation value.

Describes the properties of a Hybrid Compute Operation Value Display.

Optional parameters.

Interface representing a Operations operations.

Options for the byPage method

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

Specifies the patch settings.

Status of the hotpatch capability enrollment or disenrollment.

A private endpoint connection

The Data Model for a Private Endpoint Connection associated with a Private Link Scope

Properties of a private endpoint connection.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a PrivateEndpointConnections operations.

Private endpoint which the connection belongs to.

A private link resource

Properties of a private link resource.

Optional parameters.

Optional parameters.

Interface representing a PrivateLinkResources operations.

model interface PrivateLinkScopeValidationDetails

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a PrivateLinkScopes operations.

Optional parameters.

State of the private endpoint connection.

Describes the firmware of the machine

Product Feature

Product Feature

Describes the Update properties of a Product Profile.

Details on issues that occurred during provisioning.

Properties of a provisioning issue.

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

Properties that define a Resource Association.

The Update Resource model definition.

Describes the properties of a run command parameter.

Contains clientId or objectId (use only one, not both) of a user-assigned managed identity that has access to storage blob used in Run Command. Use an empty RunCommandManagedIdentity object in case of system-assigned identity. Make sure the Azure storage blob exists in case of scriptUri, and managed identity has been given access to blob's container with 'Storage Blob Data Reader' role assignment with scriptUri blob and 'Storage Blob Data Contributor' for Append blobs(outputBlobUri, errorBlobUri). In case of user assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged.

Enable private link validation for an Azure Arc Extension

Describes the status and behavior of a service.

Reports the state and behavior of dependent services.

Concrete proxy resource types can be created by aliasing this type using a specific property type.

Settings Gateway properties

Optional parameters.

Interface representing a Settings operations.

Optional parameters.

Settings properties

Optional parameters.

model interface SetupExtensionRequest

Optional parameters.

A simple poller that can be used to poll a long running operation.

Describes the storage configuration of the machine

Describes the subnet.

Metadata pertaining to creation and last modification of the resource.

A container holding only the Tags for a resource, allowing the user to update the tags on a PrivateLinkScope instance.

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

Optional parameters.

User assigned identity properties

model interface VolumeLicenseDetails

Input for InstallPatches on a Windows VM, as directly received by the API

Property that impacts a resource's logging behavior and its connectivity with other resources and public networks.
KnownAccessMode can be used interchangeably with AccessMode, this enum contains the known values that the service supports.

Known values supported by the service

enforced: Indicates that resource access is controlled by the NSP definition.
audit: Dry run mode, where traffic is evaluated against NSP Rules, logged but not enforced.
learning: Enables traffic evaluation to fall back to resource-specific firewall configurations.

Indicates direction of an access rule.
KnownAccessRuleDirection can be used interchangeably with AccessRuleDirection, this enum contains the known values that the service supports.

Known values supported by the service

Inbound: Traffic originates outside of network.
Outbound: Traffic originates inside the network

Name of configuration mode to use. Modes are pre-defined configurations of security controls, extension allowlists and guest configuration, maintained by Microsoft.
KnownAgentConfigurationMode can be used interchangeably with AgentConfigurationMode, this enum contains the known values that the service supports.

Known values supported by the service

full: full
monitor: monitor

Indicates which kind of Arc machine placement on-premises, such as HCI, SCVMM or VMware etc.
KnownArcKindEnum can be used interchangeably with ArcKindEnum, this enum contains the known values that the service supports.

Known values supported by the service

AVS: AVS
HCI: HCI
SCVMM: SCVMM
VMware: VMware
EPS: EPS
GCP: GCP
AWS: AWS

Specifies the assessment mode.
KnownAssessmentModeTypes can be used interchangeably with AssessmentModeTypes, this enum contains the known values that the service supports.

Known values supported by the service

ImageDefault: ImageDefault
AutomaticByPlatform: AutomaticByPlatform

The supported values for cloud setting as a string literal type

An interface that describes a page of results.

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

Known values supported by the service

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

The ESU eligibility.
KnownEsuEligibility can be used interchangeably with EsuEligibility, this enum contains the known values that the service supports.

Known values supported by the service

Eligible: Eligible
Ineligible: Ineligible
Unknown: Unknown

The ESU key state.
KnownEsuKeyState can be used interchangeably with EsuKeyState, this enum contains the known values that the service supports.

Known values supported by the service

Inactive: Inactive
Active: Active

The server types for Esu.
KnownEsuServerType can be used interchangeably with EsuServerType, this enum contains the known values that the service supports.

Known values supported by the service

Standard: Standard
Datacenter: Datacenter

Script execution status.
KnownExecutionState can be used interchangeably with ExecutionState, this enum contains the known values that the service supports.

Known values supported by the service

Unknown: Unknown
Pending: Pending
Running: Running
Failed: Failed
Succeeded: Succeeded
TimedOut: TimedOut
Canceled: Canceled

The level code.

The type of the Gateway resource.
KnownGatewayType can be used interchangeably with GatewayType, this enum contains the known values that the service supports.

Known values supported by the service

Public: Public

Status of hotpatch enablement or disablement.
KnownHotpatchEnablementStatus can be used interchangeably with HotpatchEnablementStatus, this enum contains the known values that the service supports.

Known values supported by the service

Unknown: Unknown
PendingEvaluation: PendingEvaluation
Disabled: Disabled
ActionRequired: ActionRequired
Enabled: Enabled

Specifies the identity key store a machine is using.
KnownIdentityKeyStore can be used interchangeably with IdentityKeyStore, this enum contains the known values that the service supports.

Known values supported by the service

TPM: TPM
Default: Default

Type of InstanceViewTypes

Specifies the status of Agent Upgrade.
KnownLastAttemptStatusEnum can be used interchangeably with LastAttemptStatusEnum, this enum contains the known values that the service supports.

Known values supported by the service

Success: Success
Failed: Failed

Describes the license assignment state (Assigned or NotAssigned).
KnownLicenseAssignmentState can be used interchangeably with LicenseAssignmentState, this enum contains the known values that the service supports.

Known values supported by the service

Assigned: Assigned
NotAssigned: NotAssigned

Describes the license core type (pCore or vCore).
KnownLicenseCoreType can be used interchangeably with LicenseCoreType, this enum contains the known values that the service supports.

Known values supported by the service

pCore: pCore
vCore: vCore

Describes the edition of the license. The values are either Standard or Datacenter.
KnownLicenseEdition can be used interchangeably with LicenseEdition, this enum contains the known values that the service supports.

Known values supported by the service

Standard: Standard
Datacenter: Datacenter

The product type of the license.
KnownLicenseProfileProductType can be used interchangeably with LicenseProfileProductType, this enum contains the known values that the service supports.

Known values supported by the service

WindowsServer: WindowsServer
WindowsIoTEnterprise: WindowsIoTEnterprise

Subscription status of the OS or Product feature.
KnownLicenseProfileSubscriptionStatus can be used interchangeably with LicenseProfileSubscriptionStatus, this enum contains the known values that the service supports.

Known values supported by the service

Unknown: Unknown
Enabling: Enabling
Enabled: Enabled
Disabled: Disabled
Disabling: Disabling
Failed: Failed

Indicates the new subscription status of the OS or Product Features.
KnownLicenseProfileSubscriptionStatusUpdate can be used interchangeably with LicenseProfileSubscriptionStatusUpdate, this enum contains the known values that the service supports.

Known values supported by the service

Enable: Enable
Disable: Disable

Describes the state of the license.
KnownLicenseState can be used interchangeably with LicenseState, this enum contains the known values that the service supports.

Known values supported by the service

Activated: Activated
Deactivated: Deactivated

The license status.
KnownLicenseStatus can be used interchangeably with LicenseStatus, this enum contains the known values that the service supports.

Known values supported by the service

Unlicensed: Unlicensed
Licensed: Licensed
OOBGrace: OOBGrace
OOTGrace: OOTGrace
NonGenuineGrace: NonGenuineGrace
Notification: Notification
ExtendedGrace: ExtendedGrace

Describes the license target server.
KnownLicenseTarget can be used interchangeably with LicenseTarget, this enum contains the known values that the service supports.

Known values supported by the service

Windows Server 2012: Windows Server 2012
Windows Server 2012 R2: Windows Server 2012 R2
Windows Server 2016: Windows Server 2016 license target.

The type of the license resource.
KnownLicenseType can be used interchangeably with LicenseType, this enum contains the known values that the service supports.

Known values supported by the service

ESU: ESU

The reason describing why the service set the machine status to a particular value.
KnownMachineStatusReason can be used interchangeably with MachineStatusReason, this enum contains the known values that the service supports.

Known values supported by the service

Cloned: Indicates the service has detected that this Arc machine is a clone of another onboarded machine.

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.

The operating system type of the machine.
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
Linux: Linux

Specifies the patch mode.
KnownPatchModeTypes can be used interchangeably with PatchModeTypes, this enum contains the known values that the service supports.

Known values supported by the service

ImageDefault: ImageDefault
AutomaticByPlatform: AutomaticByPlatform
AutomaticByOS: AutomaticByOS
Manual: Manual

Indicates if operation was triggered by user or by platform.
KnownPatchOperationStartedBy can be used interchangeably with PatchOperationStartedBy, this enum contains the known values that the service supports.

Known values supported by the service

User: User
Platform: Platform

The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Unknown", "Failed", "Succeeded", or "CompletedWithWarnings."
KnownPatchOperationStatus can be used interchangeably with PatchOperationStatus, this enum contains the known values that the service supports.

Known values supported by the service

Unknown: Unknown
InProgress: InProgress
Failed: Failed
Succeeded: Succeeded
CompletedWithWarnings: CompletedWithWarnings

Specifies the patch service used for the operation.
KnownPatchServiceUsed can be used interchangeably with PatchServiceUsed, this enum contains the known values that the service supports.

Known values supported by the service

Unknown: Unknown
WU: WU
WU_WSUS: WU_WSUS
YUM: YUM
APT: APT
Zypper: Zypper

Describes the program year the volume license is for.
KnownProgramYear can be used interchangeably with ProgramYear, this enum contains the known values that the service supports.

Known values supported by the service

Year 1: Year 1
Year 2: Year 2
Year 3: Year 3

Severity of the provisioning issue.
KnownProvisioningIssueSeverity can be used interchangeably with ProvisioningIssueSeverity, this enum contains the known values that the service supports.

Known values supported by the service

Warning: Warnings can cause connectivity issues after provisioning succeeds.
Error: Errors will cause association provisioning to fail.

Type of provisioning issue.
KnownProvisioningIssueType can be used interchangeably with ProvisioningIssueType, this enum contains the known values that the service supports.

Known values supported by the service

MissingPerimeterConfiguration: Perimeter configuration is missing.
MissingIdentityConfiguration: Identity configuration is missing.
ConfigurationPropagationFailure: Configuration failed to propagate.
Other: Other failure.

The provisioning state, which only appears in the response.
KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Creating: Creating
Updating: Updating
Deleting: Deleting
Succeeded: Succeeded
Failed: Failed
Accepted: Accepted
Canceled: Canceled
Deleted: Deleted

The network access policy to determine if Azure Arc agents can use public Azure Arc service endpoints. Defaults to disabled (access to Azure Arc services only via private link).
KnownPublicNetworkAccessType can be used interchangeably with PublicNetworkAccessType, this enum contains the known values that the service supports.

Known values supported by the service

Enabled: Allows Azure Arc agents to communicate with Azure Arc services over both public (internet) and private endpoints.
Disabled: Does not allow Azure Arc agents to communicate with Azure Arc services over public (internet) endpoints. The agents must use the private link.
SecuredByPerimeter: Azure Arc agent communication with Azure Arc services over public (internet) is enforced by Network Security Perimeter (NSP).

The network access policy to determine if the specified Azure Arc Extension can use public Azure Arc Extension service endpoints.
KnownServiceExtensionPublicNetworkAccess can be used interchangeably with ServiceExtensionPublicNetworkAccess, this enum contains the known values that the service supports.

Known values supported by the service

Enabled: Allows Azure Arc Extension agents to communicate with Azure Arc services over both public (internet) and private endpoints.
Disabled: Does not allow Azure Arc Extension agents to communicate with Azure Arc services over public (internet) endpoints. The agents must use the private link.

The name of the Azure Arc Extension.

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: Info
Warning: Warning
Error: Error

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

Known values supported by the service

Connected: Connected
Disconnected: Disconnected
Error: Error
AwaitingConnection: AwaitingConnection

Type of VMGuestPatchClassificationLinux

Type of VMGuestPatchClassificationWindows

Defines when it is acceptable to reboot a VM during a software update operation.
KnownVMGuestPatchRebootSetting can be used interchangeably with VMGuestPatchRebootSetting, this enum contains the known values that the service supports.

Known values supported by the service

IfRequired: IfRequired
Never: Never
Always: Always

The reboot state of the VM following completion of the operation.
KnownVMGuestPatchRebootStatus can be used interchangeably with VMGuestPatchRebootStatus, this enum contains the known values that the service supports.

Known values supported by the service

Unknown: Unknown
NotNeeded: NotNeeded
Required: Required
Started: Started
Failed: Failed
Completed: Completed

An enum to describe Azure Cloud environments.

Property that impacts a resource's logging behavior and its connectivity with other resources and public networks.

Indicates direction of an access rule.

Name of configuration mode to use. Modes are pre-defined configurations of security controls, extension allowlists and guest configuration, maintained by Microsoft.

Indicates which kind of Arc machine placement on-premises, such as HCI, SCVMM or VMware etc.

Specifies the assessment mode.

The kind of entity that created the resource.

The ESU eligibility.

The ESU key state.

The server types for Esu.

Script execution status.

The type of the Gateway resource.

Status of hotpatch enablement or disablement.

Specifies the identity key store a machine is using.

Known values of InstanceViewTypes that the service accepts.

Specifies the status of Agent Upgrade.

Describes the license assignment state (Assigned or NotAssigned).

Describes the license core type (pCore or vCore).

Describes the edition of the license. The values are either Standard or Datacenter.

The product type of the license.

Subscription status of the OS or Product feature.

Indicates the new subscription status of the OS or Product Features.

Describes the state of the license.

The license status.

Describes the license target server.

The type of the license resource.

The reason describing why the service set the machine status to a particular value.

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

The operating system type of the machine.

Specifies the patch mode.

Indicates if operation was triggered by user or by platform.

The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Unknown", "Failed", "Succeeded", or "CompletedWithWarnings."

Specifies the patch service used for the operation.

Describes the program year the volume license is for.

Severity of the provisioning issue.

Type of provisioning issue.

The provisioning state, which only appears in the response.

The network access policy to determine if Azure Arc agents can use public Azure Arc service endpoints. Defaults to disabled (access to Azure Arc services only via private link).

The network access policy to determine if the specified Azure Arc Extension can use public Azure Arc Extension service endpoints.

The level code.

The status of the hybrid machine agent.

Known values of <xref:VMGuestPatchClassification_Linux> that the service accepts.

Known values of <xref:VMGuestPatchClassification_Windows> that the service accepts.

Defines when it is acceptable to reboot a VM during a software update operation.

The reboot state of the VM following completion of the operation.

The available API versions.

Typeguard for RestError

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.

A custom error type for failed pipeline requests.