Package-level declarations

Types

Link copied to clipboard
data class AgentConfigurationResponse(val configMode: String, val extensionsAllowList: List<ConfigurationExtensionResponse>, val extensionsBlockList: List<ConfigurationExtensionResponse>, val extensionsEnabled: String, val guestConfigurationEnabled: String, val incomingConnectionsPorts: List<String>, val proxyBypass: List<String>, val proxyUrl: String)

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

Link copied to clipboard
data class AgentUpgradeResponse(val correlationId: String? = null, val desiredVersion: String? = null, val enableAutomaticUpgrade: Boolean? = null, val lastAttemptDesiredVersion: String, val lastAttemptMessage: String, val lastAttemptStatus: String, val lastAttemptTimestamp: String)

The info w.r.t Agent Upgrade.

Link copied to clipboard
data class CloudMetadataResponse(val provider: String)

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

Link copied to clipboard
data class ConfigurationExtensionResponse(val publisher: String, val type: String)

Describes properties that can identify extensions.

Link copied to clipboard
data class ErrorAdditionalInfoResponse(val info: Any, val type: String)

The resource management error additional info.

Link copied to clipboard
data class ErrorDetailResponse(val additionalInfo: List<ErrorAdditionalInfoResponse>, val code: String, val details: List<ErrorDetailResponse>, val message: String, val target: String)

The error detail.

Link copied to clipboard
data class EsuKeyResponse(val licenseStatus: Int? = null, val sku: String? = null)

ESU key

Link copied to clipboard
data class ExtensionsResourceStatusResponse(val code: String? = null, val displayStatus: String? = null, val level: String? = null, val message: String? = null, val time: String? = null)

Instance view status.

