pulumi-azure-native-kotlin/com.pulumi.azurenative.compute.kotlin.outputs

Package-level declarations

Types

data class AdditionalCapabilitiesResponse(val ultraSSDEnabled: Boolean? = null)

Enables or disables a capability on the virtual machine or virtual machine scale set.

data class AdditionalUnattendContentResponse(val componentName: String? = null, val content: 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.

ApiEntityReferenceResponse

data class ApiEntityReferenceResponse(val id: String? = null)

The API entity reference.

ApiErrorBaseResponse

data class ApiErrorBaseResponse(val code: String? = null, val message: String? = null, val target: String? = null)

Api error base.

ApiErrorResponse

data class ApiErrorResponse(val code: String? = null, val details: List<ApiErrorBaseResponse>? = null, val innererror: InnerErrorResponse? = null, val message: String? = null, val target: String? = null)

Api error.

AutomaticOSUpgradePolicyResponse

data class AutomaticOSUpgradePolicyResponse(val disableAutomaticRollback: Boolean? = null, val enableAutomaticOSUpgrade: Boolean? = null)

The configuration parameters used for performing automatic OS upgrade.

AutomaticRepairsPolicyResponse

data class AutomaticRepairsPolicyResponse(val enabled: Boolean? = null, val gracePeriod: String? = null)

Specifies the configuration parameters for automatic repairs on the virtual machine scale set.

AvailablePatchSummaryResponse

data class AvailablePatchSummaryResponse(val assessmentActivityId: String, val criticalAndSecurityPatchCount: Int, val error: ApiErrorResponse, val lastModifiedTime: String, val otherPatchCount: Int, val rebootPending: Boolean, val startTime: String, val status: String)

Describes the properties of an virtual machine instance view for available patch summary.

BillingProfileResponse

data class BillingProfileResponse(val maxPrice: Double? = null)

Specifies the billing related details of a Azure Spot VM or VMSS.

Minimum api-version: 2019-03-01.

BootDiagnosticsInstanceViewResponse

data class BootDiagnosticsInstanceViewResponse(val consoleScreenshotBlobUri: String, val serialConsoleLogBlobUri: String, val status: InstanceViewStatusResponse)

The instance view of a virtual machine boot diagnostics.

BootDiagnosticsResponse

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.

CapacityReservationGroupInstanceViewResponse

data class CapacityReservationGroupInstanceViewResponse(val capacityReservations: List<CapacityReservationInstanceViewWithNameResponse>)

CapacityReservationInstanceViewResponse

data class CapacityReservationInstanceViewResponse(val statuses: List<InstanceViewStatusResponse>? = null, val utilizationInfo: CapacityReservationUtilizationResponse? = null)

The instance view of a capacity reservation that provides as snapshot of the runtime properties of the capacity reservation that is managed by the platform and can change outside of control plane operations.

CapacityReservationInstanceViewWithNameResponse

data class CapacityReservationInstanceViewWithNameResponse(val name: String, val statuses: List<InstanceViewStatusResponse>? = null, val utilizationInfo: CapacityReservationUtilizationResponse? = null)

The instance view of a capacity reservation that includes the name of the capacity reservation. It is used for the response to the instance view of a capacity reservation group.

CapacityReservationUtilizationResponse

data class CapacityReservationUtilizationResponse(val virtualMachinesAllocated: List<SubResourceReadOnlyResponse>)

Represents the capacity reservation utilization in terms of resources allocated.

CloudServiceExtensionProfileResponse

data class CloudServiceExtensionProfileResponse(val extensions: List<ExtensionResponse>? = null)

Describes a cloud service extension profile.

CloudServiceExtensionPropertiesResponse

data class CloudServiceExtensionPropertiesResponse(val autoUpgradeMinorVersion: Boolean? = null, val forceUpdateTag: String? = null, val protectedSettings: String? = null, val protectedSettingsFromKeyVault: CloudServiceVaultAndSecretReferenceResponse? = null, val provisioningState: String, val publisher: String? = null, val rolesAppliedTo: List<String>? = null, val settings: String? = null, val type: String? = null, val typeHandlerVersion: String? = null)

Extension Properties.

CloudServiceNetworkProfileResponse

data class CloudServiceNetworkProfileResponse(val loadBalancerConfigurations: List<LoadBalancerConfigurationResponse>? = null, val swappableCloudService: SubResourceResponse? = null)

Network Profile for the cloud service.

CloudServiceOsProfileResponse

data class CloudServiceOsProfileResponse(val secrets: List<CloudServiceVaultSecretGroupResponse>? = null)

Describes the OS profile for the cloud service.

CloudServicePropertiesResponse

data class CloudServicePropertiesResponse(val allowModelOverride: Boolean? = null, val configuration: String? = null, val configurationUrl: String? = null, val extensionProfile: CloudServiceExtensionProfileResponse? = null, val networkProfile: CloudServiceNetworkProfileResponse? = null, val osProfile: CloudServiceOsProfileResponse? = null, val packageUrl: String? = null, val provisioningState: String, val roleProfile: CloudServiceRoleProfileResponse? = null, val startCloudService: Boolean? = null, val uniqueId: String, val upgradeMode: String? = null)

Cloud service properties

CloudServiceRoleProfilePropertiesResponse

data class CloudServiceRoleProfilePropertiesResponse(val name: String? = null, val sku: CloudServiceRoleSkuResponse? = null)

Describes the role properties.

CloudServiceRoleProfileResponse

data class CloudServiceRoleProfileResponse(val roles: List<CloudServiceRoleProfilePropertiesResponse>? = null)

Describes the role profile for the cloud service.

CloudServiceRoleSkuResponse

data class CloudServiceRoleSkuResponse(val capacity: Double? = null, val name: String? = null, val tier: String? = null)

Describes the cloud service role sku.

CloudServiceVaultAndSecretReferenceResponse

data class CloudServiceVaultAndSecretReferenceResponse(val secretUrl: String? = null, val sourceVault: SubResourceResponse? = null)

CloudServiceVaultCertificateResponse

data class CloudServiceVaultCertificateResponse(val certificateUrl: String? = null)

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

CloudServiceVaultSecretGroupResponse

data class CloudServiceVaultSecretGroupResponse(val sourceVault: SubResourceResponse? = null, val vaultCertificates: List<CloudServiceVaultCertificateResponse>? = null)

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

CreationDataResponse

data class CreationDataResponse(val createOption: String, val galleryImageReference: ImageDiskReferenceResponse? = null, val imageReference: ImageDiskReferenceResponse? = null, val logicalSectorSize: Int? = null, val sourceResourceId: String? = null, val sourceUniqueId: String, val sourceUri: String? = null, val storageAccountId: String? = null, val uploadSizeBytes: Double? = null)

Data used when creating a disk.

DataDiskImageEncryptionResponse

data class DataDiskImageEncryptionResponse(val diskEncryptionSetId: String? = null, val lun: Int)

Contains encryption settings for a data disk image.

DataDiskResponse

data class DataDiskResponse(val caching: String? = null, val createOption: String, val deleteOption: String? = null, val detachOption: String? = null, val diskIOPSReadWrite: Double, val diskMBpsReadWrite: Double, val diskSizeGB: Int? = null, val image: VirtualHardDiskResponse? = null, val lun: Int, val managedDisk: ManagedDiskParametersResponse? = null, val name: String? = null, val toBeDetached: Boolean? = null, val vhd: VirtualHardDiskResponse? = null, val writeAcceleratorEnabled: Boolean? = null)

Describes a data disk.

DedicatedHostAllocatableVMResponse

data class DedicatedHostAllocatableVMResponse(val count: Double? = null, val vmSize: String? = null)

Represents the dedicated host unutilized capacity in terms of a specific VM size.

DedicatedHostAvailableCapacityResponse

data class DedicatedHostAvailableCapacityResponse(val allocatableVMs: List<DedicatedHostAllocatableVMResponse>? = null)

Dedicated host unutilized capacity.

DedicatedHostGroupInstanceViewResponse

data class DedicatedHostGroupInstanceViewResponse(val hosts: List<DedicatedHostInstanceViewWithNameResponse>? = null)

DedicatedHostInstanceViewResponse

data class DedicatedHostInstanceViewResponse(val assetId: String, val availableCapacity: DedicatedHostAvailableCapacityResponse? = null, val statuses: List<InstanceViewStatusResponse>? = null)

The instance view of a dedicated host.

DedicatedHostInstanceViewWithNameResponse

data class DedicatedHostInstanceViewWithNameResponse(val assetId: String, val availableCapacity: DedicatedHostAvailableCapacityResponse? = null, val name: String, val statuses: List<InstanceViewStatusResponse>? = null)

The instance view of a dedicated host that includes the name of the dedicated host. It is used for the response to the instance view of a dedicated host group.

DiagnosticsProfileResponse

data class DiagnosticsProfileResponse(val bootDiagnostics: BootDiagnosticsResponse? = null)

Specifies the boot diagnostic settings state.

Minimum api-version: 2015-06-15.

DiffDiskSettingsResponse

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.

DisallowedResponse

data class DisallowedResponse(val diskTypes: List<String>? = null)

Describes the disallowed disk types.

DiskEncryptionSetParametersResponse

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.

DiskEncryptionSettingsResponse

data class DiskEncryptionSettingsResponse(val diskEncryptionKey: KeyVaultSecretReferenceResponse? = null, val enabled: Boolean? = null, val keyEncryptionKey: KeyVaultKeyReferenceResponse? = null)

Describes a Encryption Settings for a Disk

DiskInstanceViewResponse

data class DiskInstanceViewResponse(val encryptionSettings: List<DiskEncryptionSettingsResponse>? = null, val name: String? = null, val statuses: List<InstanceViewStatusResponse>? = null)

The instance view of the disk.

DiskSecurityProfileResponse

data class DiskSecurityProfileResponse(val securityType: String? = null)

Contains the security related information for the resource.

DiskSkuResponse

data class DiskSkuResponse(val name: String? = null, val tier: String)

The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, UltraSSD_LRS, Premium_ZRS, or StandardSSD_ZRS.

EncryptionImagesResponse

data class EncryptionImagesResponse(val dataDiskImages: List<DataDiskImageEncryptionResponse>? = null, val osDiskImage: OSDiskImageEncryptionResponse? = null)

Optional. Allows users to provide customer managed keys for encrypting the OS and data disks in the gallery artifact.

EncryptionResponse

data class EncryptionResponse(val diskEncryptionSetId: String? = null, val type: String? = null)

Encryption at rest settings for disk or snapshot

EncryptionSetIdentityResponse

data class EncryptionSetIdentityResponse(val principalId: String, val tenantId: String, val type: String? = null)

The managed identity for the disk encryption set. It should be given permission on the key vault before it can be used to encrypt disks.

EncryptionSettingsCollectionResponse

data class EncryptionSettingsCollectionResponse(val enabled: Boolean, val encryptionSettings: List<EncryptionSettingsElementResponse>? = null, val encryptionSettingsVersion: String? = null)

Encryption settings for disk or snapshot

EncryptionSettingsElementResponse

data class EncryptionSettingsElementResponse(val diskEncryptionKey: KeyVaultAndSecretReferenceResponse? = null, val keyEncryptionKey: KeyVaultAndKeyReferenceResponse? = null)

Encryption settings for one disk volume.

ExtendedLocationResponse

data class ExtendedLocationResponse(val name: String? = null, val type: String? = null)

The complex type of the extended location.

ExtensionResponse

data class ExtensionResponse(val name: String? = null, val properties: CloudServiceExtensionPropertiesResponse? = null)

Describes a cloud service Extension.

GalleryApplicationVersionPublishingProfileResponse

data class GalleryApplicationVersionPublishingProfileResponse(val enableHealthCheck: Boolean? = null, val endOfLifeDate: String? = null, val excludeFromLatest: Boolean? = null, val manageActions: UserArtifactManageResponse? = null, val publishedDate: String, val replicaCount: Int? = null, val source: UserArtifactSourceResponse, val storageAccountType: String? = null, val targetRegions: List<TargetRegionResponse>? = null)

The publishing profile of a gallery image version.

GalleryArtifactVersionSourceResponse

data class GalleryArtifactVersionSourceResponse(val id: String? = null, val uri: String? = null)

The gallery artifact version source.

GalleryDataDiskImageResponse

data class GalleryDataDiskImageResponse(val hostCaching: String? = null, val lun: Int, val sizeInGB: Int, val source: GalleryArtifactVersionSourceResponse? = null)

This is the data disk image.

GalleryIdentifierResponse

data class GalleryIdentifierResponse(val uniqueName: String)

Describes the gallery unique name.

GalleryImageFeatureResponse

data class GalleryImageFeatureResponse(val name: String? = null, val value: String? = null)

A feature for gallery image.

GalleryImageIdentifierResponse

data class GalleryImageIdentifierResponse(val offer: String, val publisher: String, val sku: String)

This is the gallery image definition identifier.

GalleryImageVersionPublishingProfileResponse

data class GalleryImageVersionPublishingProfileResponse(val endOfLifeDate: String? = null, val excludeFromLatest: Boolean? = null, val publishedDate: String, val replicaCount: Int? = null, val storageAccountType: String? = null, val targetRegions: List<TargetRegionResponse>? = null)

The publishing profile of a gallery image Version.

GalleryImageVersionStorageProfileResponse

data class GalleryImageVersionStorageProfileResponse(val dataDiskImages: List<GalleryDataDiskImageResponse>? = null, val osDiskImage: GalleryOSDiskImageResponse? = null, val source: GalleryArtifactVersionSourceResponse? = null)

This is the storage profile of a Gallery Image Version.

GalleryOSDiskImageResponse

data class GalleryOSDiskImageResponse(val hostCaching: String? = null, val sizeInGB: Int, val source: GalleryArtifactVersionSourceResponse? = null)

This is the OS disk image.

GetAvailabilitySetResult

data class GetAvailabilitySetResult(val id: String, val location: String, val name: String, val platformFaultDomainCount: Int? = null, val platformUpdateDomainCount: Int? = null, val proximityPlacementGroup: SubResourceResponse? = null, val sku: SkuResponse? = null, val statuses: List<InstanceViewStatusResponse>, val tags: Map<String, String>? = null, val type: String, val virtualMachines: List<SubResourceResponse>? = null)

Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see Manage the availability of virtual machines.

For more information on Azure planned maintenance, see Planned maintenance for virtual machines in Azure

Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set.

GetCapacityReservationGroupResult

data class GetCapacityReservationGroupResult(val capacityReservations: List<SubResourceReadOnlyResponse>, val id: String, val instanceView: CapacityReservationGroupInstanceViewResponse, val location: String, val name: String, val tags: Map<String, String>? = null, val type: String, val virtualMachinesAssociated: List<SubResourceReadOnlyResponse>, val zones: List<String>? = null)

Specifies information about the capacity reservation group that the capacity reservations should be assigned to.

Currently, a capacity reservation can only be added to a capacity reservation group at creation time. An existing capacity reservation cannot be added or moved to another capacity reservation group.

GetCapacityReservationResult

data class GetCapacityReservationResult(val id: String, val instanceView: CapacityReservationInstanceViewResponse, val location: String, val name: String, val provisioningState: String, val provisioningTime: String, val reservationId: String, val sku: SkuResponse, val tags: Map<String, String>? = null, val type: String, val virtualMachinesAssociated: List<SubResourceReadOnlyResponse>, val zones: List<String>? = null)

Specifies information about the capacity reservation.

GetCloudServiceResult

data class GetCloudServiceResult(val id: String, val location: String, val name: String, val properties: CloudServicePropertiesResponse, val tags: Map<String, String>? = null, val type: String)

Describes the cloud service.

GetDedicatedHostGroupResult

data class GetDedicatedHostGroupResult(val hosts: List<SubResourceReadOnlyResponse>, val id: String, val instanceView: DedicatedHostGroupInstanceViewResponse, val location: String, val name: String, val platformFaultDomainCount: Int, val supportAutomaticPlacement: Boolean? = null, val tags: Map<String, String>? = null, val type: String, val zones: List<String>? = null)

Specifies information about the dedicated host group that the dedicated hosts should be assigned to.

Currently, a dedicated host can only be added to a dedicated host group at creation time. An existing dedicated host cannot be added to another dedicated host group.

GetDedicatedHostResult

data class GetDedicatedHostResult(val autoReplaceOnFailure: Boolean? = null, val hostId: String, val id: String, val instanceView: DedicatedHostInstanceViewResponse, val licenseType: String? = null, val location: String, val name: String, val platformFaultDomain: Int? = null, val provisioningState: String, val provisioningTime: String, val sku: SkuResponse, val tags: Map<String, String>? = null, val type: String, val virtualMachines: List<SubResourceReadOnlyResponse>)

Specifies information about the Dedicated host.

GetDiskAccessAPrivateEndpointConnectionResult

data class GetDiskAccessAPrivateEndpointConnectionResult(val id: String, val name: String, val privateEndpoint: PrivateEndpointResponse, val privateLinkServiceConnectionState: PrivateLinkServiceConnectionStateResponse, val provisioningState: String, val type: String)

The Private Endpoint Connection resource.

GetDiskAccessResult

data class GetDiskAccessResult(val id: String, val location: String, val name: String, val privateEndpointConnections: List<PrivateEndpointConnectionResponse>, val provisioningState: String, val tags: Map<String, String>? = null, val timeCreated: String, val type: String)

disk access resource.

GetDiskEncryptionSetResult

data class GetDiskEncryptionSetResult(val activeKey: KeyForDiskEncryptionSetResponse? = null, val encryptionType: String? = null, val id: String, val identity: EncryptionSetIdentityResponse? = null, val lastKeyRotationTimestamp: String, val location: String, val name: String, val previousKeys: List<KeyForDiskEncryptionSetResponse>, val provisioningState: String, val rotationToLatestKeyVersionEnabled: Boolean? = null, val tags: Map<String, String>? = null, val type: String)

disk encryption set resource.

GetDiskResult

data class GetDiskResult(val burstingEnabled: Boolean? = null, val creationData: CreationDataResponse, val diskAccessId: String? = null, val diskIOPSReadOnly: Double? = null, val diskIOPSReadWrite: Double? = null, val diskMBpsReadOnly: Double? = null, val diskMBpsReadWrite: Double? = null, val diskSizeBytes: Double, val diskSizeGB: Int? = null, val diskState: String, val encryption: EncryptionResponse? = null, val encryptionSettingsCollection: EncryptionSettingsCollectionResponse? = null, val extendedLocation: ExtendedLocationResponse? = null, val hyperVGeneration: String? = null, val id: String, val location: String, val managedBy: String, val managedByExtended: List<String>, val maxShares: Int? = null, val name: String, val networkAccessPolicy: String? = null, val osType: String? = null, val propertyUpdatesInProgress: PropertyUpdatesInProgressResponse, val provisioningState: String, val purchasePlan: PurchasePlanResponse? = null, val securityProfile: DiskSecurityProfileResponse? = null, val shareInfo: List<ShareInfoElementResponse>, val sku: DiskSkuResponse? = null, val supportsHibernation: Boolean? = null, val tags: Map<String, String>? = null, val tier: String? = null, val timeCreated: String, val type: String, val uniqueId: String, val zones: List<String>? = null)

Disk resource.

GetGalleryApplicationResult

data class GetGalleryApplicationResult(val description: String? = null, val endOfLifeDate: String? = null, val eula: String? = null, val id: String, val location: String, val name: String, val privacyStatementUri: String? = null, val releaseNoteUri: String? = null, val supportedOSType: String, val tags: Map<String, String>? = null, val type: String)

Specifies information about the gallery Application Definition that you want to create or update.

GetGalleryApplicationVersionResult

data class GetGalleryApplicationVersionResult(val id: String, val location: String, val name: String, val provisioningState: String, val publishingProfile: GalleryApplicationVersionPublishingProfileResponse, val replicationStatus: ReplicationStatusResponse, val tags: Map<String, String>? = null, val type: String)

Specifies information about the gallery Application Version that you want to create or update.

GetGalleryImageResult

data class GetGalleryImageResult(val description: String? = null, val disallowed: DisallowedResponse? = null, val endOfLifeDate: String? = null, val eula: String? = null, val features: List<GalleryImageFeatureResponse>? = null, val hyperVGeneration: String? = null, val id: String, val identifier: GalleryImageIdentifierResponse, val location: String, val name: String, val osState: String, val osType: String, val privacyStatementUri: String? = null, val provisioningState: String, val purchasePlan: ImagePurchasePlanResponse? = null, val recommended: RecommendedMachineConfigurationResponse? = null, val releaseNoteUri: String? = null, val tags: Map<String, String>? = null, val type: String)

Specifies information about the gallery image definition that you want to create or update.

GetGalleryImageVersionResult

data class GetGalleryImageVersionResult(val id: String, val location: String, val name: String, val provisioningState: String, val publishingProfile: GalleryImageVersionPublishingProfileResponse? = null, val replicationStatus: ReplicationStatusResponse, val storageProfile: GalleryImageVersionStorageProfileResponse, val tags: Map<String, String>? = null, val type: String)

Specifies information about the gallery image version that you want to create or update.

GetGalleryResult

data class GetGalleryResult(val description: String? = null, val id: String, val identifier: GalleryIdentifierResponse? = null, val location: String, val name: String, val provisioningState: String, val sharingProfile: SharingProfileResponse? = null, val tags: Map<String, String>? = null, val type: String)

Specifies information about the Shared Image Gallery that you want to create or update.

GetImageResult

data class GetImageResult(val extendedLocation: ExtendedLocationResponse? = null, val hyperVGeneration: String? = null, val id: String, val location: String, val name: String, val provisioningState: String, val sourceVirtualMachine: SubResourceResponse? = null, val storageProfile: ImageStorageProfileResponse? = null, val tags: Map<String, String>? = null, val type: String)

The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist.

GetLogAnalyticExportRequestRateByIntervalResult

data class GetLogAnalyticExportRequestRateByIntervalResult(val properties: LogAnalyticsOutputResponse)

LogAnalytics operation status response

GetLogAnalyticExportThrottledRequestsResult

data class GetLogAnalyticExportThrottledRequestsResult(val properties: LogAnalyticsOutputResponse)

LogAnalytics operation status response

GetProximityPlacementGroupResult

data class GetProximityPlacementGroupResult(val availabilitySets: List<SubResourceWithColocationStatusResponse>, val colocationStatus: InstanceViewStatusResponse? = null, val id: String, val location: String, val name: String, val proximityPlacementGroupType: String? = null, val tags: Map<String, String>? = null, val type: String, val virtualMachineScaleSets: List<SubResourceWithColocationStatusResponse>, val virtualMachines: List<SubResourceWithColocationStatusResponse>)

Specifies information about the proximity placement group.

GetRestorePointCollectionResult

data class GetRestorePointCollectionResult(val id: String, val location: String, val name: String, val provisioningState: String, val restorePointCollectionId: String, val restorePoints: List<RestorePointResponse>, val source: RestorePointCollectionSourcePropertiesResponse? = null, val tags: Map<String, String>? = null, val type: String)

Create or update Restore Point collection parameters.

GetRestorePointResult

data class GetRestorePointResult(val consistencyMode: String, val excludeDisks: List<ApiEntityReferenceResponse>? = null, val id: String, val name: String, val provisioningState: String, val sourceMetadata: RestorePointSourceMetadataResponse, val timeCreated: String? = null, val type: String)

Restore Point details.

GetSnapshotResult

data class GetSnapshotResult(val creationData: CreationDataResponse, val diskAccessId: String? = null, val diskSizeBytes: Double, val diskSizeGB: Int? = null, val diskState: String, val encryption: EncryptionResponse? = null, val encryptionSettingsCollection: EncryptionSettingsCollectionResponse? = null, val extendedLocation: ExtendedLocationResponse? = null, val hyperVGeneration: String? = null, val id: String, val incremental: Boolean? = null, val location: String, val managedBy: String, val name: String, val networkAccessPolicy: String? = null, val osType: String? = null, val provisioningState: String, val purchasePlan: PurchasePlanResponse? = null, val sku: SnapshotSkuResponse? = null, val supportsHibernation: Boolean? = null, val tags: Map<String, String>? = null, val timeCreated: String, val type: String, val uniqueId: String)

Snapshot resource.

GetSshPublicKeyResult

data class GetSshPublicKeyResult(val id: String, val location: String, val name: String, val publicKey: String? = null, val tags: Map<String, String>? = null, val type: String)

Specifies information about the SSH public key.

GetVirtualMachineExtensionResult

data class GetVirtualMachineExtensionResult(val autoUpgradeMinorVersion: Boolean? = null, val enableAutomaticUpgrade: Boolean? = null, val forceUpdateTag: String? = null, val id: String, val instanceView: VirtualMachineExtensionInstanceViewResponse? = null, val location: String, val name: String, val protectedSettings: Any? = null, val provisioningState: String, val publisher: String? = null, val settings: Any? = null, val tags: Map<String, String>? = null, val type: String, val typeHandlerVersion: String? = null)

Describes a Virtual Machine Extension.

GetVirtualMachineResult

data class GetVirtualMachineResult(val additionalCapabilities: AdditionalCapabilitiesResponse? = null, val availabilitySet: SubResourceResponse? = null, val billingProfile: BillingProfileResponse? = null, val diagnosticsProfile: DiagnosticsProfileResponse? = null, val evictionPolicy: String? = null, val extendedLocation: ExtendedLocationResponse? = null, val extensionsTimeBudget: String? = null, val hardwareProfile: HardwareProfileResponse? = null, val host: SubResourceResponse? = null, val hostGroup: SubResourceResponse? = null, val id: String, val identity: VirtualMachineIdentityResponse? = null, val instanceView: VirtualMachineInstanceViewResponse, val licenseType: String? = null, val location: String, val name: String, val networkProfile: NetworkProfileResponse? = null, val osProfile: OSProfileResponse? = null, val plan: PlanResponse? = null, val platformFaultDomain: Int? = null, val priority: String? = null, val provisioningState: String, val proximityPlacementGroup: SubResourceResponse? = null, val resources: List<VirtualMachineExtensionResponse>, val scheduledEventsProfile: ScheduledEventsProfileResponse? = null, val securityProfile: SecurityProfileResponse? = null, val storageProfile: StorageProfileResponse? = null, val tags: Map<String, String>? = null, val type: String, val userData: String? = null, val virtualMachineScaleSet: SubResourceResponse? = null, val vmId: String, val zones: List<String>? = null)

Describes a Virtual Machine.

GetVirtualMachineRunCommandByVirtualMachineResult

data class GetVirtualMachineRunCommandByVirtualMachineResult(val asyncExecution: Boolean? = null, val errorBlobUri: String? = null, val id: String, val instanceView: VirtualMachineRunCommandInstanceViewResponse, val location: String, val name: String, 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: VirtualMachineRunCommandScriptSourceResponse? = null, val tags: Map<String, String>? = null, val timeoutInSeconds: Int? = null, val type: String)

Describes a Virtual Machine run command.

GetVirtualMachineScaleSetExtensionResult

data class GetVirtualMachineScaleSetExtensionResult(val autoUpgradeMinorVersion: Boolean? = null, val enableAutomaticUpgrade: Boolean? = null, val forceUpdateTag: String? = null, val id: String, val name: String? = null, val protectedSettings: Any? = null, val provisionAfterExtensions: List<String>? = null, val provisioningState: String, val publisher: String? = null, val settings: Any? = null, val type: String, val typeHandlerVersion: String? = null)

Describes a Virtual Machine Scale Set Extension.

GetVirtualMachineScaleSetResult

data class GetVirtualMachineScaleSetResult(val additionalCapabilities: AdditionalCapabilitiesResponse? = null, val automaticRepairsPolicy: AutomaticRepairsPolicyResponse? = null, val doNotRunExtensionsOnOverprovisionedVMs: Boolean? = null, val extendedLocation: ExtendedLocationResponse? = null, val hostGroup: SubResourceResponse? = null, val id: String, val identity: VirtualMachineScaleSetIdentityResponse? = null, val location: String, val name: String, val orchestrationMode: String? = null, val overprovision: Boolean? = null, val plan: PlanResponse? = null, val platformFaultDomainCount: Int? = null, val provisioningState: String, val proximityPlacementGroup: SubResourceResponse? = null, val scaleInPolicy: ScaleInPolicyResponse? = null, val singlePlacementGroup: Boolean? = null, val sku: SkuResponse? = null, val tags: Map<String, String>? = null, val type: String, val uniqueId: String, val upgradePolicy: UpgradePolicyResponse? = null, val virtualMachineProfile: VirtualMachineScaleSetVMProfileResponse? = null, val zoneBalance: Boolean? = null, val zones: List<String>? = null)

Describes a Virtual Machine Scale Set.

GetVirtualMachineScaleSetVMExtensionResult

data class GetVirtualMachineScaleSetVMExtensionResult(val autoUpgradeMinorVersion: Boolean? = null, val enableAutomaticUpgrade: Boolean? = null, val forceUpdateTag: String? = null, val id: String, val instanceView: VirtualMachineExtensionInstanceViewResponse? = null, val name: String, val protectedSettings: Any? = null, val provisioningState: String, val publisher: String? = null, val settings: Any? = null, val type: String, val typeHandlerVersion: String? = null)

Describes a VMSS VM Extension.

GetVirtualMachineScaleSetVMResult

data class GetVirtualMachineScaleSetVMResult(val additionalCapabilities: AdditionalCapabilitiesResponse? = null, val availabilitySet: SubResourceResponse? = null, val diagnosticsProfile: DiagnosticsProfileResponse? = null, val hardwareProfile: HardwareProfileResponse? = null, val id: String, val instanceId: String, val instanceView: VirtualMachineScaleSetVMInstanceViewResponse, val latestModelApplied: Boolean, val licenseType: String? = null, val location: String, val modelDefinitionApplied: String, val name: String, val networkProfile: NetworkProfileResponse? = null, val networkProfileConfiguration: VirtualMachineScaleSetVMNetworkProfileConfigurationResponse? = null, val osProfile: OSProfileResponse? = null, val plan: PlanResponse? = null, val protectionPolicy: VirtualMachineScaleSetVMProtectionPolicyResponse? = null, val provisioningState: String, val resources: List<VirtualMachineExtensionResponse>, val securityProfile: SecurityProfileResponse? = null, val sku: SkuResponse, val storageProfile: StorageProfileResponse? = null, val tags: Map<String, String>? = null, val type: String, val userData: String? = null, val vmId: String, val zones: List<String>)

Describes a virtual machine scale set virtual machine.

GetVirtualMachineScaleSetVMRunCommandResult

data class GetVirtualMachineScaleSetVMRunCommandResult(val asyncExecution: Boolean? = null, val errorBlobUri: String? = null, val id: String, val instanceView: VirtualMachineRunCommandInstanceViewResponse, val location: String, val name: String, 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: VirtualMachineRunCommandScriptSourceResponse? = null, val tags: Map<String, String>? = null, val timeoutInSeconds: Int? = null, val type: String)

Describes a Virtual Machine run command.

HardwareProfileResponse

data class HardwareProfileResponse(val vmSize: String? = null)

Specifies the hardware settings for the virtual machine.

ImageDataDiskResponse

data class ImageDataDiskResponse(val blobUri: String? = null, val caching: String? = null, val diskEncryptionSet: DiskEncryptionSetParametersResponse? = null, val diskSizeGB: Int? = null, val lun: Int, val managedDisk: SubResourceResponse? = null, val snapshot: SubResourceResponse? = null, val storageAccountType: String? = null)

Describes a data disk.

ImageDiskReferenceResponse

data class ImageDiskReferenceResponse(val id: String, val lun: Int? = null)

The source image used for creating the disk.

ImageOSDiskResponse

data class ImageOSDiskResponse(val blobUri: String? = null, val caching: String? = null, val diskEncryptionSet: DiskEncryptionSetParametersResponse? = null, val diskSizeGB: Int? = null, val managedDisk: SubResourceResponse? = null, val osState: String, val osType: String, val snapshot: SubResourceResponse? = null, val storageAccountType: String? = null)

Describes an Operating System disk.

ImagePurchasePlanResponse

data class ImagePurchasePlanResponse(val name: String? = null, val product: String? = null, val publisher: String? = null)

Describes the gallery image definition purchase plan. This is used by marketplace images.

ImageReferenceResponse

data class ImageReferenceResponse(val exactVersion: String, val id: String? = null, val offer: String? = null, val publisher: 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.

ImageStorageProfileResponse

data class ImageStorageProfileResponse(val dataDisks: List<ImageDataDiskResponse>? = null, val osDisk: ImageOSDiskResponse? = null, val zoneResilient: Boolean? = null)

Describes a storage profile.

InnerErrorResponse

data class InnerErrorResponse(val errordetail: String? = null, val exceptiontype: String? = null)

Inner error details.

InstanceViewStatusResponse

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

Instance view status.

KeyForDiskEncryptionSetResponse

data class KeyForDiskEncryptionSetResponse(val keyUrl: String, val sourceVault: SourceVaultResponse? = null)

Key Vault Key Url to be used for server side encryption of Managed Disks and Snapshots

KeyVaultAndKeyReferenceResponse

data class KeyVaultAndKeyReferenceResponse(val keyUrl: String, val sourceVault: SourceVaultResponse)

Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey

KeyVaultAndSecretReferenceResponse

data class KeyVaultAndSecretReferenceResponse(val secretUrl: String, val sourceVault: SourceVaultResponse)

Key Vault Secret Url and vault id of the encryption key

KeyVaultKeyReferenceResponse

data class KeyVaultKeyReferenceResponse(val keyUrl: String, val sourceVault: SubResourceResponse)

Describes a reference to Key Vault Key

KeyVaultSecretReferenceResponse

data class KeyVaultSecretReferenceResponse(val secretUrl: String, val sourceVault: SubResourceResponse)

Describes a reference to Key Vault Secret

LastPatchInstallationSummaryResponse

data class LastPatchInstallationSummaryResponse(val error: ApiErrorResponse, val excludedPatchCount: Int, val failedPatchCount: Int, val installationActivityId: String, val installedPatchCount: Int, val lastModifiedTime: String, val maintenanceWindowExceeded: Boolean, val notSelectedPatchCount: Int, val pendingPatchCount: Int, val startTime: String, val status: String)

Describes the properties of the last installed patch summary.

LinuxConfigurationResponse

data class LinuxConfigurationResponse(val disablePasswordAuthentication: 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 Distributions.

LinuxPatchSettingsResponse

data class LinuxPatchSettingsResponse(val assessmentMode: String? = null, val patchMode: String? = null)

Specifies settings related to VM Guest Patching on Linux.

LoadBalancerConfigurationPropertiesResponse

data class LoadBalancerConfigurationPropertiesResponse(val frontendIPConfigurations: List<LoadBalancerFrontendIPConfigurationResponse>)

LoadBalancerConfigurationResponse

data class LoadBalancerConfigurationResponse(val id: String? = null, val name: String, val properties: LoadBalancerConfigurationPropertiesResponse)

Describes the load balancer configuration.

LoadBalancerFrontendIPConfigurationPropertiesResponse

data class LoadBalancerFrontendIPConfigurationPropertiesResponse(val privateIPAddress: String? = null, val publicIPAddress: SubResourceResponse? = null, val subnet: SubResourceResponse? = null)

Describes a cloud service IP Configuration

LoadBalancerFrontendIPConfigurationResponse

data class LoadBalancerFrontendIPConfigurationResponse(val name: String, val properties: LoadBalancerFrontendIPConfigurationPropertiesResponse)

LogAnalyticsOutputResponse

data class LogAnalyticsOutputResponse(val output: String)

LogAnalytics output properties

MaintenanceRedeployStatusResponse

data class MaintenanceRedeployStatusResponse(val isCustomerInitiatedMaintenanceAllowed: Boolean? = null, val lastOperationMessage: String? = null, val lastOperationResultCode: String? = null, val maintenanceWindowEndTime: String? = null, val maintenanceWindowStartTime: String? = null, val preMaintenanceWindowEndTime: String? = null, val preMaintenanceWindowStartTime: String? = null)

Maintenance Operation Status.

ManagedDiskParametersResponse

data class ManagedDiskParametersResponse(val diskEncryptionSet: DiskEncryptionSetParametersResponse? = null, val id: String? = null, val storageAccountType: String? = null)

The parameters of a managed disk.

NetworkInterfaceReferenceResponse

data class NetworkInterfaceReferenceResponse(val deleteOption: String? = null, val id: String? = null, val primary: Boolean? = null)

Describes a network interface reference.

NetworkProfileResponse

data class NetworkProfileResponse(val networkApiVersion: String? = null, val networkInterfaceConfigurations: List<VirtualMachineNetworkInterfaceConfigurationResponse>? = null, val networkInterfaces: List<NetworkInterfaceReferenceResponse>? = null)

Specifies the network interfaces or the networking configuration of the virtual machine.

OSDiskImageEncryptionResponse

data class OSDiskImageEncryptionResponse(val diskEncryptionSetId: String? = null)

Contains encryption settings for an OS disk image.

OSDiskResponse

data class OSDiskResponse(val caching: String? = null, val createOption: String, val deleteOption: String? = null, val diffDiskSettings: DiffDiskSettingsResponse? = null, val diskSizeGB: Int? = null, val encryptionSettings: DiskEncryptionSettingsResponse? = null, val image: VirtualHardDiskResponse? = null, val managedDisk: ManagedDiskParametersResponse? = null, val name: String? = null, val osType: String? = null, val vhd: VirtualHardDiskResponse? = null, val writeAcceleratorEnabled: Boolean? = null)

Specifies information about the operating system disk used by the virtual machine.

For more information about disks, see About disks and VHDs for Azure virtual machines.

OSProfileResponse

data class OSProfileResponse(val adminPassword: String? = null, val adminUsername: String? = null, val allowExtensionOperations: Boolean? = null, val computerName: String? = null, val customData: String? = null, val linuxConfiguration: LinuxConfigurationResponse? = null, val requireGuestProvisionSignal: Boolean? = null, val secrets: List<VaultSecretGroupResponse>? = null, val windowsConfiguration: WindowsConfigurationResponse? = null)

Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned.

PatchSettingsResponse

data class PatchSettingsResponse(val assessmentMode: String? = null, val enableHotpatching: Boolean? = null, val patchMode: String? = null)

Specifies settings related to VM Guest Patching on Windows.

PlanResponse

data class PlanResponse(val name: String? = null, val product: String? = null, val promotionCode: String? = null, val publisher: String? = null)

Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click Want to deploy programmatically, Get Started ->. Enter any required information and then click Save.

PrivateEndpointConnectionResponse

data class PrivateEndpointConnectionResponse(val id: String, val name: String, val privateEndpoint: PrivateEndpointResponse, val privateLinkServiceConnectionState: PrivateLinkServiceConnectionStateResponse, val provisioningState: String, val type: String)

The Private Endpoint Connection resource.

PrivateEndpointResponse

data class PrivateEndpointResponse(val id: String)

The Private Endpoint resource.

PrivateLinkServiceConnectionStateResponse

data class PrivateLinkServiceConnectionStateResponse(val actionsRequired: String? = null, val description: String? = null, val status: String? = null)

A collection of information about the state of the connection between service consumer and provider.

PropertyUpdatesInProgressResponse

data class PropertyUpdatesInProgressResponse(val targetTier: String? = null)

Properties of the disk for which update is pending.

PublicIPAddressSkuResponse

data class PublicIPAddressSkuResponse(val name: String? = null, val tier: String? = null)

Describes the public IP Sku

PurchasePlanResponse

data class PurchasePlanResponse(val name: String, val product: String, val promotionCode: String? = null, val publisher: String)

Used for establishing the purchase context of any 3rd Party artifact through MarketPlace.

RecommendedMachineConfigurationResponse

data class RecommendedMachineConfigurationResponse(val memory: ResourceRangeResponse? = null, val vCPUs: ResourceRangeResponse? = null)

The properties describe the recommended machine configuration for this Image Definition. These properties are updatable.

RegionalReplicationStatusResponse

data class RegionalReplicationStatusResponse(val details: String, val progress: Int, val region: String, val state: String)

This is the regional replication status.

ReplicationStatusResponse

data class ReplicationStatusResponse(val aggregatedState: String, val summary: List<RegionalReplicationStatusResponse>)

This is the replication status of the gallery image version.

ResourceRangeResponse

data class ResourceRangeResponse(val max: Int? = null, val min: Int? = null)

Describes the resource range.

RestorePointCollectionSourcePropertiesResponse

data class RestorePointCollectionSourcePropertiesResponse(val id: String? = null, val location: String)

The properties of the source resource that this restore point collection is created from.

RestorePointResponse

data class RestorePointResponse(val consistencyMode: String, val excludeDisks: List<ApiEntityReferenceResponse>? = null, val id: String, val name: String, val provisioningState: String, val sourceMetadata: RestorePointSourceMetadataResponse, val timeCreated: String? = null, val type: String)

Restore Point details.

RestorePointSourceMetadataResponse

data class RestorePointSourceMetadataResponse(val diagnosticsProfile: DiagnosticsProfileResponse? = null, val hardwareProfile: HardwareProfileResponse? = null, val licenseType: String? = null, val location: String? = null, val osProfile: OSProfileResponse? = null, val securityProfile: SecurityProfileResponse? = null, val storageProfile: RestorePointSourceVMStorageProfileResponse? = null, val vmId: String? = null)

Describes the properties of the Virtual Machine for which the restore point was created. The properties provided are a subset and the snapshot of the overall Virtual Machine properties captured at the time of the restore point creation.

RestorePointSourceVMDataDiskResponse

data class RestorePointSourceVMDataDiskResponse(val caching: String? = null, val diskRestorePoint: ApiEntityReferenceResponse? = null, val diskSizeGB: Int? = null, val lun: Int? = null, val managedDisk: ManagedDiskParametersResponse? = null, val name: String? = null)

Describes a data disk.

RestorePointSourceVMOSDiskResponse

data class RestorePointSourceVMOSDiskResponse(val caching: String? = null, val diskRestorePoint: ApiEntityReferenceResponse? = null, val diskSizeGB: Int? = null, val encryptionSettings: DiskEncryptionSettingsResponse? = null, val managedDisk: ManagedDiskParametersResponse? = null, val name: String? = null, val osType: String? = null)

Describes an Operating System disk.

RestorePointSourceVMStorageProfileResponse

data class RestorePointSourceVMStorageProfileResponse(val dataDisks: List<RestorePointSourceVMDataDiskResponse>? = null, val osDisk: RestorePointSourceVMOSDiskResponse? = null)

Describes the storage profile.

RollingUpgradePolicyResponse

data class RollingUpgradePolicyResponse(val enableCrossZoneUpgrade: Boolean? = null, val maxBatchInstancePercent: Int? = null, val maxUnhealthyInstancePercent: Int? = null, val maxUnhealthyUpgradedInstancePercent: Int? = null, val pauseTimeBetweenBatches: String? = null, val prioritizeUnhealthyInstances: Boolean? = null)

The configuration parameters used while performing a rolling upgrade.

RunCommandInputParameterResponse

data class RunCommandInputParameterResponse(val name: String, val value: String)

Describes the properties of a run command parameter.

ScaleInPolicyResponse

data class ScaleInPolicyResponse(val rules: List<String>? = null)

Describes a scale-in policy for a virtual machine scale set.

ScheduledEventsProfileResponse

data class ScheduledEventsProfileResponse(val terminateNotificationProfile: TerminateNotificationProfileResponse? = null)

SecurityProfileResponse

data class SecurityProfileResponse(val encryptionAtHost: Boolean? = null, val securityType: String? = null, val uefiSettings: UefiSettingsResponse? = null)

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

ShareInfoElementResponse

data class ShareInfoElementResponse(val vmUri: String)

SharingProfileGroupResponse

data class SharingProfileGroupResponse(val ids: List<String>? = null, val type: String? = null)

Group of the gallery sharing profile

SharingProfileResponse

data class SharingProfileResponse(val groups: List<SharingProfileGroupResponse>, val permissions: String? = null)

Profile for gallery sharing to subscription or tenant

SkuResponse

data class SkuResponse(val capacity: Double? = null, val name: String? = null, val tier: String? = null)

Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name.

SnapshotSkuResponse

data class SnapshotSkuResponse(val name: String? = null, val tier: String)

The snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS. This is an optional parameter for incremental snapshot and the default behavior is the SKU will be set to the same sku as the previous snapshot

SourceVaultResponse

data class SourceVaultResponse(val id: String? = null)

The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}

SshConfigurationResponse

data class SshConfigurationResponse(val publicKeys: List<SshPublicKeyResponse>? = null)

SSH configuration for Linux based VMs running on Azure

SshPublicKeyResponse

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.

StorageProfileResponse

data class StorageProfileResponse(val dataDisks: List<DataDiskResponse>? = null, val imageReference: ImageReferenceResponse? = null, val osDisk: OSDiskResponse? = null)

Specifies the storage settings for the virtual machine disks.

SubResourceReadOnlyResponse

data class SubResourceReadOnlyResponse(val id: String)

SubResourceResponse

data class SubResourceResponse(val id: String? = null)

SubResourceWithColocationStatusResponse

data class SubResourceWithColocationStatusResponse(val colocationStatus: InstanceViewStatusResponse? = null, val id: String? = null)

TargetRegionResponse

data class TargetRegionResponse(val encryption: EncryptionImagesResponse? = null, val name: String, val regionalReplicaCount: Int? = null, val storageAccountType: String? = null)

Describes the target region information.

TerminateNotificationProfileResponse

data class TerminateNotificationProfileResponse(val enable: Boolean? = null, val notBeforeTimeout: String? = null)

UefiSettingsResponse

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

UpgradePolicyResponse

data class UpgradePolicyResponse(val automaticOSUpgradePolicy: AutomaticOSUpgradePolicyResponse? = null, val mode: String? = null, val rollingUpgradePolicy: RollingUpgradePolicyResponse? = null)

Describes an upgrade policy - automatic, manual, or rolling.

UserArtifactManageResponse

data class UserArtifactManageResponse(val install: String, val remove: String, val update: String? = null)

UserArtifactSourceResponse

data class UserArtifactSourceResponse(val defaultConfigurationLink: String? = null, val mediaLink: String)

The source image from which the Image Version is going to be created.

VaultCertificateResponse

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.

VaultSecretGroupResponse

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.

VirtualHardDiskResponse

data class VirtualHardDiskResponse(val uri: String? = null)

Describes the uri of a disk.

VirtualMachineAgentInstanceViewResponse

data class VirtualMachineAgentInstanceViewResponse(val extensionHandlers: List<VirtualMachineExtensionHandlerInstanceViewResponse>? = null, val statuses: List<InstanceViewStatusResponse>? = null, val vmAgentVersion: String? = null)

The instance view of the VM Agent running on the virtual machine.

VirtualMachineExtensionHandlerInstanceViewResponse

data class VirtualMachineExtensionHandlerInstanceViewResponse(val status: InstanceViewStatusResponse? = null, val type: String? = null, val typeHandlerVersion: String? = null)

The instance view of a virtual machine extension handler.

VirtualMachineExtensionInstanceViewResponse

data class VirtualMachineExtensionInstanceViewResponse(val name: String? = null, val statuses: List<InstanceViewStatusResponse>? = null, val substatuses: List<InstanceViewStatusResponse>? = null, val type: String? = null, val typeHandlerVersion: String? = null)

The instance view of a virtual machine extension.

VirtualMachineExtensionResponse

data class VirtualMachineExtensionResponse(val autoUpgradeMinorVersion: Boolean? = null, val enableAutomaticUpgrade: Boolean? = null, val forceUpdateTag: String? = null, val id: String, val instanceView: VirtualMachineExtensionInstanceViewResponse? = null, val location: String, val name: String, val protectedSettings: Any? = null, val provisioningState: String, val publisher: String? = null, val settings: Any? = null, val tags: Map<String, String>? = null, val type: String, val typeHandlerVersion: String? = null)

Describes a Virtual Machine Extension.

VirtualMachineHealthStatusResponse

data class VirtualMachineHealthStatusResponse(val status: InstanceViewStatusResponse)

The health status of the VM.

VirtualMachineIdentityResponse

data class VirtualMachineIdentityResponse(val principalId: String, val tenantId: String, val type: String? = null, val userAssignedIdentities: Map<String, VirtualMachineIdentityResponseUserAssignedIdentities>? = null)

Identity for the virtual machine.

VirtualMachineIdentityResponseUserAssignedIdentities

data class VirtualMachineIdentityResponseUserAssignedIdentities(val clientId: String, val principalId: String)

VirtualMachineInstanceViewResponse

data class VirtualMachineInstanceViewResponse(val assignedHost: String, val bootDiagnostics: BootDiagnosticsInstanceViewResponse? = null, val computerName: String? = null, val disks: List<DiskInstanceViewResponse>? = null, val extensions: List<VirtualMachineExtensionInstanceViewResponse>? = null, val hyperVGeneration: String? = null, val maintenanceRedeployStatus: MaintenanceRedeployStatusResponse? = null, val osName: String? = null, val osVersion: String? = null, val patchStatus: VirtualMachinePatchStatusResponse? = null, val platformFaultDomain: Int? = null, val platformUpdateDomain: Int? = null, val rdpThumbPrint: String? = null, val statuses: List<InstanceViewStatusResponse>? = null, val vmAgent: VirtualMachineAgentInstanceViewResponse? = null, val vmHealth: VirtualMachineHealthStatusResponse)

The instance view of a virtual machine.

VirtualMachineIpTagResponse

data class VirtualMachineIpTagResponse(val ipTagType: String? = null, val tag: String? = null)

Contains the IP tag associated with the public IP address.

VirtualMachineNetworkInterfaceConfigurationResponse

data class VirtualMachineNetworkInterfaceConfigurationResponse(val deleteOption: String? = null, val dnsSettings: VirtualMachineNetworkInterfaceDnsSettingsConfigurationResponse? = null, val dscpConfiguration: SubResourceResponse? = null, val enableAcceleratedNetworking: Boolean? = null, val enableFpga: Boolean? = null, val enableIPForwarding: Boolean? = null, val ipConfigurations: List<VirtualMachineNetworkInterfaceIPConfigurationResponse>, val name: String, val networkSecurityGroup: SubResourceResponse? = null, val primary: Boolean? = null)

Describes a virtual machine network interface configurations.

VirtualMachineNetworkInterfaceDnsSettingsConfigurationResponse

data class VirtualMachineNetworkInterfaceDnsSettingsConfigurationResponse(val dnsServers: List<String>? = null)

Describes a virtual machines network configuration's DNS settings.

VirtualMachineNetworkInterfaceIPConfigurationResponse

data class VirtualMachineNetworkInterfaceIPConfigurationResponse(val applicationGatewayBackendAddressPools: List<SubResourceResponse>? = null, val applicationSecurityGroups: List<SubResourceResponse>? = null, val loadBalancerBackendAddressPools: List<SubResourceResponse>? = null, val name: String, val primary: Boolean? = null, val privateIPAddressVersion: String? = null, val publicIPAddressConfiguration: VirtualMachinePublicIPAddressConfigurationResponse? = null, val subnet: SubResourceResponse? = null)

Describes a virtual machine network profile's IP configuration.

VirtualMachinePatchStatusResponse

data class VirtualMachinePatchStatusResponse(val availablePatchSummary: AvailablePatchSummaryResponse? = null, val configurationStatuses: List<InstanceViewStatusResponse>, val lastPatchInstallationSummary: LastPatchInstallationSummaryResponse? = null)

The status of virtual machine patch operations.

VirtualMachinePublicIPAddressConfigurationResponse

data class VirtualMachinePublicIPAddressConfigurationResponse(val deleteOption: String? = null, val dnsSettings: VirtualMachinePublicIPAddressDnsSettingsConfigurationResponse? = null, val idleTimeoutInMinutes: Int? = null, val ipTags: List<VirtualMachineIpTagResponse>? = null, val name: String, val publicIPAddressVersion: String? = null, val publicIPAllocationMethod: String? = null, val publicIPPrefix: SubResourceResponse? = null, val sku: PublicIPAddressSkuResponse? = null)

Describes a virtual machines IP Configuration's PublicIPAddress configuration

VirtualMachinePublicIPAddressDnsSettingsConfigurationResponse

data class VirtualMachinePublicIPAddressDnsSettingsConfigurationResponse(val domainNameLabel: String)

Describes a virtual machines network configuration's DNS settings.

VirtualMachineRunCommandInstanceViewResponse

data class VirtualMachineRunCommandInstanceViewResponse(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<InstanceViewStatusResponse>? = null)

The instance view of a virtual machine run command.

VirtualMachineRunCommandScriptSourceResponse

data class VirtualMachineRunCommandScriptSourceResponse(val commandId: String? = null, val script: String? = null, val scriptUri: String? = null)

Describes the script sources for run command.

VirtualMachineScaleSetDataDiskResponse

data class VirtualMachineScaleSetDataDiskResponse(val caching: String? = null, val createOption: String, 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.

VirtualMachineScaleSetExtensionProfileResponse

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

Describes a virtual machine scale set extension profile.

VirtualMachineScaleSetExtensionResponse

data class VirtualMachineScaleSetExtensionResponse(val autoUpgradeMinorVersion: Boolean? = null, val enableAutomaticUpgrade: Boolean? = null, val forceUpdateTag: String? = null, val id: String, val name: String? = null, val protectedSettings: Any? = null, val provisionAfterExtensions: List<String>? = null, val provisioningState: String, val publisher: String? = null, val settings: Any? = null, val type: String, val typeHandlerVersion: String? = null)

Describes a Virtual Machine Scale Set Extension.

VirtualMachineScaleSetIdentityResponse

data class VirtualMachineScaleSetIdentityResponse(val principalId: String, val tenantId: String, val type: String? = null, val userAssignedIdentities: Map<String, VirtualMachineScaleSetIdentityResponseUserAssignedIdentities>? = null)

Identity for the virtual machine scale set.

VirtualMachineScaleSetIdentityResponseUserAssignedIdentities

data class VirtualMachineScaleSetIdentityResponseUserAssignedIdentities(val clientId: String, val principalId: String)

VirtualMachineScaleSetIPConfigurationResponse

data class VirtualMachineScaleSetIPConfigurationResponse(val applicationGatewayBackendAddressPools: List<SubResourceResponse>? = null, val applicationSecurityGroups: List<SubResourceResponse>? = null, val id: String? = null, val loadBalancerBackendAddressPools: List<SubResourceResponse>? = null, val loadBalancerInboundNatPools: List<SubResourceResponse>? = null, val name: String, 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.

VirtualMachineScaleSetIpTagResponse

data class VirtualMachineScaleSetIpTagResponse(val ipTagType: String? = null, val tag: String? = null)

Contains the IP tag associated with the public IP address.

VirtualMachineScaleSetManagedDiskParametersResponse

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

Describes the parameters of a ScaleSet managed disk.

VirtualMachineScaleSetNetworkConfigurationDnsSettingsResponse

data class VirtualMachineScaleSetNetworkConfigurationDnsSettingsResponse(val dnsServers: List<String>? = null)

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

VirtualMachineScaleSetNetworkConfigurationResponse

data class VirtualMachineScaleSetNetworkConfigurationResponse(val deleteOption: String? = null, val dnsSettings: VirtualMachineScaleSetNetworkConfigurationDnsSettingsResponse? = null, val enableAcceleratedNetworking: Boolean? = null, val enableFpga: Boolean? = null, val enableIPForwarding: Boolean? = null, val id: String? = null, val ipConfigurations: List<VirtualMachineScaleSetIPConfigurationResponse>, val name: String, val networkSecurityGroup: SubResourceResponse? = null, val primary: Boolean? = null)

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

VirtualMachineScaleSetNetworkProfileResponse

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

Describes a virtual machine scale set network profile.

VirtualMachineScaleSetOSDiskResponse

data class VirtualMachineScaleSetOSDiskResponse(val caching: String? = null, val createOption: String, 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.

VirtualMachineScaleSetOSProfileResponse

data class VirtualMachineScaleSetOSProfileResponse(val adminPassword: String? = null, val adminUsername: String? = null, val computerNamePrefix: String? = null, val customData: String? = null, val linuxConfiguration: LinuxConfigurationResponse? = null, val secrets: List<VaultSecretGroupResponse>? = null, val windowsConfiguration: WindowsConfigurationResponse? = null)

Describes a virtual machine scale set OS profile.

VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettingsResponse

data class VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettingsResponse(val domainNameLabel: String)

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

VirtualMachineScaleSetPublicIPAddressConfigurationResponse

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

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

VirtualMachineScaleSetStorageProfileResponse

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

Describes a virtual machine scale set storage profile.

VirtualMachineScaleSetVMInstanceViewResponse

data class VirtualMachineScaleSetVMInstanceViewResponse(val assignedHost: String, val bootDiagnostics: BootDiagnosticsInstanceViewResponse? = null, val disks: List<DiskInstanceViewResponse>? = null, val extensions: List<VirtualMachineExtensionInstanceViewResponse>? = null, val maintenanceRedeployStatus: MaintenanceRedeployStatusResponse? = null, val placementGroupId: String? = null, val platformFaultDomain: Int? = null, val platformUpdateDomain: Int? = null, val rdpThumbPrint: String? = null, val statuses: List<InstanceViewStatusResponse>? = null, val vmAgent: VirtualMachineAgentInstanceViewResponse? = null, val vmHealth: VirtualMachineHealthStatusResponse)

The instance view of a virtual machine scale set VM.

VirtualMachineScaleSetVMNetworkProfileConfigurationResponse

data class VirtualMachineScaleSetVMNetworkProfileConfigurationResponse(val networkInterfaceConfigurations: List<VirtualMachineScaleSetNetworkConfigurationResponse>? = null)

Describes a virtual machine scale set VM network profile.

VirtualMachineScaleSetVMProfileResponse

data class VirtualMachineScaleSetVMProfileResponse(val billingProfile: BillingProfileResponse? = null, val diagnosticsProfile: DiagnosticsProfileResponse? = null, val evictionPolicy: String? = null, val extensionProfile: VirtualMachineScaleSetExtensionProfileResponse? = null, val licenseType: String? = null, val networkProfile: VirtualMachineScaleSetNetworkProfileResponse? = null, val osProfile: VirtualMachineScaleSetOSProfileResponse? = null, val priority: String? = null, val scheduledEventsProfile: ScheduledEventsProfileResponse? = null, val securityProfile: SecurityProfileResponse? = null, val storageProfile: VirtualMachineScaleSetStorageProfileResponse? = null, val userData: String? = null)

Describes a virtual machine scale set virtual machine profile.

VirtualMachineScaleSetVMProtectionPolicyResponse

data class VirtualMachineScaleSetVMProtectionPolicyResponse(val protectFromScaleIn: Boolean? = null, val protectFromScaleSetActions: Boolean? = null)

The protection policy of a virtual machine scale set VM.

WindowsConfigurationResponse

data class WindowsConfigurationResponse(val additionalUnattendContent: List<AdditionalUnattendContentResponse>? = null, val enableAutomaticUpdates: 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.

WinRMConfigurationResponse

data class WinRMConfigurationResponse(val listeners: List<WinRMListenerResponse>? = null)

Describes Windows Remote Management configuration of the VM

WinRMListenerResponse

data class WinRMListenerResponse(val certificateUrl: String? = null, val protocol: String? = null)

Describes Protocol and thumbprint of Windows Remote Management listener