Package-level declarations

Types

Link copied to clipboard
data class AccessControlRulesIdentityResponse(val exePath: String? = null, val groupName: String? = null, val name: String, val processName: String? = null, val userName: String? = null)

The properties of an Access Control Rule Identity.

Link copied to clipboard
data class AccessControlRulesPrivilegeResponse(val name: String, val path: String, val queryParameters: Map<String, String>? = null)

The properties of an Access Control Rule Privilege.

Link copied to clipboard
data class AccessControlRulesResponse(val identities: List<AccessControlRulesIdentityResponse>? = null, val privileges: List<AccessControlRulesPrivilegeResponse>? = null, val roleAssignments: List<AccessControlRulesRoleAssignmentResponse>? = null, val roles: List<AccessControlRulesRoleResponse>? = null)

This is the Access Control Rules specification for an inVMAccessControlProfile version.

Link copied to clipboard
data class AccessControlRulesRoleAssignmentResponse(val identities: List<String>, val role: String)

The properties of an Access Control Rule RoleAssignment.

Link copied to clipboard
data class AccessControlRulesRoleResponse(val name: String, val privileges: List<String>)

The properties of an Access Control Rule Role.

Link copied to clipboard
data class AdditionalCapabilitiesResponse(val hibernationEnabled: Boolean? = null, val ultraSSDEnabled: Boolean? = null)

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

Link copied to clipboard
data class AdditionalReplicaSetResponse(val regionalReplicaCount: Int? = null, val storageAccountType: String? = null)

Describes the additional replica set information.

Link copied to clipboard
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.

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

The API entity reference.

Link copied to clipboard
data class ApiErrorBaseResponse(val code: String? = null, val message: String? = null, val target: String? = null)

Api error base.

Link copied to clipboard
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.

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 AutomaticOSUpgradePolicyResponse(val disableAutomaticRollback: Boolean? = null, val enableAutomaticOSUpgrade: Boolean? = null, val osRollingUpgradeDeferral: Boolean? = null, val useRollingUpgradePolicy: Boolean? = null)

The configuration parameters used for performing automatic OS upgrade.

Link copied to clipboard
data class AutomaticRepairsPolicyResponse(val enabled: Boolean? = null, val gracePeriod: String? = null, val repairAction: String? = null)

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

Link copied to clipboard
data class AutomaticZoneRebalancingPolicyResponse(val enabled: Boolean? = null, val rebalanceBehavior: String? = null, val rebalanceStrategy: String? = null)

The configuration parameters used while performing automatic AZ balancing.

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
data class BootDiagnosticsInstanceViewResponse(val consoleScreenshotBlobUri: String, val serialConsoleLogBlobUri: String, val status: InstanceViewStatusResponse)

The instance view of a virtual machine boot diagnostics.

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

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.

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.

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

The parameters of a capacity reservation Profile.

Link copied to clipboard
data class CapacityReservationUtilizationResponse(val currentCapacity: Int, val virtualMachinesAllocated: List<SubResourceReadOnlyResponse>)

Represents the capacity reservation utilization in terms of resources allocated.

Link copied to clipboard
data class CloudServiceExtensionProfileResponse(val extensions: List<ExtensionResponse>? = null)

Describes a cloud service extension profile.

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

Extension Properties.

Link copied to clipboard
data class CloudServiceNetworkProfileResponse(val loadBalancerConfigurations: List<LoadBalancerConfigurationResponse>? = null, val slotType: String? = null, val swappableCloudService: SubResourceResponse? = null)

Network Profile for the cloud service.

Link copied to clipboard

Describes the OS profile for the cloud service.

Link copied to clipboard
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

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

Describes the role properties.

Link copied to clipboard

Describes the role profile for the cloud service.

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

Describes the cloud service role sku.

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

Protected settings for the extension, referenced using KeyVault which are encrypted before sent to the role instance.

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
data class CommunityGalleryInfoResponse(val communityGalleryEnabled: Boolean, val eula: String? = null, val publicNamePrefix: String? = null, val publicNames: List<String>, val publisherContact: String? = null, val publisherUri: String? = null)

Information of community gallery if current gallery is shared to community

Link copied to clipboard
data class CopyCompletionErrorResponse(val errorCode: String, val errorMessage: String)

Indicates the error details if the background copy of a resource created via the CopyStart operation fails.

Link copied to clipboard
data class CreationDataResponse(val createOption: String, val elasticSanResourceId: String? = null, val galleryImageReference: ImageDiskReferenceResponse? = null, val imageReference: ImageDiskReferenceResponse? = null, val logicalSectorSize: Int? = null, val performancePlus: Boolean? = null, val provisionedBandwidthCopySpeed: String? = null, val securityDataUri: String? = 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.

Link copied to clipboard
data class DataDiskImageEncryptionResponse(val diskEncryptionSetId: String? = null, val lun: Int)

Contains encryption settings for a data disk image.

Link copied to clipboard
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 sourceResource: ApiEntityReferenceResponse? = null, val toBeDetached: Boolean? = null, val vhd: VirtualHardDiskResponse? = null, val writeAcceleratorEnabled: Boolean? = null)

Describes a data disk.

Link copied to clipboard
data class DedicatedHostAllocatableVMResponse(val count: Double? = null, val vmSize: String? = null)

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

Link copied to clipboard

Dedicated host unutilized capacity.

Enables or disables a capability on the dedicated host group. Minimum api-version: 2022-03-01.

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