Link copied to clipboard
data class GetGatewayResult(val allowedFeatures: List<String>? = null, val azureApiVersion: String, val gatewayEndpoint: String, val gatewayId: String, val gatewayType: String? = null, val id: String, val location: String, val name: String, val provisioningState: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Describes an Arc Gateway.

Link copied to clipboard
data class GetLicenseProfileResult(val assignedLicense: String? = null, val assignedLicenseImmutableId: String, val azureApiVersion: String, val billingEndDate: String, val billingStartDate: String, val disenrollmentDate: String, val enrollmentDate: String, val error: ErrorDetailResponse, val esuEligibility: String, val esuKeyState: String, val esuKeys: List<EsuKeyResponse>, val id: String, val location: String, val name: String, val productFeatures: List<ProductFeatureResponse>? = null, val productType: String? = null, val provisioningState: String, val serverType: String, val softwareAssuranceCustomer: Boolean? = null, val subscriptionStatus: String? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Describes a license profile in a hybrid machine.

Link copied to clipboard
data class GetLicenseResult(val azureApiVersion: String, val id: String, val licenseDetails: LicenseDetailsResponse? = null, val licenseType: String? = null, val location: String, val name: String, val provisioningState: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val tenantId: String? = null, val type: String)

Describes a license in a hybrid machine.

Link copied to clipboard
data class GetMachineExtensionResult(val azureApiVersion: String, val id: String, val location: String, val name: String, val properties: MachineExtensionPropertiesResponse, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Describes a Machine Extension.

Link copied to clipboard
data class GetMachineResult(val adFqdn: String, val agentConfiguration: AgentConfigurationResponse, val agentUpgrade: AgentUpgradeResponse? = null, val agentVersion: String, val azureApiVersion: String, val clientPublicKey: String? = null, val cloudMetadata: CloudMetadataResponse? = null, val detectedProperties: Map<String, String>, val displayName: String, val dnsFqdn: String, val domainName: String, val errorDetails: List<ErrorDetailResponse>, val extensions: List<MachineExtensionInstanceViewResponse>? = null, val id: String, val identity: IdentityResponse? = null, val kind: String? = null, val lastStatusChange: String, val licenseProfile: LicenseProfileMachineInstanceViewResponse? = null, val location: String, val locationData: LocationDataResponse? = null, val machineFqdn: String, val mssqlDiscovered: String? = null, val name: String, val networkProfile: NetworkProfileResponse, val osEdition: String, val osName: String, val osProfile: OSProfileResponse? = null, val osSku: String, val osType: String? = null, val osVersion: String, val parentClusterResourceId: String? = null, val privateLinkScopeResourceId: String? = null, val provisioningState: String, val resources: List<MachineExtensionResponse>, val serviceStatuses: ServiceStatusesResponse? = null, val status: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val vmId: String? = null, val vmUuid: String)

Describes a hybrid machine.

Link copied to clipboard
data class GetMachineRunCommandResult(val asyncExecution: Boolean? = null, val azureApiVersion: String, val errorBlobManagedIdentity: RunCommandManagedIdentityResponse? = null, val errorBlobUri: String? = null, val id: String, val instanceView: MachineRunCommandInstanceViewResponse, val location: String, val name: String, val outputBlobManagedIdentity: RunCommandManagedIdentityResponse? = null, val outputBlobUri: String? = null, val parameters: List<RunCommandInputParameterResponse>? = null, val protectedParameters: List<RunCommandInputParameterResponse>? = null, val provisioningState: String, val runAsPassword: String? = null, val runAsUser: String? = null, val source: MachineRunCommandScriptSourceResponse? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val timeoutInSeconds: Int? = null, val type: String)

Describes a Run Command

Link copied to clipboard
data class GetPrivateEndpointConnectionResult(val azureApiVersion: String, val id: String, val name: String, val properties: PrivateEndpointConnectionPropertiesResponse, val systemData: SystemDataResponse, val type: String)

A private endpoint connection

Link copied to clipboard
data class GetPrivateLinkScopedResourceResult(val azureApiVersion: String, val id: String, val linkedResourceId: String? = null, val name: String, val provisioningState: String, val type: String)

A private link scoped resource

Link copied to clipboard
data class GetPrivateLinkScopeResult(val azureApiVersion: String, val id: String, val location: String, val name: String, val properties: HybridComputePrivateLinkScopePropertiesResponse, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

An Azure Arc PrivateLinkScope definition.

data class HybridComputePrivateLinkScopePropertiesResponse(val privateEndpointConnections: List<PrivateEndpointConnectionDataModelResponse>, val privateLinkScopeId: String, val provisioningState: String, val publicNetworkAccess: String? = null)

Properties that define a Azure Arc PrivateLinkScope resource.

Link copied to clipboard
data class IdentityResponse(val principalId: String, val tenantId: String, val type: String? = null)

Identity for the resource.

Link copied to clipboard
data class IpAddressResponse(val address: String? = null, val ipAddressVersion: String? = null, val subnet: SubnetResponse)

Describes properties of the IP address.

Link copied to clipboard
data class LicenseDetailsResponse(val assignedLicenses: Int, val edition: String? = null, val immutableId: String, val processors: Int? = null, val state: String? = null, val target: String? = null, val type: String? = null, val volumeLicenseDetails: List<VolumeLicenseDetailsResponse>? = null)

Describes the properties of a License.

data class LicenseProfileMachineInstanceViewEsuPropertiesResponse(val assignedLicense: LicenseResponse? = null, val assignedLicenseImmutableId: String, val esuEligibility: String, val esuKeyState: String, val esuKeys: List<EsuKeyResponse>, val licenseAssignmentState: String? = null, val serverType: String)

Properties for the Machine ESU profile.

data class LicenseProfileMachineInstanceViewResponse(val billingEndDate: String, val billingStartDate: String, val disenrollmentDate: String, val enrollmentDate: String, val error: ErrorDetailResponse, val esuProfile: LicenseProfileMachineInstanceViewEsuPropertiesResponse? = null, val licenseChannel: String, val licenseStatus: String, val productFeatures: List<ProductFeatureResponse>? = null, val productType: String? = null, val softwareAssuranceCustomer: Boolean? = null, val subscriptionStatus: String? = null)

License Profile Instance View in Machine Properties.

Link copied to clipboard
data class LicenseResponse(val id: String, val licenseDetails: LicenseDetailsResponse? = null, val licenseType: String? = null, val location: String, val name: String, val provisioningState: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val tenantId: String? = null, val type: String)

Describes a license in a hybrid machine.

Link copied to clipboard
data class LocationDataResponse(val city: String? = null, val countryOrRegion: String? = null, val district: String? = null, val name: String)

Metadata pertaining to the geographic location of the resource.

Link copied to clipboard
data class MachineExtensionInstanceViewResponse(val name: String? = null, val status: MachineExtensionInstanceViewResponseStatus? = null, val type: String? = null, val typeHandlerVersion: String? = null)

Describes the Machine Extension Instance View.

data class MachineExtensionInstanceViewResponseStatus(val code: String? = null, val displayStatus: String? = null, val level: String? = null, val message: String? = null, val time: String? = null)

Instance view status.

Link copied to clipboard
data class MachineExtensionPropertiesResponse(val autoUpgradeMinorVersion: Boolean? = null, val enableAutomaticUpgrade: Boolean? = null, val forceUpdateTag: String? = null, val instanceView: MachineExtensionInstanceViewResponse? = null, val protectedSettings: Any? = null, val provisioningState: String, val publisher: String? = null, val settings: Any? = null, val type: String? = null, val typeHandlerVersion: String? = null)

Describes the properties of a Machine Extension.

Link copied to clipboard
data class MachineExtensionResponse(val id: String, val location: String, val name: String, val properties: MachineExtensionPropertiesResponse? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Describes a Machine Extension.

Link copied to clipboard
data class MachineRunCommandInstanceViewResponse(val endTime: String? = null, val error: String? = null, val executionMessage: String? = null, val executionState: String? = null, val exitCode: Int? = null, val output: String? = null, val startTime: String? = null, val statuses: List<ExtensionsResourceStatusResponse>? = null)

The instance view of a machine run command.

Link copied to clipboard
data class MachineRunCommandScriptSourceResponse(val commandId: String? = null, val script: String? = null, val scriptUri: String? = null, val scriptUriManagedIdentity: RunCommandManagedIdentityResponse? = null)

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

Link copied to clipboard
data class NetworkInterfaceResponse(val ipAddresses: List<IpAddressResponse>? = null)

Describes a network interface.

Link copied to clipboard
data class NetworkProfileResponse(val networkInterfaces: List<NetworkInterfaceResponse>? = null)

Describes the network information on this machine.

Link copied to clipboard
data class OSProfileResponse(val computerName: String, val linuxConfiguration: OSProfileResponseLinuxConfiguration? = null, val windowsConfiguration: OSProfileResponseWindowsConfiguration? = null)

Specifies the operating system settings for the hybrid machine.

Link copied to clipboard
data class OSProfileResponseLinuxConfiguration(val assessmentMode: String? = null, val enableHotpatching: Boolean? = null, val patchMode: String? = null, val status: PatchSettingsResponseStatus)

Specifies the linux configuration for update management.

Link copied to clipboard
data class OSProfileResponseWindowsConfiguration(val assessmentMode: String? = null, val enableHotpatching: Boolean? = null, val patchMode: String? = null, val status: PatchSettingsResponseStatus)

Specifies the windows configuration for update management.

Link copied to clipboard
data class PatchSettingsResponseStatus(val error: ErrorDetailResponse, val hotpatchEnablementStatus: String? = null)

Status of the hotpatch capability enrollment or disenrollment.

data class PrivateEndpointConnectionDataModelResponse(val id: String, val name: String, val properties: PrivateEndpointConnectionPropertiesResponse? = null, val type: String)

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

data class PrivateEndpointConnectionPropertiesResponse(val groupIds: List<String>, val privateEndpoint: PrivateEndpointPropertyResponse? = null, val privateLinkServiceConnectionState: PrivateLinkServiceConnectionStatePropertyResponse? = null, val provisioningState: String)

Properties of a private endpoint connection.

Link copied to clipboard
data class PrivateEndpointPropertyResponse(val id: String? = null)

Private endpoint which the connection belongs to.

data class PrivateLinkServiceConnectionStatePropertyResponse(val actionsRequired: String, val description: String, val status: String)

State of the private endpoint connection.

Link copied to clipboard
data class ProductFeatureResponse(val billingEndDate: String, val billingStartDate: String, val disenrollmentDate: String, val enrollmentDate: String, val error: ErrorDetailResponse, val name: String? = null, val subscriptionStatus: String? = null)

Product Feature

Link copied to clipboard
data class RunCommandInputParameterResponse(val name: String, val value: String)

Describes the properties of a run command parameter.

Link copied to clipboard
data class RunCommandManagedIdentityResponse(val clientId: String? = null, val objectId: String? = null)

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.

Link copied to clipboard
data class ServiceStatusesResponse(val extensionService: ServiceStatusResponse? = null, val guestConfigurationService: ServiceStatusResponse? = null)

Reports the state and behavior of dependent services.

Link copied to clipboard
data class ServiceStatusResponse(val startupType: String? = null, val status: String? = null)

Describes the status and behavior of a service.

Link copied to clipboard
data class SubnetResponse(val addressPrefix: String? = null)

Describes the subnet.

Link copied to clipboard
data class SystemDataResponse(val createdAt: String? = null, val createdBy: String? = null, val createdByType: String? = null, val lastModifiedAt: String? = null, val lastModifiedBy: String? = null, val lastModifiedByType: String? = null)

Metadata pertaining to creation and last modification of the resource.

Link copied to clipboard
data class VolumeLicenseDetailsResponse(val invoiceId: String? = null, val programYear: String? = null)