Package-level declarations
Types
This is the Access Control Rules specification for an inVMAccessControlProfile version.
Builder for AccessControlRulesArgs.
The properties of an Access Control Rule Identity.
Builder for AccessControlRulesIdentityArgs.
Builder for AccessControlRulesPrivilegeArgs.
The properties of an Access Control Rule Role.
Builder for AccessControlRulesRoleArgs.
The properties of an Access Control Rule RoleAssignment.
Enables or disables a capability on the virtual machine or virtual machine scale set.
Builder for AdditionalCapabilitiesArgs.
Describes the additional replica set information.
Builder for AdditionalReplicaSetArgs.
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.
Builder for AdditionalUnattendContentArgs.
The API entity reference.
Builder for ApiEntityReferenceArgs.
Contains the list of gallery applications that should be made available to the VM/VMSS
Builder for ApplicationProfileArgs.
The configuration parameters used for performing automatic OS upgrade.
Builder for AutomaticOSUpgradePolicyArgs.
Specifies the configuration parameters for automatic repairs on the virtual machine scale set.
Builder for AutomaticRepairsPolicyArgs.
Specifies the billing related details of a Azure Spot VM or VMSS. Minimum api-version: 2019-03-01.
Builder for BillingProfileArgs.
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.
Builder for BootDiagnosticsArgs.
The parameters of a capacity reservation Profile.
Builder for CapacityReservationProfileArgs.
Describes a cloud service extension profile.
Builder for CloudServiceExtensionProfileArgs.
Extension Properties.
Network Profile for the cloud service.
Builder for CloudServiceNetworkProfileArgs.
Describes the OS profile for the cloud service.
Builder for CloudServiceOsProfileArgs.
Cloud service properties
Builder for CloudServicePropertiesArgs.
Describes the role profile for the cloud service.
Builder for CloudServiceRoleProfileArgs.
Describes the role properties.
Describes the cloud service role sku.
Builder for CloudServiceRoleSkuArgs.
Protected settings for the extension, referenced using KeyVault which are encrypted before sent to the role instance.
Describes a single certificate reference in a Key Vault, and where the certificate should reside on the role instance.
Builder for CloudServiceVaultCertificateArgs.
Describes a set of certificates which are all in the same Key Vault.
Builder for CloudServiceVaultSecretGroupArgs.
Information of community gallery if current gallery is shared to community
Builder for CommunityGalleryInfoArgs.
Indicates the error details if the background copy of a resource created via the CopyStart operation fails.
Builder for CopyCompletionErrorArgs.
Data used when creating a disk.
Builder for CreationDataArgs.
Describes a data disk.
Builder for DataDiskArgs.
Contains encryption settings for a data disk image.
Builder for DataDiskImageEncryptionArgs.
Enables or disables a capability on the dedicated host group. Minimum api-version: 2022-03-01.
Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15.
Builder for DiagnosticsProfileArgs.
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.
Builder for DiffDiskSettingsArgs.
Describes the disallowed disk types.
Builder for DisallowedArgs.
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.
Builder for DiskEncryptionSetParametersArgs.
Describes a Encryption Settings for a Disk
Builder for DiskEncryptionSettingsArgs.
Disk Restore Point details.
Builder for DiskRestorePointAttributesArgs.
Contains the security related information for the resource.
Builder for DiskSecurityProfileArgs.
The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, UltraSSD_LRS, Premium_ZRS, StandardSSD_ZRS, or PremiumV2_LRS.
Builder for DiskSkuArgs.
Encryption at rest settings for disk or snapshot
Builder for EncryptionArgs.
Optional. Allows users to provide customer managed keys for encrypting the OS and data disks in the gallery artifact.
Builder for EncryptionImagesArgs.
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.
Builder for EncryptionSetIdentityArgs.
Encryption settings for disk or snapshot
Builder for EncryptionSettingsCollectionArgs.
Encryption settings for one disk volume.
Builder for EncryptionSettingsElementArgs.
The complex type of the extended location.
Builder for ExtendedLocationArgs.
Describes a cloud service Extension.
Builder for ExtensionArgs.
A custom action that can be performed with a Gallery Application Version.
Builder for GalleryApplicationCustomActionArgs.
The definition of a parameter that can be passed to a custom action of a Gallery Application Version.
The publishing profile of a gallery image version.
The safety profile of the Gallery Application Version.
The source of the gallery artifact version.
This is the data disk image.
Builder for GalleryDataDiskImageArgs.
The source for the disk image.
Builder for GalleryDiskImageSourceArgs.
The name of the extended location.
Builder for GalleryExtendedLocationArgs.
A feature for gallery image.
Builder for GalleryImageFeatureArgs.
This is the gallery image definition identifier.
Builder for GalleryImageIdentifierArgs.
The publishing profile of a gallery image Version.
This is the safety profile of the Gallery Image Version.
This is the storage profile of a Gallery Image Version.
Describes the properties of a gallery inVMAccessControlProfile.
This is the OS disk image.
Builder for GalleryOSDiskImageArgs.
Builder for GalleryTargetExtendedLocationArgs.
Builder for GetAvailabilitySetPlainArgs.
Builder for GetCapacityReservationPlainArgs.
Builder for GetCloudServicePlainArgs.
Builder for GetDedicatedHostGroupPlainArgs.
Builder for GetDedicatedHostPlainArgs.
Builder for GetDiskAccessPlainArgs.
Builder for GetDiskEncryptionSetPlainArgs.
Builder for GetDiskPlainArgs.
Builder for GetGalleryApplicationPlainArgs.
Builder for GetGalleryImagePlainArgs.
Builder for GetGalleryImageVersionPlainArgs.
Builder for GetGalleryPlainArgs.
Builder for GetImagePlainArgs.
Builder for GetRestorePointCollectionPlainArgs.
Builder for GetRestorePointPlainArgs.
Builder for GetSnapshotPlainArgs.
Builder for GetSshPublicKeyPlainArgs.
Builder for GetVirtualMachinePlainArgs.
Builder for GetVirtualMachineScaleSetPlainArgs.
Specifies the hardware settings for the virtual machine.
Builder for HardwareProfileArgs.
Describes a data disk.
Builder for ImageDataDiskArgs.
The source image used for creating the disk.
Builder for ImageDiskReferenceArgs.
Describes an Operating System disk.
Builder for ImageOSDiskArgs.
Describes the gallery image definition purchase plan. This is used by marketplace images.
Builder for ImagePurchasePlanArgs.
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.
Builder for ImageReferenceArgs.
Describes a storage profile.
Builder for ImageStorageProfileArgs.
Instance view status.
Builder for InstanceViewStatusArgs.
Key Vault Key Url to be used for server side encryption of Managed Disks and Snapshots
Builder for KeyForDiskEncryptionSetArgs.
Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey
Builder for KeyVaultAndKeyReferenceArgs.
Key Vault Secret Url and vault id of the encryption key
Builder for KeyVaultAndSecretReferenceArgs.
Describes a reference to Key Vault Key
Builder for KeyVaultKeyReferenceArgs.
Describes a reference to Key Vault Secret
Builder for KeyVaultSecretReferenceArgs.
Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see Linux on Azure-Endorsed Distributions.
Builder for LinuxConfigurationArgs.
Specifies settings related to VM Guest Patching on Linux.
Builder for LinuxPatchSettingsArgs.
Specifies additional settings to be applied when patch mode AutomaticByPlatform is selected in Linux patch settings.
Describes the load balancer configuration.
Builder for LoadBalancerConfigurationArgs.
Describes the properties of the load balancer 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.
Describes a cloud service IP Configuration
The parameters of a managed disk.
Builder for ManagedDiskParametersArgs.
Describes a network interface reference.
Builder for NetworkInterfaceReferenceArgs.
Specifies the network interfaces or the networking configuration of the virtual machine.
Builder for NetworkProfileArgs.
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.
Builder for OSDiskArgs.
Contains encryption settings for an OS disk image.
Builder for OSDiskImageEncryptionArgs.
Contains security profile for an OS disk image.
Builder for OSDiskImageSecurityProfileArgs.
Builder for OSImageNotificationProfileArgs.
Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned.
Builder for OSProfileArgs.
Specifies settings related to VM Guest Patching on Windows.
Builder for PatchSettingsArgs.
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.
Builder for PlanArgs.
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.
Builder for PriorityMixPolicyArgs.
A collection of information about the state of the connection between service consumer and provider.
Specifies the user intent of the proximity placement group.
Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible.
Builder for PublicIPAddressSkuArgs.
Used for establishing the purchase context of any 3rd Party artifact through MarketPlace.
Builder for PurchasePlanArgs.
The properties describe the recommended machine configuration for this Image Definition. These properties are updatable.
Describes the resource range.
Builder for ResourceRangeArgs.
The properties of the source resource that this restore point collection is created from.
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.
Builder for RestorePointEncryptionArgs.
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.
Builder for RestorePointSourceMetadataArgs.
Describes a data disk.
Builder for RestorePointSourceVMDataDiskArgs.
Describes an Operating System disk.
Builder for RestorePointSourceVMOSDiskArgs.
Describes the storage profile.
The configuration parameters used while performing a rolling upgrade.
Builder for RollingUpgradePolicyArgs.
Describes the properties of a run command parameter.
Builder for RunCommandInputParameterArgs.
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.
Builder for RunCommandManagedIdentityArgs.
Describes a scale-in policy for a virtual machine scale set.
Builder for ScaleInPolicyArgs.
Builder for ScheduledEventsProfileArgs.
Specifies the security posture to be used for all virtual machines in the scale set. Minimum api-version: 2023-03-01
Builder for SecurityPostureReferenceArgs.
Specifies the Security profile settings for the virtual machine or virtual machine scale set.
Builder for SecurityProfileArgs.
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
Builder for ServiceArtifactReferenceArgs.
Profile for gallery sharing to subscription or tenant
Builder for SharingProfileArgs.
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.
Builder for SkuArgs.
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
Builder for SnapshotSkuArgs.
Contains information about the soft deletion policy of the gallery.
Builder for SoftDeletePolicyArgs.
The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}
Builder for SourceVaultArgs.
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.
Builder for SpotRestorePolicyArgs.
SSH configuration for Linux based VMs running on Azure
Builder for SshConfigurationArgs.
Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed.
Builder for SshPublicKeyArgs.
Specifies the storage settings for the virtual machine disks.
Builder for StorageProfileArgs.
Builder for SubResourceArgs.
List of supported capabilities persisted on the disk resource for VM use.
Builder for SupportedCapabilitiesArgs.
Describes the target region information.
Builder for TargetRegionArgs.
Builder for TerminateNotificationProfileArgs.
Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum api-version: 2020-12-01.
Builder for UefiSettingsArgs.
Describes an upgrade policy - automatic, manual, or rolling.
Builder for UpgradePolicyArgs.
Builder for UserArtifactManageArgs.
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.
Builder for UserArtifactSettingsArgs.
The source image from which the Image Version is going to be created.
Builder for UserArtifactSourceArgs.
Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM.
Builder for VaultCertificateArgs.
Describes a set of certificates which are all in the same Key Vault.
Builder for VaultSecretGroupArgs.
Describes the uri of a disk.
Builder for VirtualHardDiskArgs.
Describes a Virtual Machine Extension.
Builder for VirtualMachineExtensionArgs.
The instance view of a virtual machine extension.
Identity for the virtual machine.
Builder for VirtualMachineIdentityArgs.
Contains the IP tag associated with the public IP address.
Builder for VirtualMachineIpTagArgs.
Describes a virtual machine network interface configurations.
Describes a virtual machines network configuration's DNS settings.
Describes a virtual machine network profile's IP configuration.
Describes a virtual machines IP Configuration's PublicIPAddress configuration
Describes a virtual machines network configuration's DNS settings.
Describes the script sources for run command. Use only one of script, scriptUri, commandId.
Describes a virtual machine scale set data disk.
Builder for VirtualMachineScaleSetDataDiskArgs.
Describes a Virtual Machine Scale Set Extension.
Describes a virtual machine scale set extension profile.
Specifies the hardware settings for the virtual machine scale set.
Identity for the virtual machine scale set.
Builder for VirtualMachineScaleSetIdentityArgs.
Describes a virtual machine scale set network profile's IP configuration.
Contains the IP tag associated with the public IP address.
Builder for VirtualMachineScaleSetIpTagArgs.
Describes the parameters of a ScaleSet managed disk.
Describes a virtual machine scale set network profile's network configurations.
Describes a virtual machines scale sets network configuration's DNS settings.
Describes a virtual machine scale set network profile.
Describes a virtual machine scale set operating system disk.
Builder for VirtualMachineScaleSetOSDiskArgs.
Describes a virtual machine scale set OS profile.
Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration
Describes a virtual machines scale sets network configuration's DNS settings.
Describes a virtual machine scale set storage profile.
Describes a virtual machine scale set VM network profile.
Describes a virtual machine scale set virtual machine profile.
The protection policy of a virtual machine scale set VM.
Specifies the security profile settings for the managed disk. Note: It can only be set for Confidential VMs.
Builder for VMDiskSecurityProfileArgs.
Specifies the required information to reference a compute gallery application version
Builder for VMGalleryApplicationArgs.
Specifies VM Size Property settings on the virtual machine.
Builder for VMSizePropertiesArgs.
Specifies Windows operating system settings on the virtual machine.
Builder for WindowsConfigurationArgs.
Specifies additional settings to be applied when patch mode AutomaticByPlatform is selected in Windows patch settings.
Describes Windows Remote Management configuration of the VM
Builder for WinRMConfigurationArgs.
Describes Protocol and thumbprint of Windows Remote Management listener
Builder for WinRMListenerArgs.