The instance view of a dedicated host.

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.

data class DefaultVirtualMachineScaleSetInfoResponse(val constrainedMaximumCapacity: Boolean, val defaultVirtualMachineScaleSet: SubResourceResponse)

Indicates the target Virtual Machine ScaleSet properties upon triggering a seamless migration without downtime of the VMs via the ConvertToVirtualMachineScaleSet API.

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 DisallowedResponse(val diskTypes: List<String>? = null)

Describes the disallowed disk types.

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 DiskEncryptionSettingsResponse(val diskEncryptionKey: KeyVaultSecretReferenceResponse? = null, val enabled: Boolean? = null, val keyEncryptionKey: KeyVaultKeyReferenceResponse? = null)

Describes a Encryption Settings for a Disk

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

The instance view of the disk.

Link copied to clipboard
data class DiskRestorePointAttributesResponse(val encryption: RestorePointEncryptionResponse? = null, val id: String, val sourceDiskRestorePoint: ApiEntityReferenceResponse? = null)

Disk Restore Point details.

Link copied to clipboard
data class DiskRestorePointInstanceViewResponse(val id: String? = null, val replicationStatus: DiskRestorePointReplicationStatusResponse? = null)

The instance view of a disk restore point.

data class DiskRestorePointReplicationStatusResponse(val completionPercent: Int? = null, val status: InstanceViewStatusResponse? = null)

The instance view of a disk restore point.

Link copied to clipboard
data class DiskSecurityProfileResponse(val secureVMDiskEncryptionSetId: String? = null, val securityType: String? = null)

Contains the security related information for the resource.

Link copied to clipboard
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, StandardSSD_ZRS, or PremiumV2_LRS.

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

Link copied to clipboard
data class EncryptionResponse(val diskEncryptionSetId: String? = null, val type: String? = null)

Encryption at rest settings for disk or snapshot

