Package-level declarations

Types

Link copied to clipboard
data class AdditionalUnattendContentResponse(val componentName: String? = null, val passName: String? = null, val settingName: String? = null)

Specifies additional XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. Contents are defined by setting name, component name, and the pass in which the content is applied.

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

The API entity reference.

Link copied to clipboard
data class ApplicationProfileResponse(val galleryApplications: List<VMGalleryApplicationResponse>? = null)

Contains the list of gallery applications that should be made available to the VM/VMSS

Link copied to clipboard
data class BaseVirtualMachineProfileResponse(val applicationProfile: ApplicationProfileResponse? = null, val capacityReservation: CapacityReservationProfileResponse? = null, val diagnosticsProfile: DiagnosticsProfileResponse? = null, val extensionProfile: VirtualMachineScaleSetExtensionProfileResponse? = null, val hardwareProfile: VirtualMachineScaleSetHardwareProfileResponse? = null, val licenseType: String? = null, val networkProfile: VirtualMachineScaleSetNetworkProfileResponse? = null, val osProfile: VirtualMachineScaleSetOSProfileResponse? = null, val scheduledEventsProfile: ScheduledEventsProfileResponse? = null, val securityPostureReference: SecurityPostureReferenceResponse? = null, val securityProfile: SecurityProfileResponse? = null, val serviceArtifactReference: ServiceArtifactReferenceResponse? = null, val storageProfile: VirtualMachineScaleSetStorageProfileResponse? = null, val timeCreated: String, val userData: String? = null)

Describes the base virtual machine profile for fleet

Link copied to clipboard
data class BootDiagnosticsResponse(val enabled: Boolean? = null, val storageUri: String? = null)

Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. You can easily view the output of your console log. Azure also enables you to see a screenshot of the VM from the hypervisor.

Link copied to clipboard
data class CapacityReservationProfileResponse(val capacityReservationGroup: SubResourceResponse? = null)

The parameters of a capacity reservation Profile.

Link copied to clipboard
data class ComputeProfileResponse(val baseVirtualMachineProfile: BaseVirtualMachineProfileResponse, val computeApiVersion: String? = null, val platformFaultDomainCount: Int? = null)

Compute Profile to use for running user's workloads.

Link copied to clipboard
data class DiagnosticsProfileResponse(val bootDiagnostics: BootDiagnosticsResponse? = null)

Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15.

Link copied to clipboard
data class DiffDiskSettingsResponse(val option: String? = null, val placement: String? = null)

Describes the parameters of ephemeral disk settings that can be specified for operating system disk. Note: The ephemeral disk settings can only be specified for managed disk.

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

Describes the parameter of customer managed disk encryption set resource id that can be specified for disk. Note: The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details.

Link copied to clipboard
data class EncryptionIdentityResponse(val userAssignedIdentityResourceId: String? = null)

Specifies the Managed Identity used by ADE to get access token for keyvault operations.

Link copied to clipboard
data class GetFleetResult(val computeProfile: ComputeProfileResponse, val id: String, val identity: ManagedServiceIdentityResponse? = null, val location: String, val name: String, val plan: PlanResponse? = null, val provisioningState: String, val regularPriorityProfile: RegularPriorityProfileResponse? = null, val spotPriorityProfile: SpotPriorityProfileResponse? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val timeCreated: String, val type: String, val uniqueId: String, val vmSizesProfile: List<VmSizeProfileResponse>, val zones: List<String>? = null)

An Compute Fleet resource

Link copied to clipboard
data class ImageReferenceResponse(val communityGalleryImageId: String? = null, val exactVersion: String, val id: String? = null, val offer: String? = null, val publisher: String? = null, val sharedGalleryImageId: String? = null, val sku: String? = null, val version: String? = null)

Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. NOTE: Image reference publisher and offer can only be set when you create the scale set.

Link copied to clipboard
data class KeyVaultSecretReferenceResponse(val secretUrl: String, val sourceVault: SubResourceResponse)

Describes a reference to Key Vault Secret

