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 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: String? = null, val sku: String? = null)

ESU key

Link copied to clipboard
data class GetLicenseProfileResult(val assignedLicense: String? = null, val assignedLicenseImmutableId: String, val esuEligibility: String, val esuKeyState: String, val esuKeys: List<EsuKeyResponse>, val id: String, val location: String, val name: String, val provisioningState: String, val serverType: String, 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 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 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 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 lastStatusChange: String, val location: String, val locationData: LocationDataResponse? = null, val machineFqdn: String, val mssqlDiscovered: String? = null, val name: 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 GetPrivateEndpointConnectionResult(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 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 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 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)

Describes the properties of a License.

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 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 patchMode: String? = null)

Specifies the linux configuration for update management.

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

Specifies the windows configuration for update management.

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 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 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.