Link copied to clipboard
data class EncryptionSetIdentityResponse(val principalId: String, val tenantId: String, val type: String? = null, val userAssignedIdentities: Map<String, UserAssignedIdentitiesResponseUserAssignedIdentities>? = 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.

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

Encryption settings for disk or snapshot

Link copied to clipboard
data class EncryptionSettingsElementResponse(val diskEncryptionKey: KeyVaultAndSecretReferenceResponse? = null, val keyEncryptionKey: KeyVaultAndKeyReferenceResponse? = null)

Encryption settings for one disk volume.

Link copied to clipboard
data class EventGridAndResourceGraphResponse(val enable: Boolean? = null)

Specifies eventGridAndResourceGraph related Scheduled Event related configurations.

Link copied to clipboard
data class ExecutedValidationResponse(val executionTime: String? = null, val status: String? = null, val type: String? = null, val version: String? = null)

This is the executed Validation.

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

The complex type of the extended location.

Link copied to clipboard
data class ExtensionResponse(val name: String? = null, val properties: CloudServiceExtensionPropertiesResponse? = null)

Describes a cloud service Extension.

data class GalleryApplicationCustomActionParameterResponse(val defaultValue: String? = null, val description: String? = null, val name: String, val required: Boolean? = null, val type: String? = null)

The definition of a parameter that can be passed to a custom action of a Gallery Application Version.

Link copied to clipboard
data class GalleryApplicationCustomActionResponse(val description: String? = null, val name: String, val parameters: List<GalleryApplicationCustomActionParameterResponse>? = null, val script: String)

A custom action that can be performed with a Gallery Application Version.

data class GalleryApplicationVersionPublishingProfileResponse(val advancedSettings: Map<String, String>? = null, val customActions: List<GalleryApplicationCustomActionResponse>? = null, val enableHealthCheck: Boolean? = null, val endOfLifeDate: String? = null, val excludeFromLatest: Boolean? = null, val manageActions: UserArtifactManageResponse? = null, val publishedDate: String, val replicaCount: Int? = null, val replicationMode: String? = null, val settings: UserArtifactSettingsResponse? = null, val source: UserArtifactSourceResponse, val storageAccountType: String? = null, val targetExtendedLocations: List<GalleryTargetExtendedLocationResponse>? = null, val targetRegions: List<TargetRegionResponse>? = null)

The publishing profile of a gallery image version.

data class GalleryApplicationVersionSafetyProfileResponse(val allowDeletionOfReplicatedLocations: Boolean? = null)

The safety profile of the Gallery Application Version.

Link copied to clipboard
data class GalleryArtifactVersionFullSourceResponse(val communityGalleryImageId: String? = null, val id: String? = null, val virtualMachineId: String? = null)

The source of the gallery artifact version.

Link copied to clipboard
data class GalleryDataDiskImageResponse(val hostCaching: String? = null, val lun: Int, val sizeInGB: Int, val source: GalleryDiskImageSourceResponse? = null)

This is the data disk image.

Link copied to clipboard
data class GalleryDiskImageSourceResponse(val id: String? = null, val storageAccountId: String? = null, val uri: String? = null)

The source for the disk image.

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

The name of the extended location.

Link copied to clipboard
data class GalleryIdentifierResponse(val uniqueName: String)

Describes the gallery unique name.

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

Identity for the virtual machine.

Link copied to clipboard
data class GalleryImageFeatureResponse(val name: String? = null, val startsAtVersion: String? = null, val value: String? = null)

A feature for gallery image.

Link copied to clipboard
data class GalleryImageIdentifierResponse(val offer: String, val publisher: String, val sku: String)

This is the gallery image definition identifier.

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

The publishing profile of a gallery image Version.

Link copied to clipboard
data class GalleryImageVersionSafetyProfileResponse(val allowDeletionOfReplicatedLocations: Boolean? = null, val blockDeletionBeforeEndOfLife: Boolean? = null, val policyViolations: List<PolicyViolationResponse>, val reportedForPolicyViolation: Boolean)

This is the safety profile of the Gallery Image Version.

This is the storage profile of a Gallery Image Version.

Link copied to clipboard
data class GalleryImageVersionUefiSettingsResponse(val additionalSignatures: UefiKeySignaturesResponse? = null, val signatureTemplateNames: List<String>? = null)

Contains UEFI settings for the image version.

data class GalleryInVMAccessControlProfilePropertiesResponse(val applicableHostEndpoint: String, val description: String? = null, val osType: String, val provisioningState: String)

Describes the properties of a gallery inVMAccessControlProfile.

Link copied to clipboard
data class GalleryOSDiskImageResponse(val hostCaching: String? = null, val sizeInGB: Int, val source: GalleryDiskImageSourceResponse? = null)

This is the OS disk image.

Link copied to clipboard
data class GalleryTargetExtendedLocationResponse(val encryption: EncryptionImagesResponse? = null, val extendedLocation: GalleryExtendedLocationResponse? = null, val extendedLocationReplicaCount: Int? = null, val name: String? = null, val storageAccountType: String? = null)
Link copied to clipboard
data class GetAvailabilitySetResult(val azureApiVersion: String, val id: String, val location: String, val name: String, val platformFaultDomainCount: Int? = null, val platformUpdateDomainCount: Int? = null, val proximityPlacementGroup: SubResourceResponse? = null, val scheduledEventsPolicy: ScheduledEventsPolicyResponse? = null, val sku: SkuResponse? = null, val statuses: List<InstanceViewStatusResponse>, val tags: Map<String, String>? = null, val type: String, val virtualMachineScaleSetMigrationInfo: VirtualMachineScaleSetMigrationInfoResponse, 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 Availability sets overview. For more information on Azure planned maintenance, see Maintenance and updates for Virtual Machines in Azure. Currently, a VM can only be added to an availability set at creation time. An existing VM cannot be added to an availability set.

Link copied to clipboard
data class GetCapacityReservationGroupResult(val azureApiVersion: String, val capacityReservations: List<SubResourceReadOnlyResponse>, val id: String, val instanceView: CapacityReservationGroupInstanceViewResponse, val location: String, val name: String, val sharingProfile: ResourceSharingProfileResponse? = null, 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.

Link copied to clipboard
data class GetCapacityReservationResult(val azureApiVersion: String, val id: String, val instanceView: CapacityReservationInstanceViewResponse, val location: String, val name: String, val platformFaultDomainCount: Int, val provisioningState: String, val provisioningTime: String, val reservationId: String, val sku: SkuResponse, val tags: Map<String, String>? = null, val timeCreated: String, val type: String, val virtualMachinesAssociated: List<SubResourceReadOnlyResponse>, val zones: List<String>? = null)

Specifies information about the capacity reservation.

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

Describes the cloud service.

Link copied to clipboard
data class GetDedicatedHostGroupResult(val additionalCapabilities: DedicatedHostGroupPropertiesResponseAdditionalCapabilities? = null, val azureApiVersion: String, 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.

Link copied to clipboard
data class GetDedicatedHostResult(val autoReplaceOnFailure: Boolean? = null, val azureApiVersion: String, 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 timeCreated: String, val type: String, val virtualMachines: List<SubResourceReadOnlyResponse>)

Specifies information about the Dedicated host.

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

The Private Endpoint Connection resource.

Link copied to clipboard
data class GetDiskAccessResult(val azureApiVersion: String, val extendedLocation: ExtendedLocationResponse? = null, 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.

Link copied to clipboard
data class GetDiskEncryptionSetResult(val activeKey: KeyForDiskEncryptionSetResponse? = null, val autoKeyRotationError: ApiErrorResponse, val azureApiVersion: String, val encryptionType: String? = null, val federatedClientId: 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.

Link copied to clipboard
data class GetDiskResult(val azureApiVersion: String, val burstingEnabled: Boolean? = null, val burstingEnabledTime: String, val completionPercent: Double? = null, val creationData: CreationDataResponse, val dataAccessAuthMode: String? = null, 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 lastOwnershipUpdateTime: String, val location: String, val managedBy: String, val managedByExtended: List<String>, val maxShares: Int? = null, val name: String, val networkAccessPolicy: String? = null, val optimizedForFrequentAttach: Boolean? = null, val osType: String? = null, val propertyUpdatesInProgress: PropertyUpdatesInProgressResponse, val provisioningState: String, val publicNetworkAccess: String? = null, val purchasePlan: PurchasePlanResponse? = null, val securityProfile: DiskSecurityProfileResponse? = null, val shareInfo: List<ShareInfoElementResponse>, val sku: DiskSkuResponse? = null, val supportedCapabilities: SupportedCapabilitiesResponse? = 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.

Link copied to clipboard
data class GetGalleryApplicationResult(val azureApiVersion: String, val customActions: List<GalleryApplicationCustomActionResponse>? = null, 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.

Link copied to clipboard
data class GetGalleryApplicationVersionResult(val azureApiVersion: String, val id: String, val location: String, val name: String, val provisioningState: String, val publishingProfile: GalleryApplicationVersionPublishingProfileResponse, val replicationStatus: ReplicationStatusResponse, val safetyProfile: GalleryApplicationVersionSafetyProfileResponse? = null, val tags: Map<String, String>? = null, val type: String)

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

Link copied to clipboard
data class GetGalleryImageResult(val allowUpdateImage: Boolean? = null, val architecture: String? = null, val azureApiVersion: String, 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.

Link copied to clipboard
data class GetGalleryImageVersionResult(val azureApiVersion: String, val id: String, val location: String, val name: String, val provisioningState: String, val publishingProfile: GalleryImageVersionPublishingProfileResponse? = null, val replicationStatus: ReplicationStatusResponse, val restore: Boolean? = null, val safetyProfile: GalleryImageVersionSafetyProfileResponse? = null, val securityProfile: ImageVersionSecurityProfileResponse? = null, val storageProfile: GalleryImageVersionStorageProfileResponse, val tags: Map<String, String>? = null, val type: String, val validationsProfile: ValidationsProfileResponse)

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

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

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

data class GetGalleryInVMAccessControlProfileVersionResult(val azureApiVersion: String, val defaultAccess: String, val excludeFromLatest: Boolean? = null, val id: String, val location: String, val mode: String, val name: String, val provisioningState: String, val publishedDate: String, val replicationStatus: ReplicationStatusResponse, val rules: AccessControlRulesResponse? = null, val tags: Map<String, String>? = null, val targetLocations: List<TargetRegionResponse>? = null, val type: String)

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

Link copied to clipboard
data class GetGalleryResult(val azureApiVersion: String, val description: String? = null, val id: String, val identifier: GalleryIdentifierResponse? = null, val identity: GalleryIdentityResponse? = null, val location: String, val name: String, val provisioningState: String, val sharingProfile: SharingProfileResponse? = null, val sharingStatus: SharingStatusResponse, val softDeletePolicy: SoftDeletePolicyResponse? = null, val tags: Map<String, String>? = null, val type: String)

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

Link copied to clipboard
data class GetImageResult(val azureApiVersion: String, 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.

LogAnalytics operation status response

LogAnalytics operation status response

Link copied to clipboard
data class GetProximityPlacementGroupResult(val availabilitySets: List<SubResourceWithColocationStatusResponse>, val azureApiVersion: String, val colocationStatus: InstanceViewStatusResponse? = null, val id: String, val intent: ProximityPlacementGroupPropertiesResponseIntent? = null, 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>, val zones: List<String>? = null)

Specifies information about the proximity placement group.

Link copied to clipboard
data class GetRestorePointCollectionResult(val azureApiVersion: String, 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.

Link copied to clipboard
data class GetRestorePointResult(val azureApiVersion: String, val consistencyMode: String? = null, val excludeDisks: List<ApiEntityReferenceResponse>? = null, val id: String, val instanceView: RestorePointInstanceViewResponse, val name: String, val provisioningState: String, val sourceMetadata: RestorePointSourceMetadataResponse? = null, val sourceRestorePoint: ApiEntityReferenceResponse? = null, val timeCreated: String? = null, val type: String)

Restore Point details.

Link copied to clipboard
data class GetSnapshotResult(val azureApiVersion: String, val completionPercent: Double? = null, val copyCompletionError: CopyCompletionErrorResponse? = null, val creationData: CreationDataResponse, val dataAccessAuthMode: String? = null, 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 incrementalSnapshotFamilyId: String, val location: String, val managedBy: String, val name: String, val networkAccessPolicy: String? = null, val osType: String? = null, val provisioningState: String, val publicNetworkAccess: String? = null, val purchasePlan: PurchasePlanResponse? = null, val securityProfile: DiskSecurityProfileResponse? = null, val sku: SnapshotSkuResponse? = null, val supportedCapabilities: SupportedCapabilitiesResponse? = null, val supportsHibernation: Boolean? = null, val tags: Map<String, String>? = null, val timeCreated: String, val type: String, val uniqueId: String)

Snapshot resource.

Link copied to clipboard
data class GetSshPublicKeyResult(val azureApiVersion: String, 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.

Link copied to clipboard
data class GetVirtualMachineExtensionResult(val autoUpgradeMinorVersion: Boolean? = null, val azureApiVersion: String, val enableAutomaticUpgrade: Boolean? = null, val forceUpdateTag: String? = null, val id: String, val instanceView: VirtualMachineExtensionInstanceViewResponse? = null, val location: String? = null, val name: String, val protectedSettings: Any? = 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 tags: Map<String, String>? = null, val type: String, val typeHandlerVersion: String? = null)

Describes a Virtual Machine Extension.

Link copied to clipboard
data class GetVirtualMachineResult(val additionalCapabilities: AdditionalCapabilitiesResponse? = null, val applicationProfile: ApplicationProfileResponse? = null, val availabilitySet: SubResourceResponse? = null, val azureApiVersion: String, val billingProfile: BillingProfileResponse? = null, val capacityReservation: CapacityReservationProfileResponse? = null, val diagnosticsProfile: DiagnosticsProfileResponse? = null, val etag: String, 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 managedBy: String, val name: String, val networkProfile: NetworkProfileResponse? = null, val osProfile: OSProfileResponse? = null, val placement: PlacementResponse? = 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 scheduledEventsPolicy: ScheduledEventsPolicyResponse? = null, val scheduledEventsProfile: ScheduledEventsProfileResponse? = null, val securityProfile: SecurityProfileResponse? = null, val storageProfile: StorageProfileResponse? = null, val tags: Map<String, String>? = null, val timeCreated: String, val type: String, val userData: String? = null, val virtualMachineScaleSet: SubResourceResponse? = null, val vmId: String, val zones: List<String>? = null)

Describes a Virtual Machine.

data class GetVirtualMachineRunCommandByVirtualMachineResult(val asyncExecution: Boolean? = null, val azureApiVersion: String, val errorBlobManagedIdentity: RunCommandManagedIdentityResponse? = null, val errorBlobUri: String? = null, val id: String, val instanceView: VirtualMachineRunCommandInstanceViewResponse, val location: String, val name: String, val outputBlobManagedIdentity: RunCommandManagedIdentityResponse? = null, val outputBlobUri: String? = null, val parameters: List<RunCommandInputParameterResponse>? = null, val protectedParameters: List<RunCommandInputParameterResponse>? = null, val provisioningState: String, val runAsPassword: String? = null, val runAsUser: String? = null, val source: VirtualMachineRunCommandScriptSourceResponse? = null, val tags: Map<String, String>? = null, val timeoutInSeconds: Int? = null, val treatFailureAsDeploymentFailure: Boolean? = null, val type: String)

Describes a Virtual Machine run command.

Link copied to clipboard
data class GetVirtualMachineScaleSetExtensionResult(val autoUpgradeMinorVersion: Boolean? = null, val azureApiVersion: String, val enableAutomaticUpgrade: Boolean? = null, val forceUpdateTag: String? = null, val id: String, val name: String? = null, val protectedSettings: Any? = 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, val typeHandlerVersion: String? = null)

Describes a Virtual Machine Scale Set Extension.

Link copied to clipboard
data class GetVirtualMachineScaleSetResult(val additionalCapabilities: AdditionalCapabilitiesResponse? = null, val automaticRepairsPolicy: AutomaticRepairsPolicyResponse? = null, val azureApiVersion: String, val constrainedMaximumCapacity: Boolean? = null, val doNotRunExtensionsOnOverprovisionedVMs: Boolean? = null, val etag: String, 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 priorityMixPolicy: PriorityMixPolicyResponse? = null, val provisioningState: String, val proximityPlacementGroup: SubResourceResponse? = null, val resiliencyPolicy: ResiliencyPolicyResponse? = null, val scaleInPolicy: ScaleInPolicyResponse? = null, val scheduledEventsPolicy: ScheduledEventsPolicyResponse? = null, val singlePlacementGroup: Boolean? = null, val sku: SkuResponse? = null, val skuProfile: SkuProfileResponse? = null, val spotRestorePolicy: SpotRestorePolicyResponse? = null, val tags: Map<String, String>? = null, val timeCreated: String, val type: String, val uniqueId: String, val upgradePolicy: UpgradePolicyResponse? = null, val virtualMachineProfile: VirtualMachineScaleSetVMProfileResponse? = null, val zonalPlatformFaultDomainAlignMode: String? = null, val zoneBalance: Boolean? = null, val zones: List<String>? = null)

Describes a Virtual Machine Scale Set.

data class GetVirtualMachineScaleSetVMExtensionResult(val autoUpgradeMinorVersion: Boolean? = null, val azureApiVersion: String, val enableAutomaticUpgrade: Boolean? = null, val forceUpdateTag: String? = null, val id: String, val instanceView: VirtualMachineExtensionInstanceViewResponse? = null, val location: String? = null, val name: String, val protectedSettings: Any? = 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, val typeHandlerVersion: String? = null)

Describes a VMSS VM Extension.

Link copied to clipboard
data class GetVirtualMachineScaleSetVMResult(val additionalCapabilities: AdditionalCapabilitiesResponse? = null, val availabilitySet: SubResourceResponse? = null, val azureApiVersion: String, val diagnosticsProfile: DiagnosticsProfileResponse? = null, val etag: String, val hardwareProfile: HardwareProfileResponse? = null, val id: String, val identity: VirtualMachineIdentityResponse? = null, 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 resilientVMDeletionStatus: String? = null, val resources: List<VirtualMachineExtensionResponse>, val securityProfile: SecurityProfileResponse? = null, val sku: SkuResponse, val storageProfile: StorageProfileResponse? = null, val tags: Map<String, String>? = null, val timeCreated: String, val type: String, val userData: String? = null, val vmId: String, val zones: List<String>)

Describes a virtual machine scale set virtual machine.

data class GetVirtualMachineScaleSetVMRunCommandResult(val asyncExecution: Boolean? = null, val azureApiVersion: String, val errorBlobManagedIdentity: RunCommandManagedIdentityResponse? = null, val errorBlobUri: String? = null, val id: String, val instanceView: VirtualMachineRunCommandInstanceViewResponse, val location: String, val name: String, val outputBlobManagedIdentity: RunCommandManagedIdentityResponse? = null, val outputBlobUri: String? = null, val parameters: List<RunCommandInputParameterResponse>? = null, val protectedParameters: List<RunCommandInputParameterResponse>? = null, val provisioningState: String, val runAsPassword: String? = null, val runAsUser: String? = null, val source: VirtualMachineRunCommandScriptSourceResponse? = null, val tags: Map<String, String>? = null, val timeoutInSeconds: Int? = null, val treatFailureAsDeploymentFailure: Boolean? = null, val type: String)

Describes a Virtual Machine run command.

Link copied to clipboard
data class HardwareProfileResponse(val vmSize: String? = null, val vmSizeProperties: VMSizePropertiesResponse? = null)

Specifies the hardware settings for the virtual machine.

Link copied to clipboard
data class HostEndpointSettingsResponse(val inVMAccessControlProfileReferenceId: String? = null, val mode: String? = null)

Specifies particular host endpoint settings.

Link copied to clipboard
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.

Link copied to clipboard
data class ImageDiskReferenceResponse(val communityGalleryImageId: String? = null, val id: String? = null, val lun: Int? = null, val sharedGalleryImageId: String? = null)

The source image used for creating the disk.

Link copied to clipboard
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.

Link copied to clipboard
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.

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 ImageStorageProfileResponse(val dataDisks: List<ImageDataDiskResponse>? = null, val osDisk: ImageOSDiskResponse? = null, val zoneResilient: Boolean? = null)

Describes a storage profile.

Link copied to clipboard

The security profile of a gallery image version

Link copied to clipboard
data class InnerErrorResponse(val errordetail: String? = null, val exceptiontype: String? = null)

Inner error details.

Link copied to clipboard
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.

Link copied to clipboard
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

Link copied to clipboard
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

Link copied to clipboard
data class KeyVaultAndSecretReferenceResponse(val secretUrl: String, val sourceVault: SourceVaultResponse)

Key Vault Secret Url and vault id of the encryption key

Link copied to clipboard
data class KeyVaultKeyReferenceResponse(val keyUrl: String, val sourceVault: SubResourceResponse)

Describes a reference to Key Vault Key

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

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

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.

Describes the properties of the load balancer configuration.

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

Describes the load balancer configuration.

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

Describes a cloud service IP Configuration

Specifies the frontend IP to be used for the load balancer. Only IPv4 frontend IP address is supported. Each load balancer configuration must have exactly one frontend IP configuration.

Link copied to clipboard
data class LogAnalyticsOutputResponse(val output: String)

LogAnalytics output properties

Link copied to clipboard
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.

Link copied to clipboard
data class ManagedDiskParametersResponse(val diskEncryptionSet: DiskEncryptionSetParametersResponse? = null, val id: String? = null, val securityProfile: VMDiskSecurityProfileResponse? = null, val storageAccountType: String? = null)

The parameters of a managed disk.

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

Describes a network interface reference.

Link copied to clipboard
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.

Link copied to clipboard
data class OSDiskImageEncryptionResponse(val diskEncryptionSetId: String? = null, val securityProfile: OSDiskImageSecurityProfileResponse? = null)

Contains encryption settings for an OS disk image.

Link copied to clipboard
data class OSDiskImageSecurityProfileResponse(val confidentialVMEncryptionType: String? = null, val secureVMDiskEncryptionSetId: String? = null)

Contains security profile for an OS disk image.

Link copied to clipboard
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.

Link copied to clipboard
data class OSImageNotificationProfileResponse(val enable: Boolean? = null, val notBeforeTimeout: String? = null)
Link copied to clipboard
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.

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 PlacementResponse(val excludeZones: List<String>? = null, val includeZones: List<String>? = null, val zonePlacementPolicy: String? = null)

Describes the user-defined constraints for virtual machine hardware placement.

Link copied to clipboard
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.

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

This is the platform attribute of the image version.

Link copied to clipboard
data class PolicyViolationResponse(val category: String? = null, val details: String? = null)

A policy violation reported against a gallery artifact.

Link copied to clipboard
data class PriorityMixPolicyResponse(val baseRegularPriorityCount: Int? = null, val regularPriorityPercentageAboveBase: Int? = null)

Specifies the target splits for Spot and Regular priority VMs within a scale set with flexible orchestration mode. With this property the customer is able to specify the base number of regular priority VMs created as the VMSS flex instance scales out and the split between Spot and Regular priority VMs after this base target has been reached.

Link copied to clipboard
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.

Link copied to clipboard
data class PrivateEndpointResponse(val id: String)

The Private Endpoint resource.

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.

Link copied to clipboard
data class PropertyUpdatesInProgressResponse(val targetTier: String? = null)

Properties of the disk for which update is pending.

Specifies the user intent of the proximity placement group.

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

Specifies ProxyAgent settings for the virtual machine or virtual machine scale set. 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 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.

Link copied to clipboard
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.

Link copied to clipboard
data class RegionalReplicationStatusResponse(val details: String, val progress: Int, val region: String, val state: String)

This is the regional replication status.

Link copied to clipboard
data class RegionalSharingStatusResponse(val details: String? = null, val region: String? = null, val state: String)

Gallery regional sharing status

Link copied to clipboard
data class ReplicationStatusResponse(val aggregatedState: String, val summary: List<RegionalReplicationStatusResponse>)

This is the replication status of the gallery image version.

Link copied to clipboard
data class ResiliencyPolicyResponse(val automaticZoneRebalancingPolicy: AutomaticZoneRebalancingPolicyResponse? = null, val resilientVMCreationPolicy: ResilientVMCreationPolicyResponse? = null, val resilientVMDeletionPolicy: ResilientVMDeletionPolicyResponse? = null)

Describes an resiliency policy - AutomaticZoneRebalancingPolicy, ResilientVMCreationPolicy and/or ResilientVMDeletionPolicy.

Link copied to clipboard
data class ResilientVMCreationPolicyResponse(val enabled: Boolean? = null)

The configuration parameters used while performing resilient VM creation.

Link copied to clipboard
data class ResilientVMDeletionPolicyResponse(val enabled: Boolean? = null)

The configuration parameters used while performing resilient VM deletion.

Link copied to clipboard
data class ResourceRangeResponse(val max: Int? = null, val min: Int? = null)

Describes the resource range.

Link copied to clipboard
data class ResourceSharingProfileResponse(val subscriptionIds: List<SubResourceResponse>? = null)
data class RestorePointCollectionSourcePropertiesResponse(val id: String? = null, val location: String)

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

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

Encryption at rest settings for disk restore point. It is an optional property that can be specified in the input while creating a restore point.

Link copied to clipboard
data class RestorePointInstanceViewResponse(val diskRestorePoints: List<DiskRestorePointInstanceViewResponse>? = null, val statuses: List<InstanceViewStatusResponse>? = null)

The instance view of a restore point.

Link copied to clipboard
data class RestorePointResponse(val consistencyMode: String? = null, val excludeDisks: List<ApiEntityReferenceResponse>? = null, val id: String, val instanceView: RestorePointInstanceViewResponse, val name: String, val provisioningState: String, val sourceMetadata: RestorePointSourceMetadataResponse? = null, val sourceRestorePoint: ApiEntityReferenceResponse? = null, val timeCreated: String? = null, val type: String)

Restore Point details.

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

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.

Link copied to clipboard
data class RestorePointSourceVMDataDiskResponse(val caching: String, val diskRestorePoint: DiskRestorePointAttributesResponse? = null, val diskSizeGB: Int, val lun: Int, val managedDisk: ManagedDiskParametersResponse? = null, val name: String, val writeAcceleratorEnabled: Boolean)

Describes a data disk.

Link copied to clipboard
data class RestorePointSourceVMOSDiskResponse(val caching: String, val diskRestorePoint: DiskRestorePointAttributesResponse? = null, val diskSizeGB: Int, val encryptionSettings: DiskEncryptionSettingsResponse, val managedDisk: ManagedDiskParametersResponse? = null, val name: String, val osType: String, val writeAcceleratorEnabled: Boolean)

Describes an Operating System disk.

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

Describes the storage profile.

Link copied to clipboard
data class RollingUpgradePolicyResponse(val enableCrossZoneUpgrade: Boolean? = null, val maxBatchInstancePercent: Int? = null, val maxSurge: Boolean? = null, val maxUnhealthyInstancePercent: Int? = null, val maxUnhealthyUpgradedInstancePercent: Int? = null, val pauseTimeBetweenBatches: String? = null, val prioritizeUnhealthyInstances: Boolean? = null, val rollbackFailedInstancesOnPolicyBreach: Boolean? = null)

The configuration parameters used while performing a rolling upgrade.

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

Describes the properties of a run command parameter.

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

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

Link copied to clipboard
data class ScaleInPolicyResponse(val forceDeletion: Boolean? = null, val prioritizeUnhealthyVMs: Boolean? = null, val rules: List<String>? = null)

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

Link copied to clipboard
data class ScheduledEventsPolicyResponse(val scheduledEventsAdditionalPublishingTargets: ScheduledEventsAdditionalPublishingTargetsResponse? = null, val userInitiatedReboot: UserInitiatedRebootResponse? = null, val userInitiatedRedeploy: UserInitiatedRedeployResponse? = null)

Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations.

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

Specifies the security posture to be used 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 ShareInfoElementResponse(val vmUri: String)
Link copied to clipboard
data class SharingProfileGroupResponse(val ids: List<String>? = null, val type: String? = null)

Group of the gallery sharing profile

Link copied to clipboard
data class SharingProfileResponse(val communityGalleryInfo: CommunityGalleryInfoResponse? = null, val groups: List<SharingProfileGroupResponse>, val permissions: String? = null)

Profile for gallery sharing to subscription or tenant

Link copied to clipboard
data class SharingStatusResponse(val aggregatedState: String, val summary: List<RegionalSharingStatusResponse>? = null)

Sharing status of current gallery.

Link copied to clipboard
data class SkuProfileResponse(val allocationStrategy: String? = null, val vmSizes: List<SkuProfileVMSizeResponse>? = null)

Specifies the sku profile for the virtual machine scale set. With this property the customer is able to specify a list of VM sizes and an allocation strategy.

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

Specifies the VM Size.

Link copied to clipboard
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.

Link copied to clipboard
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

Link copied to clipboard
data class SoftDeletePolicyResponse(val isSoftDeleteEnabled: Boolean? = null)

Contains information about the soft deletion policy of the gallery.

Link copied to clipboard
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}

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

Specifies the Spot-Try-Restore properties for the virtual machine scale set. With this property customer can enable or disable automatic restore of the evicted Spot VMSS VM instances opportunistically based on capacity availability and pricing constraint.

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 StorageProfileResponse(val alignRegionalDisksToVMZone: Boolean? = null, val dataDisks: List<DataDiskResponse>? = null, val diskControllerType: String? = null, val imageReference: ImageReferenceResponse? = null, val osDisk: OSDiskResponse? = null)

Specifies the storage settings for the virtual machine disks.

Link copied to clipboard
Link copied to clipboard
data class SubResourceResponse(val id: String? = null)
Link copied to clipboard
data class SubResourceWithColocationStatusResponse(val colocationStatus: InstanceViewStatusResponse? = null, val id: String? = null)
Link copied to clipboard
data class SupportedCapabilitiesResponse(val acceleratedNetwork: Boolean? = null, val architecture: String? = null, val diskControllerTypes: String? = null)

List of supported capabilities persisted on the disk resource for VM use.

Link copied to clipboard
data class SystemDataResponse(val createdAt: String, val lastModifiedAt: String)

The system meta data relating to this resource.

Link copied to clipboard
data class TargetRegionResponse(val additionalReplicaSets: List<AdditionalReplicaSetResponse>? = null, val encryption: EncryptionImagesResponse? = null, val excludeFromLatest: Boolean? = null, val name: String, val regionalReplicaCount: Int? = null, val storageAccountType: String? = null)

Describes the target region information.

Link copied to clipboard
data class TerminateNotificationProfileResponse(val enable: Boolean? = null, val notBeforeTimeout: String? = null)
Link copied to clipboard
data class UefiKeyResponse(val type: String? = null, val value: List<String>? = null)

A UEFI key signature.

Link copied to clipboard
data class UefiKeySignaturesResponse(val db: List<UefiKeyResponse>? = null, val dbx: List<UefiKeyResponse>? = null, val kek: List<UefiKeyResponse>? = null, val pk: UefiKeyResponse? = null)

Additional UEFI key signatures that will be added to the image in addition to the signature templates

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 UpgradePolicyResponse(val automaticOSUpgradePolicy: AutomaticOSUpgradePolicyResponse? = null, val mode: String? = null, val rollingUpgradePolicy: RollingUpgradePolicyResponse? = null)

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

Link copied to clipboard
data class UserArtifactManageResponse(val install: String, val remove: String, val update: String? = null)
Link copied to clipboard
data class UserArtifactSettingsResponse(val configFileName: String? = null, val packageFileName: String? = null, val scriptBehaviorAfterReboot: String? = null)

Additional settings for the VM app that contains the target package and config file name when it is deployed to target VM or VM scale set.

Link copied to clipboard
data class UserArtifactSourceResponse(val defaultConfigurationLink: String? = null, val mediaLink: String)

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

Link copied to clipboard
data class UserInitiatedRebootResponse(val automaticallyApprove: Boolean? = null)

Specifies Reboot related Scheduled Event related configurations.

Link copied to clipboard
data class UserInitiatedRedeployResponse(val automaticallyApprove: Boolean? = null)

Specifies Redeploy related Scheduled Event related configurations.

Link copied to clipboard
data class ValidationsProfileResponse(val executedValidations: List<ExecutedValidationResponse>? = null, val platformAttributes: List<PlatformAttributeResponse>? = null, val validationEtag: String? = null)

This is the validations profile of a Gallery Image Version.

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

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

The instance view of a virtual machine extension handler.

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.

Link copied to clipboard
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? = null, val name: String, val protectedSettings: Any? = 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 tags: Map<String, String>? = null, val type: String, val typeHandlerVersion: String? = null)

Describes a Virtual Machine Extension.

Link copied to clipboard

The health status of the VM.

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

Identity for the virtual machine.

Link copied to clipboard
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 isVMInStandbyPool: Boolean, 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.

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

Contains the IP tag associated with the public IP address.

data class VirtualMachineNetworkInterfaceConfigurationResponse(val auxiliaryMode: String? = null, val auxiliarySku: String? = null, val deleteOption: String? = null, val disableTcpStateTracking: Boolean? = 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.

Describes a virtual machines network configuration's DNS settings.

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.

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

The status of virtual machine patch operations.

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

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

Describes a virtual machines network configuration's DNS settings.

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.

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

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

Link copied to clipboard
data class 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.

Link copied to clipboard
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 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, val typeHandlerVersion: String? = null)

Describes a Virtual Machine Scale Set Extension.

Specifies the hardware settings for the virtual machine scale set.

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

Identity for the virtual machine scale set.

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

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.

data class VirtualMachineScaleSetMigrationInfoResponse(val defaultVirtualMachineScaleSetInfo: DefaultVirtualMachineScaleSetInfoResponse, val migrateToVirtualMachineScaleSet: SubResourceResponse)

Describes the Availability Set properties related to migration to Flexible Virtual Machine Scale Set.

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

data class VirtualMachineScaleSetNetworkConfigurationResponse(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 name: String, val networkSecurityGroup: SubResourceResponse? = null, val primary: Boolean? = null)

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 adminPassword: String? = null, val adminUsername: String? = null, val allowExtensionOperations: Boolean? = null, val computerNamePrefix: String? = null, val customData: 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 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

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.

data class VirtualMachineScaleSetVMInstanceViewResponse(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 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.

Describes a virtual machine scale set VM network profile.

Link copied to clipboard
data class VirtualMachineScaleSetVMProfileResponse(val applicationProfile: ApplicationProfileResponse? = null, val billingProfile: BillingProfileResponse? = null, val capacityReservation: CapacityReservationProfileResponse? = null, val diagnosticsProfile: DiagnosticsProfileResponse? = null, val evictionPolicy: String? = null, val extensionProfile: VirtualMachineScaleSetExtensionProfileResponse? = null, val hardwareProfile: VirtualMachineScaleSetHardwareProfileResponse? = null, val licenseType: String? = null, val networkProfile: VirtualMachineScaleSetNetworkProfileResponse? = null, val osProfile: VirtualMachineScaleSetOSProfileResponse? = null, val priority: String? = 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 a virtual machine scale set virtual machine profile.

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

The protection policy of a virtual machine scale set VM.

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