Link copied to clipboard
data class LinuxConfigurationResponse(val disablePasswordAuthentication: Boolean? = null, val enableVMAgentPlatformUpdates: Boolean? = null, val patchSettings: LinuxPatchSettingsResponse? = null, val provisionVMAgent: Boolean? = null, val ssh: SshConfigurationResponse? = null)

Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see [Linux on Azure-Endorsed

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

Specifies settings related to VM Guest Patching on Linux.

data class LinuxVMGuestPatchAutomaticByPlatformSettingsResponse(val bypassPlatformSafetyChecksOnUserSchedule: Boolean? = null, val rebootSetting: String? = null)

Specifies additional settings to be applied when patch mode AutomaticByPlatform is selected in Linux patch settings.

Link copied to clipboard
data class ManagedServiceIdentityResponse(val principalId: String, val tenantId: String, val type: String, val userAssignedIdentities: Map<String, UserAssignedIdentityResponse>? = null)

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

Link copied to clipboard
data class OSImageNotificationProfileResponse(val enable: Boolean? = null, val notBeforeTimeout: String? = null)

Specifies OS Image Scheduled Event related configurations.

Link copied to clipboard
data class PatchSettingsResponse(val assessmentMode: String? = null, val automaticByPlatformSettings: WindowsVMGuestPatchAutomaticByPlatformSettingsResponse? = null, val enableHotpatching: Boolean? = null, val patchMode: String? = null)

Specifies settings related to VM Guest Patching on Windows.

Link copied to clipboard
data class PlanResponse(val name: String, val product: String, val promotionCode: String? = null, val publisher: String, val version: String? = null)

Plan for the resource.

Link copied to clipboard
data class ProxyAgentSettingsResponse(val enabled: Boolean? = null, val keyIncarnationId: Int? = null, val mode: String? = null)

Specifies ProxyAgent settings while creating the virtual machine. Minimum api-version: 2023-09-01.

Link copied to clipboard
data class PublicIPAddressSkuResponse(val name: String? = null, val tier: String? = null)

Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible.

Link copied to clipboard
data class RegularPriorityProfileResponse(val allocationStrategy: String? = null, val capacity: Int? = null, val minCapacity: Int? = null)

Configuration Options for Regular instances in Compute Fleet.

Link copied to clipboard
data class ScheduledEventsProfileResponse(val osImageNotificationProfile: OSImageNotificationProfileResponse? = null, val terminateNotificationProfile: TerminateNotificationProfileResponse? = null)

Specifies Scheduled Event related configurations.

Link copied to clipboard
data class SecurityPostureReferenceResponse(val excludeExtensions: List<String>? = null, val id: String? = null, val isOverridable: Boolean? = null)

Specifies the security posture to be used for all virtual machines in the scale set. Minimum api-version: 2023-03-01

Link copied to clipboard
data class SecurityProfileResponse(val encryptionAtHost: Boolean? = null, val encryptionIdentity: EncryptionIdentityResponse? = null, val proxyAgentSettings: ProxyAgentSettingsResponse? = null, val securityType: String? = null, val uefiSettings: UefiSettingsResponse? = null)

Specifies the Security profile settings for the virtual machine or virtual machine scale set.

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

Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version. Minimum api-version: 2022-11-01

Link copied to clipboard
data class SpotPriorityProfileResponse(val allocationStrategy: String? = null, val capacity: Int? = null, val evictionPolicy: String? = null, val maintain: Boolean? = null, val maxPricePerVM: Double? = null, val minCapacity: Int? = null)

Configuration Options for Spot instances in Compute Fleet.

Link copied to clipboard
data class SshConfigurationResponse(val publicKeys: List<SshPublicKeyResponse>? = null)

SSH configuration for Linux based VMs running on Azure

Link copied to clipboard
data class SshPublicKeyResponse(val keyData: String? = null, val path: String? = null)

Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed.

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

Describes SubResource

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 TerminateNotificationProfileResponse(val enable: Boolean? = null, val notBeforeTimeout: String? = null)

Specifies Terminate Scheduled Event related configurations.

Link copied to clipboard
data class UefiSettingsResponse(val secureBootEnabled: Boolean? = null, val vTpmEnabled: Boolean? = null)

Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum api-version: 2020-12-01.

Link copied to clipboard
data class UserAssignedIdentityResponse(val clientId: String, val principalId: String)

User assigned identity properties

Link copied to clipboard
data class VaultCertificateResponse(val certificateStore: String? = null, val certificateUrl: String? = null)

Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM.

Link copied to clipboard
data class VaultSecretGroupResponse(val sourceVault: SubResourceResponse? = null, val vaultCertificates: List<VaultCertificateResponse>? = null)

Describes a set of certificates which are all in the same Key Vault.

Link copied to clipboard
data class VirtualHardDiskResponse(val uri: String? = null)

Describes the uri of a disk.

Link copied to clipboard
data class VirtualMachineScaleSetDataDiskResponse(val caching: String? = null, val createOption: String, val deleteOption: String? = null, val diskIOPSReadWrite: Double? = null, val diskMBpsReadWrite: Double? = null, val diskSizeGB: Int? = null, val lun: Int, val managedDisk: VirtualMachineScaleSetManagedDiskParametersResponse? = null, val name: String? = null, val writeAcceleratorEnabled: Boolean? = null)

Describes a virtual machine scale set data disk.

data class VirtualMachineScaleSetExtensionProfileResponse(val extensions: List<VirtualMachineScaleSetExtensionResponse>? = null, val extensionsTimeBudget: String? = null)

Describes a virtual machine scale set extension profile.

data class VirtualMachineScaleSetExtensionPropertiesResponse(val autoUpgradeMinorVersion: Boolean? = null, val enableAutomaticUpgrade: Boolean? = null, val forceUpdateTag: String? = null, val protectedSettingsFromKeyVault: KeyVaultSecretReferenceResponse? = null, val provisionAfterExtensions: List<String>? = null, val provisioningState: String, val publisher: String? = null, val settings: Any? = null, val suppressFailures: Boolean? = null, val type: String? = null, val typeHandlerVersion: String? = null)

Describes the properties of a Virtual Machine Scale Set Extension.

Link copied to clipboard
data class VirtualMachineScaleSetExtensionResponse(val id: String, val name: String? = null, val properties: VirtualMachineScaleSetExtensionPropertiesResponse? = null, val type: String)

Describes a Virtual Machine Scale Set Extension.

Specifies the hardware settings for the virtual machine scale set.

data class VirtualMachineScaleSetIPConfigurationPropertiesResponse(val applicationGatewayBackendAddressPools: List<SubResourceResponse>? = null, val applicationSecurityGroups: List<SubResourceResponse>? = null, val loadBalancerBackendAddressPools: List<SubResourceResponse>? = null, val loadBalancerInboundNatPools: List<SubResourceResponse>? = null, val primary: Boolean? = null, val privateIPAddressVersion: String? = null, val publicIPAddressConfiguration: VirtualMachineScaleSetPublicIPAddressConfigurationResponse? = null, val subnet: ApiEntityReferenceResponse? = null)

Describes a virtual machine scale set network profile's IP configuration properties.

Describes a virtual machine scale set network profile's IP configuration.

Link copied to clipboard
data class VirtualMachineScaleSetIpTagResponse(val ipTagType: String? = null, val tag: String? = null)

Contains the IP tag associated with the public IP address.

data class VirtualMachineScaleSetManagedDiskParametersResponse(val diskEncryptionSet: DiskEncryptionSetParametersResponse? = null, val securityProfile: VMDiskSecurityProfileResponse? = null, val storageAccountType: String? = null)

Describes the parameters of a ScaleSet managed disk.

Describes a virtual machines scale sets network configuration's DNS settings.

data class VirtualMachineScaleSetNetworkConfigurationPropertiesResponse(val auxiliaryMode: String? = null, val auxiliarySku: String? = null, val deleteOption: String? = null, val disableTcpStateTracking: Boolean? = null, val dnsSettings: VirtualMachineScaleSetNetworkConfigurationDnsSettingsResponse? = null, val enableAcceleratedNetworking: Boolean? = null, val enableFpga: Boolean? = null, val enableIPForwarding: Boolean? = null, val ipConfigurations: List<VirtualMachineScaleSetIPConfigurationResponse>, val networkSecurityGroup: SubResourceResponse? = null, val primary: Boolean? = null)

Describes a virtual machine scale set network profile's IP configuration.

Describes a virtual machine scale set network profile's network configurations.

data class VirtualMachineScaleSetNetworkProfileResponse(val healthProbe: ApiEntityReferenceResponse? = null, val networkApiVersion: String? = null, val networkInterfaceConfigurations: List<VirtualMachineScaleSetNetworkConfigurationResponse>? = null)

Describes a virtual machine scale set network profile.

Link copied to clipboard
data class VirtualMachineScaleSetOSDiskResponse(val caching: String? = null, val createOption: String, val deleteOption: String? = null, val diffDiskSettings: DiffDiskSettingsResponse? = null, val diskSizeGB: Int? = null, val image: VirtualHardDiskResponse? = null, val managedDisk: VirtualMachineScaleSetManagedDiskParametersResponse? = null, val name: String? = null, val osType: String? = null, val vhdContainers: List<String>? = null, val writeAcceleratorEnabled: Boolean? = null)

Describes a virtual machine scale set operating system disk.

Link copied to clipboard
data class VirtualMachineScaleSetOSProfileResponse(val adminUsername: String? = null, val allowExtensionOperations: Boolean? = null, val computerNamePrefix: String? = null, val linuxConfiguration: LinuxConfigurationResponse? = null, val requireGuestProvisionSignal: Boolean? = null, val secrets: List<VaultSecretGroupResponse>? = null, val windowsConfiguration: WindowsConfigurationResponse? = null)

Describes a virtual machine scale set OS profile.

data class VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettingsResponse(val domainNameLabel: String, val domainNameLabelScope: String? = null)

Describes a virtual machines scale sets network configuration's DNS settings.

data class VirtualMachineScaleSetPublicIPAddressConfigurationPropertiesResponse(val deleteOption: String? = null, val dnsSettings: VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettingsResponse? = null, val idleTimeoutInMinutes: Int? = null, val ipTags: List<VirtualMachineScaleSetIpTagResponse>? = null, val publicIPAddressVersion: String? = null, val publicIPPrefix: SubResourceResponse? = null)

Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration

Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration

data class VirtualMachineScaleSetStorageProfileResponse(val dataDisks: List<VirtualMachineScaleSetDataDiskResponse>? = null, val diskControllerType: String? = null, val imageReference: ImageReferenceResponse? = null, val osDisk: VirtualMachineScaleSetOSDiskResponse? = null)

Describes a virtual machine scale set storage profile.

Link copied to clipboard
data class VMDiskSecurityProfileResponse(val diskEncryptionSet: DiskEncryptionSetParametersResponse? = null, val securityEncryptionType: String? = null)

Specifies the security profile settings for the managed disk. Note: It can only be set for Confidential VMs.

Link copied to clipboard
data class VMGalleryApplicationResponse(val configurationReference: String? = null, val enableAutomaticUpgrade: Boolean? = null, val order: Int? = null, val packageReferenceId: String, val tags: String? = null, val treatFailureAsDeploymentFailure: Boolean? = null)

Specifies the required information to reference a compute gallery application version

Link copied to clipboard
data class VmSizeProfileResponse(val name: String, val rank: Int? = null)

Specifications about a VM Size. This will also contain the corresponding rank and weight in future.

Link copied to clipboard
data class VMSizePropertiesResponse(val vCPUsAvailable: Int? = null, val vCPUsPerCore: Int? = null)

Specifies VM Size Property settings on the virtual machine.

Link copied to clipboard
data class WindowsConfigurationResponse(val additionalUnattendContent: List<AdditionalUnattendContentResponse>? = null, val enableAutomaticUpdates: Boolean? = null, val enableVMAgentPlatformUpdates: Boolean? = null, val patchSettings: PatchSettingsResponse? = null, val provisionVMAgent: Boolean? = null, val timeZone: String? = null, val winRM: WinRMConfigurationResponse? = null)

Specifies Windows operating system settings on the virtual machine.

data class WindowsVMGuestPatchAutomaticByPlatformSettingsResponse(val bypassPlatformSafetyChecksOnUserSchedule: Boolean? = null, val rebootSetting: String? = null)

Specifies additional settings to be applied when patch mode AutomaticByPlatform is selected in Windows patch settings.

Link copied to clipboard
data class WinRMConfigurationResponse(val listeners: List<WinRMListenerResponse>? = null)

Describes Windows Remote Management configuration of the VM

Link copied to clipboard
data class WinRMListenerResponse(val certificateUrl: String? = null, val protocol: String? = null)

Describes Protocol and thumbprint of Windows Remote Management listener