1. Packages
  2. Azure Native v2
  3. API Docs
  4. compute
  5. getRestorePoint
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

azure-native-v2.compute.getRestorePoint

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

The operation to get the restore point. Azure REST API version: 2023-03-01.

Other available API versions: 2021-11-01, 2022-11-01, 2023-07-01, 2023-09-01, 2024-03-01, 2024-07-01.

Using getRestorePoint

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getRestorePoint(args: GetRestorePointArgs, opts?: InvokeOptions): Promise<GetRestorePointResult>
function getRestorePointOutput(args: GetRestorePointOutputArgs, opts?: InvokeOptions): Output<GetRestorePointResult>
Copy
def get_restore_point(expand: Optional[str] = None,
                      resource_group_name: Optional[str] = None,
                      restore_point_collection_name: Optional[str] = None,
                      restore_point_name: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetRestorePointResult
def get_restore_point_output(expand: Optional[pulumi.Input[str]] = None,
                      resource_group_name: Optional[pulumi.Input[str]] = None,
                      restore_point_collection_name: Optional[pulumi.Input[str]] = None,
                      restore_point_name: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetRestorePointResult]
Copy
func LookupRestorePoint(ctx *Context, args *LookupRestorePointArgs, opts ...InvokeOption) (*LookupRestorePointResult, error)
func LookupRestorePointOutput(ctx *Context, args *LookupRestorePointOutputArgs, opts ...InvokeOption) LookupRestorePointResultOutput
Copy

> Note: This function is named LookupRestorePoint in the Go SDK.

public static class GetRestorePoint 
{
    public static Task<GetRestorePointResult> InvokeAsync(GetRestorePointArgs args, InvokeOptions? opts = null)
    public static Output<GetRestorePointResult> Invoke(GetRestorePointInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetRestorePointResult> getRestorePoint(GetRestorePointArgs args, InvokeOptions options)
public static Output<GetRestorePointResult> getRestorePoint(GetRestorePointArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:compute:getRestorePoint
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
RestorePointCollectionName
This property is required.
Changes to this property will trigger replacement.
string
The name of the restore point collection.
RestorePointName
This property is required.
Changes to this property will trigger replacement.
string
The name of the restore point.
Expand string
The expand expression to apply on the operation. 'InstanceView' retrieves information about the run-time state of a restore point.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
RestorePointCollectionName
This property is required.
Changes to this property will trigger replacement.
string
The name of the restore point collection.
RestorePointName
This property is required.
Changes to this property will trigger replacement.
string
The name of the restore point.
Expand string
The expand expression to apply on the operation. 'InstanceView' retrieves information about the run-time state of a restore point.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
restorePointCollectionName
This property is required.
Changes to this property will trigger replacement.
String
The name of the restore point collection.
restorePointName
This property is required.
Changes to this property will trigger replacement.
String
The name of the restore point.
expand String
The expand expression to apply on the operation. 'InstanceView' retrieves information about the run-time state of a restore point.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
restorePointCollectionName
This property is required.
Changes to this property will trigger replacement.
string
The name of the restore point collection.
restorePointName
This property is required.
Changes to this property will trigger replacement.
string
The name of the restore point.
expand string
The expand expression to apply on the operation. 'InstanceView' retrieves information about the run-time state of a restore point.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group.
restore_point_collection_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the restore point collection.
restore_point_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the restore point.
expand str
The expand expression to apply on the operation. 'InstanceView' retrieves information about the run-time state of a restore point.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
restorePointCollectionName
This property is required.
Changes to this property will trigger replacement.
String
The name of the restore point collection.
restorePointName
This property is required.
Changes to this property will trigger replacement.
String
The name of the restore point.
expand String
The expand expression to apply on the operation. 'InstanceView' retrieves information about the run-time state of a restore point.

getRestorePoint Result

The following output properties are available:

Id string
Resource Id
InstanceView Pulumi.AzureNative.Compute.Outputs.RestorePointInstanceViewResponse
The restore point instance view.
Name string
Resource name
ProvisioningState string
Gets the provisioning state of the restore point.
Type string
Resource type
ConsistencyMode string
ConsistencyMode of the RestorePoint. Can be specified in the input while creating a restore point. For now, only CrashConsistent is accepted as a valid input. Please refer to https://aka.ms/RestorePoints for more details.
ExcludeDisks List<Pulumi.AzureNative.Compute.Outputs.ApiEntityReferenceResponse>
List of disk resource ids that the customer wishes to exclude from the restore point. If no disks are specified, all disks will be included.
SourceMetadata Pulumi.AzureNative.Compute.Outputs.RestorePointSourceMetadataResponse
Gets the details of the VM captured at the time of the restore point creation.
SourceRestorePoint Pulumi.AzureNative.Compute.Outputs.ApiEntityReferenceResponse
Resource Id of the source restore point from which a copy needs to be created.
TimeCreated string
Gets the creation time of the restore point.
Id string
Resource Id
InstanceView RestorePointInstanceViewResponse
The restore point instance view.
Name string
Resource name
ProvisioningState string
Gets the provisioning state of the restore point.
Type string
Resource type
ConsistencyMode string
ConsistencyMode of the RestorePoint. Can be specified in the input while creating a restore point. For now, only CrashConsistent is accepted as a valid input. Please refer to https://aka.ms/RestorePoints for more details.
ExcludeDisks []ApiEntityReferenceResponse
List of disk resource ids that the customer wishes to exclude from the restore point. If no disks are specified, all disks will be included.
SourceMetadata RestorePointSourceMetadataResponse
Gets the details of the VM captured at the time of the restore point creation.
SourceRestorePoint ApiEntityReferenceResponse
Resource Id of the source restore point from which a copy needs to be created.
TimeCreated string
Gets the creation time of the restore point.
id String
Resource Id
instanceView RestorePointInstanceViewResponse
The restore point instance view.
name String
Resource name
provisioningState String
Gets the provisioning state of the restore point.
type String
Resource type
consistencyMode String
ConsistencyMode of the RestorePoint. Can be specified in the input while creating a restore point. For now, only CrashConsistent is accepted as a valid input. Please refer to https://aka.ms/RestorePoints for more details.
excludeDisks List<ApiEntityReferenceResponse>
List of disk resource ids that the customer wishes to exclude from the restore point. If no disks are specified, all disks will be included.
sourceMetadata RestorePointSourceMetadataResponse
Gets the details of the VM captured at the time of the restore point creation.
sourceRestorePoint ApiEntityReferenceResponse
Resource Id of the source restore point from which a copy needs to be created.
timeCreated String
Gets the creation time of the restore point.
id string
Resource Id
instanceView RestorePointInstanceViewResponse
The restore point instance view.
name string
Resource name
provisioningState string
Gets the provisioning state of the restore point.
type string
Resource type
consistencyMode string
ConsistencyMode of the RestorePoint. Can be specified in the input while creating a restore point. For now, only CrashConsistent is accepted as a valid input. Please refer to https://aka.ms/RestorePoints for more details.
excludeDisks ApiEntityReferenceResponse[]
List of disk resource ids that the customer wishes to exclude from the restore point. If no disks are specified, all disks will be included.
sourceMetadata RestorePointSourceMetadataResponse
Gets the details of the VM captured at the time of the restore point creation.
sourceRestorePoint ApiEntityReferenceResponse
Resource Id of the source restore point from which a copy needs to be created.
timeCreated string
Gets the creation time of the restore point.
id str
Resource Id
instance_view RestorePointInstanceViewResponse
The restore point instance view.
name str
Resource name
provisioning_state str
Gets the provisioning state of the restore point.
type str
Resource type
consistency_mode str
ConsistencyMode of the RestorePoint. Can be specified in the input while creating a restore point. For now, only CrashConsistent is accepted as a valid input. Please refer to https://aka.ms/RestorePoints for more details.
exclude_disks Sequence[ApiEntityReferenceResponse]
List of disk resource ids that the customer wishes to exclude from the restore point. If no disks are specified, all disks will be included.
source_metadata RestorePointSourceMetadataResponse
Gets the details of the VM captured at the time of the restore point creation.
source_restore_point ApiEntityReferenceResponse
Resource Id of the source restore point from which a copy needs to be created.
time_created str
Gets the creation time of the restore point.
id String
Resource Id
instanceView Property Map
The restore point instance view.
name String
Resource name
provisioningState String
Gets the provisioning state of the restore point.
type String
Resource type
consistencyMode String
ConsistencyMode of the RestorePoint. Can be specified in the input while creating a restore point. For now, only CrashConsistent is accepted as a valid input. Please refer to https://aka.ms/RestorePoints for more details.
excludeDisks List<Property Map>
List of disk resource ids that the customer wishes to exclude from the restore point. If no disks are specified, all disks will be included.
sourceMetadata Property Map
Gets the details of the VM captured at the time of the restore point creation.
sourceRestorePoint Property Map
Resource Id of the source restore point from which a copy needs to be created.
timeCreated String
Gets the creation time of the restore point.

Supporting Types

AdditionalUnattendContentResponse

ComponentName string
The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup.
Content string
Specifies the XML formatted content that is added to the unattend.xml file for the specified path and component. The XML must be less than 4KB and must include the root element for the setting or feature that is being inserted.
PassName string
The pass name. Currently, the only allowable value is OobeSystem.
SettingName string
Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon.
ComponentName string
The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup.
Content string
Specifies the XML formatted content that is added to the unattend.xml file for the specified path and component. The XML must be less than 4KB and must include the root element for the setting or feature that is being inserted.
PassName string
The pass name. Currently, the only allowable value is OobeSystem.
SettingName string
Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon.
componentName String
The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup.
content String
Specifies the XML formatted content that is added to the unattend.xml file for the specified path and component. The XML must be less than 4KB and must include the root element for the setting or feature that is being inserted.
passName String
The pass name. Currently, the only allowable value is OobeSystem.
settingName String
Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon.
componentName string
The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup.
content string
Specifies the XML formatted content that is added to the unattend.xml file for the specified path and component. The XML must be less than 4KB and must include the root element for the setting or feature that is being inserted.
passName string
The pass name. Currently, the only allowable value is OobeSystem.
settingName string
Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon.
component_name str
The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup.
content str
Specifies the XML formatted content that is added to the unattend.xml file for the specified path and component. The XML must be less than 4KB and must include the root element for the setting or feature that is being inserted.
pass_name str
The pass name. Currently, the only allowable value is OobeSystem.
setting_name str
Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon.
componentName String
The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup.
content String
Specifies the XML formatted content that is added to the unattend.xml file for the specified path and component. The XML must be less than 4KB and must include the root element for the setting or feature that is being inserted.
passName String
The pass name. Currently, the only allowable value is OobeSystem.
settingName String
Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon.

ApiEntityReferenceResponse

Id string
The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...
Id string
The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...
id String
The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...
id string
The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...
id str
The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...
id String
The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...

BootDiagnosticsResponse

Enabled bool
Whether boot diagnostics should be enabled on the Virtual Machine.
StorageUri string
Uri of the storage account to use for placing the console output and screenshot. If storageUri is not specified while enabling boot diagnostics, managed storage will be used.
Enabled bool
Whether boot diagnostics should be enabled on the Virtual Machine.
StorageUri string
Uri of the storage account to use for placing the console output and screenshot. If storageUri is not specified while enabling boot diagnostics, managed storage will be used.
enabled Boolean
Whether boot diagnostics should be enabled on the Virtual Machine.
storageUri String
Uri of the storage account to use for placing the console output and screenshot. If storageUri is not specified while enabling boot diagnostics, managed storage will be used.
enabled boolean
Whether boot diagnostics should be enabled on the Virtual Machine.
storageUri string
Uri of the storage account to use for placing the console output and screenshot. If storageUri is not specified while enabling boot diagnostics, managed storage will be used.
enabled bool
Whether boot diagnostics should be enabled on the Virtual Machine.
storage_uri str
Uri of the storage account to use for placing the console output and screenshot. If storageUri is not specified while enabling boot diagnostics, managed storage will be used.
enabled Boolean
Whether boot diagnostics should be enabled on the Virtual Machine.
storageUri String
Uri of the storage account to use for placing the console output and screenshot. If storageUri is not specified while enabling boot diagnostics, managed storage will be used.

DiagnosticsProfileResponse

BootDiagnostics Pulumi.AzureNative.Compute.Inputs.BootDiagnosticsResponse
Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. NOTE: If storageUri is being specified then ensure that the storage account is in the same region and subscription as the VM. You can easily view the output of your console log. Azure also enables you to see a screenshot of the VM from the hypervisor.
BootDiagnostics BootDiagnosticsResponse
Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. NOTE: If storageUri is being specified then ensure that the storage account is in the same region and subscription as the VM. You can easily view the output of your console log. Azure also enables you to see a screenshot of the VM from the hypervisor.
bootDiagnostics BootDiagnosticsResponse
Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. NOTE: If storageUri is being specified then ensure that the storage account is in the same region and subscription as the VM. You can easily view the output of your console log. Azure also enables you to see a screenshot of the VM from the hypervisor.
bootDiagnostics BootDiagnosticsResponse
Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. NOTE: If storageUri is being specified then ensure that the storage account is in the same region and subscription as the VM. You can easily view the output of your console log. Azure also enables you to see a screenshot of the VM from the hypervisor.
boot_diagnostics BootDiagnosticsResponse
Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. NOTE: If storageUri is being specified then ensure that the storage account is in the same region and subscription as the VM. You can easily view the output of your console log. Azure also enables you to see a screenshot of the VM from the hypervisor.
bootDiagnostics Property Map
Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. NOTE: If storageUri is being specified then ensure that the storage account is in the same region and subscription as the VM. You can easily view the output of your console log. Azure also enables you to see a screenshot of the VM from the hypervisor.

DiskEncryptionSetParametersResponse

Id string
Resource Id
Id string
Resource Id
id String
Resource Id
id string
Resource Id
id str
Resource Id
id String
Resource Id

DiskEncryptionSettingsResponse

DiskEncryptionKey Pulumi.AzureNative.Compute.Inputs.KeyVaultSecretReferenceResponse
Specifies the location of the disk encryption key, which is a Key Vault Secret.
Enabled bool
Specifies whether disk encryption should be enabled on the virtual machine.
KeyEncryptionKey Pulumi.AzureNative.Compute.Inputs.KeyVaultKeyReferenceResponse
Specifies the location of the key encryption key in Key Vault.
DiskEncryptionKey KeyVaultSecretReferenceResponse
Specifies the location of the disk encryption key, which is a Key Vault Secret.
Enabled bool
Specifies whether disk encryption should be enabled on the virtual machine.
KeyEncryptionKey KeyVaultKeyReferenceResponse
Specifies the location of the key encryption key in Key Vault.
diskEncryptionKey KeyVaultSecretReferenceResponse
Specifies the location of the disk encryption key, which is a Key Vault Secret.
enabled Boolean
Specifies whether disk encryption should be enabled on the virtual machine.
keyEncryptionKey KeyVaultKeyReferenceResponse
Specifies the location of the key encryption key in Key Vault.
diskEncryptionKey KeyVaultSecretReferenceResponse
Specifies the location of the disk encryption key, which is a Key Vault Secret.
enabled boolean
Specifies whether disk encryption should be enabled on the virtual machine.
keyEncryptionKey KeyVaultKeyReferenceResponse
Specifies the location of the key encryption key in Key Vault.
disk_encryption_key KeyVaultSecretReferenceResponse
Specifies the location of the disk encryption key, which is a Key Vault Secret.
enabled bool
Specifies whether disk encryption should be enabled on the virtual machine.
key_encryption_key KeyVaultKeyReferenceResponse
Specifies the location of the key encryption key in Key Vault.
diskEncryptionKey Property Map
Specifies the location of the disk encryption key, which is a Key Vault Secret.
enabled Boolean
Specifies whether disk encryption should be enabled on the virtual machine.
keyEncryptionKey Property Map
Specifies the location of the key encryption key in Key Vault.

DiskRestorePointAttributesResponse

Id This property is required. string
Resource Id
Encryption Pulumi.AzureNative.Compute.Inputs.RestorePointEncryptionResponse
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.
SourceDiskRestorePoint Pulumi.AzureNative.Compute.Inputs.ApiEntityReferenceResponse
Resource Id of the source disk restore point.
Id This property is required. string
Resource Id
Encryption RestorePointEncryptionResponse
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.
SourceDiskRestorePoint ApiEntityReferenceResponse
Resource Id of the source disk restore point.
id This property is required. String
Resource Id
encryption RestorePointEncryptionResponse
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.
sourceDiskRestorePoint ApiEntityReferenceResponse
Resource Id of the source disk restore point.
id This property is required. string
Resource Id
encryption RestorePointEncryptionResponse
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.
sourceDiskRestorePoint ApiEntityReferenceResponse
Resource Id of the source disk restore point.
id This property is required. str
Resource Id
encryption RestorePointEncryptionResponse
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.
source_disk_restore_point ApiEntityReferenceResponse
Resource Id of the source disk restore point.
id This property is required. String
Resource Id
encryption Property Map
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.
sourceDiskRestorePoint Property Map
Resource Id of the source disk restore point.

DiskRestorePointInstanceViewResponse

Id string
Disk restore point Id.
ReplicationStatus Pulumi.AzureNative.Compute.Inputs.DiskRestorePointReplicationStatusResponse
The disk restore point replication status information.
Id string
Disk restore point Id.
ReplicationStatus DiskRestorePointReplicationStatusResponse
The disk restore point replication status information.
id String
Disk restore point Id.
replicationStatus DiskRestorePointReplicationStatusResponse
The disk restore point replication status information.
id string
Disk restore point Id.
replicationStatus DiskRestorePointReplicationStatusResponse
The disk restore point replication status information.
id str
Disk restore point Id.
replication_status DiskRestorePointReplicationStatusResponse
The disk restore point replication status information.
id String
Disk restore point Id.
replicationStatus Property Map
The disk restore point replication status information.

DiskRestorePointReplicationStatusResponse

CompletionPercent int
Replication completion percentage.
Status Pulumi.AzureNative.Compute.Inputs.InstanceViewStatusResponse
The resource status information.
CompletionPercent int
Replication completion percentage.
Status InstanceViewStatusResponse
The resource status information.
completionPercent Integer
Replication completion percentage.
status InstanceViewStatusResponse
The resource status information.
completionPercent number
Replication completion percentage.
status InstanceViewStatusResponse
The resource status information.
completion_percent int
Replication completion percentage.
status InstanceViewStatusResponse
The resource status information.
completionPercent Number
Replication completion percentage.
status Property Map
The resource status information.

HardwareProfileResponse

VmSize string
Specifies the size of the virtual machine. The enum data type is currently deprecated and will be removed by December 23rd 2023. The recommended way to get the list of available sizes is using these APIs: List all available virtual machine sizes in an availability set, List all available virtual machine sizes in a region, List all available virtual machine sizes for resizing. For more information about virtual machine sizes, see Sizes for virtual machines. The available VM sizes depend on region and availability set.
VmSizeProperties Pulumi.AzureNative.Compute.Inputs.VMSizePropertiesResponse
Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-07-01. This feature is still in preview mode and is not supported for VirtualMachineScaleSet. Please follow the instructions in VM Customization for more details.
VmSize string
Specifies the size of the virtual machine. The enum data type is currently deprecated and will be removed by December 23rd 2023. The recommended way to get the list of available sizes is using these APIs: List all available virtual machine sizes in an availability set, List all available virtual machine sizes in a region, List all available virtual machine sizes for resizing. For more information about virtual machine sizes, see Sizes for virtual machines. The available VM sizes depend on region and availability set.
VmSizeProperties VMSizePropertiesResponse
Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-07-01. This feature is still in preview mode and is not supported for VirtualMachineScaleSet. Please follow the instructions in VM Customization for more details.
vmSize String
Specifies the size of the virtual machine. The enum data type is currently deprecated and will be removed by December 23rd 2023. The recommended way to get the list of available sizes is using these APIs: List all available virtual machine sizes in an availability set, List all available virtual machine sizes in a region, List all available virtual machine sizes for resizing. For more information about virtual machine sizes, see Sizes for virtual machines. The available VM sizes depend on region and availability set.
vmSizeProperties VMSizePropertiesResponse
Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-07-01. This feature is still in preview mode and is not supported for VirtualMachineScaleSet. Please follow the instructions in VM Customization for more details.
vmSize string
Specifies the size of the virtual machine. The enum data type is currently deprecated and will be removed by December 23rd 2023. The recommended way to get the list of available sizes is using these APIs: List all available virtual machine sizes in an availability set, List all available virtual machine sizes in a region, List all available virtual machine sizes for resizing. For more information about virtual machine sizes, see Sizes for virtual machines. The available VM sizes depend on region and availability set.
vmSizeProperties VMSizePropertiesResponse
Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-07-01. This feature is still in preview mode and is not supported for VirtualMachineScaleSet. Please follow the instructions in VM Customization for more details.
vm_size str
Specifies the size of the virtual machine. The enum data type is currently deprecated and will be removed by December 23rd 2023. The recommended way to get the list of available sizes is using these APIs: List all available virtual machine sizes in an availability set, List all available virtual machine sizes in a region, List all available virtual machine sizes for resizing. For more information about virtual machine sizes, see Sizes for virtual machines. The available VM sizes depend on region and availability set.
vm_size_properties VMSizePropertiesResponse
Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-07-01. This feature is still in preview mode and is not supported for VirtualMachineScaleSet. Please follow the instructions in VM Customization for more details.
vmSize String
Specifies the size of the virtual machine. The enum data type is currently deprecated and will be removed by December 23rd 2023. The recommended way to get the list of available sizes is using these APIs: List all available virtual machine sizes in an availability set, List all available virtual machine sizes in a region, List all available virtual machine sizes for resizing. For more information about virtual machine sizes, see Sizes for virtual machines. The available VM sizes depend on region and availability set.
vmSizeProperties Property Map
Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-07-01. This feature is still in preview mode and is not supported for VirtualMachineScaleSet. Please follow the instructions in VM Customization for more details.

InstanceViewStatusResponse

Code string
The status code.
DisplayStatus string
The short localizable label for the status.
Level string
The level code.
Message string
The detailed status message, including for alerts and error messages.
Time string
The time of the status.
Code string
The status code.
DisplayStatus string
The short localizable label for the status.
Level string
The level code.
Message string
The detailed status message, including for alerts and error messages.
Time string
The time of the status.
code String
The status code.
displayStatus String
The short localizable label for the status.
level String
The level code.
message String
The detailed status message, including for alerts and error messages.
time String
The time of the status.
code string
The status code.
displayStatus string
The short localizable label for the status.
level string
The level code.
message string
The detailed status message, including for alerts and error messages.
time string
The time of the status.
code str
The status code.
display_status str
The short localizable label for the status.
level str
The level code.
message str
The detailed status message, including for alerts and error messages.
time str
The time of the status.
code String
The status code.
displayStatus String
The short localizable label for the status.
level String
The level code.
message String
The detailed status message, including for alerts and error messages.
time String
The time of the status.

KeyVaultKeyReferenceResponse

KeyUrl This property is required. string
The URL referencing a key encryption key in Key Vault.
SourceVault This property is required. Pulumi.AzureNative.Compute.Inputs.SubResourceResponse
The relative URL of the Key Vault containing the key.
KeyUrl This property is required. string
The URL referencing a key encryption key in Key Vault.
SourceVault This property is required. SubResourceResponse
The relative URL of the Key Vault containing the key.
keyUrl This property is required. String
The URL referencing a key encryption key in Key Vault.
sourceVault This property is required. SubResourceResponse
The relative URL of the Key Vault containing the key.
keyUrl This property is required. string
The URL referencing a key encryption key in Key Vault.
sourceVault This property is required. SubResourceResponse
The relative URL of the Key Vault containing the key.
key_url This property is required. str
The URL referencing a key encryption key in Key Vault.
source_vault This property is required. SubResourceResponse
The relative URL of the Key Vault containing the key.
keyUrl This property is required. String
The URL referencing a key encryption key in Key Vault.
sourceVault This property is required. Property Map
The relative URL of the Key Vault containing the key.

KeyVaultSecretReferenceResponse

SecretUrl This property is required. string
The URL referencing a secret in a Key Vault.
SourceVault This property is required. Pulumi.AzureNative.Compute.Inputs.SubResourceResponse
The relative URL of the Key Vault containing the secret.
SecretUrl This property is required. string
The URL referencing a secret in a Key Vault.
SourceVault This property is required. SubResourceResponse
The relative URL of the Key Vault containing the secret.
secretUrl This property is required. String
The URL referencing a secret in a Key Vault.
sourceVault This property is required. SubResourceResponse
The relative URL of the Key Vault containing the secret.
secretUrl This property is required. string
The URL referencing a secret in a Key Vault.
sourceVault This property is required. SubResourceResponse
The relative URL of the Key Vault containing the secret.
secret_url This property is required. str
The URL referencing a secret in a Key Vault.
source_vault This property is required. SubResourceResponse
The relative URL of the Key Vault containing the secret.
secretUrl This property is required. String
The URL referencing a secret in a Key Vault.
sourceVault This property is required. Property Map
The relative URL of the Key Vault containing the secret.

LinuxConfigurationResponse

DisablePasswordAuthentication bool
Specifies whether password authentication should be disabled.
EnableVMAgentPlatformUpdates bool
Indicates whether VMAgent Platform Updates is enabled for the Linux virtual machine. Default value is false.
PatchSettings Pulumi.AzureNative.Compute.Inputs.LinuxPatchSettingsResponse
[Preview Feature] Specifies settings related to VM Guest Patching on Linux.
ProvisionVMAgent bool
Indicates whether virtual machine agent should be provisioned on the virtual machine. When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later.
Ssh Pulumi.AzureNative.Compute.Inputs.SshConfigurationResponse
Specifies the ssh key configuration for a Linux OS.
DisablePasswordAuthentication bool
Specifies whether password authentication should be disabled.
EnableVMAgentPlatformUpdates bool
Indicates whether VMAgent Platform Updates is enabled for the Linux virtual machine. Default value is false.
PatchSettings LinuxPatchSettingsResponse
[Preview Feature] Specifies settings related to VM Guest Patching on Linux.
ProvisionVMAgent bool
Indicates whether virtual machine agent should be provisioned on the virtual machine. When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later.
Ssh SshConfigurationResponse
Specifies the ssh key configuration for a Linux OS.
disablePasswordAuthentication Boolean
Specifies whether password authentication should be disabled.
enableVMAgentPlatformUpdates Boolean
Indicates whether VMAgent Platform Updates is enabled for the Linux virtual machine. Default value is false.
patchSettings LinuxPatchSettingsResponse
[Preview Feature] Specifies settings related to VM Guest Patching on Linux.
provisionVMAgent Boolean
Indicates whether virtual machine agent should be provisioned on the virtual machine. When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later.
ssh SshConfigurationResponse
Specifies the ssh key configuration for a Linux OS.
disablePasswordAuthentication boolean
Specifies whether password authentication should be disabled.
enableVMAgentPlatformUpdates boolean
Indicates whether VMAgent Platform Updates is enabled for the Linux virtual machine. Default value is false.
patchSettings LinuxPatchSettingsResponse
[Preview Feature] Specifies settings related to VM Guest Patching on Linux.
provisionVMAgent boolean
Indicates whether virtual machine agent should be provisioned on the virtual machine. When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later.
ssh SshConfigurationResponse
Specifies the ssh key configuration for a Linux OS.
disable_password_authentication bool
Specifies whether password authentication should be disabled.
enable_vm_agent_platform_updates bool
Indicates whether VMAgent Platform Updates is enabled for the Linux virtual machine. Default value is false.
patch_settings LinuxPatchSettingsResponse
[Preview Feature] Specifies settings related to VM Guest Patching on Linux.
provision_vm_agent bool
Indicates whether virtual machine agent should be provisioned on the virtual machine. When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later.
ssh SshConfigurationResponse
Specifies the ssh key configuration for a Linux OS.
disablePasswordAuthentication Boolean
Specifies whether password authentication should be disabled.
enableVMAgentPlatformUpdates Boolean
Indicates whether VMAgent Platform Updates is enabled for the Linux virtual machine. Default value is false.
patchSettings Property Map
[Preview Feature] Specifies settings related to VM Guest Patching on Linux.
provisionVMAgent Boolean
Indicates whether virtual machine agent should be provisioned on the virtual machine. When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later.
ssh Property Map
Specifies the ssh key configuration for a Linux OS.

LinuxPatchSettingsResponse

AssessmentMode string
Specifies the mode of VM Guest Patch Assessment for the IaaS virtual machine. Possible values are: ImageDefault - You control the timing of patch assessments on a virtual machine. AutomaticByPlatform - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true.
AutomaticByPlatformSettings Pulumi.AzureNative.Compute.Inputs.LinuxVMGuestPatchAutomaticByPlatformSettingsResponse
Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Linux.
PatchMode string
Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible. Possible values are: ImageDefault - The virtual machine's default patching configuration is used. AutomaticByPlatform - The virtual machine will be automatically updated by the platform. The property provisionVMAgent must be true
AssessmentMode string
Specifies the mode of VM Guest Patch Assessment for the IaaS virtual machine. Possible values are: ImageDefault - You control the timing of patch assessments on a virtual machine. AutomaticByPlatform - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true.
AutomaticByPlatformSettings LinuxVMGuestPatchAutomaticByPlatformSettingsResponse
Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Linux.
PatchMode string
Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible. Possible values are: ImageDefault - The virtual machine's default patching configuration is used. AutomaticByPlatform - The virtual machine will be automatically updated by the platform. The property provisionVMAgent must be true
assessmentMode String
Specifies the mode of VM Guest Patch Assessment for the IaaS virtual machine. Possible values are: ImageDefault - You control the timing of patch assessments on a virtual machine. AutomaticByPlatform - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true.
automaticByPlatformSettings LinuxVMGuestPatchAutomaticByPlatformSettingsResponse
Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Linux.
patchMode String
Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible. Possible values are: ImageDefault - The virtual machine's default patching configuration is used. AutomaticByPlatform - The virtual machine will be automatically updated by the platform. The property provisionVMAgent must be true
assessmentMode string
Specifies the mode of VM Guest Patch Assessment for the IaaS virtual machine. Possible values are: ImageDefault - You control the timing of patch assessments on a virtual machine. AutomaticByPlatform - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true.
automaticByPlatformSettings LinuxVMGuestPatchAutomaticByPlatformSettingsResponse
Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Linux.
patchMode string
Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible. Possible values are: ImageDefault - The virtual machine's default patching configuration is used. AutomaticByPlatform - The virtual machine will be automatically updated by the platform. The property provisionVMAgent must be true
assessment_mode str
Specifies the mode of VM Guest Patch Assessment for the IaaS virtual machine. Possible values are: ImageDefault - You control the timing of patch assessments on a virtual machine. AutomaticByPlatform - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true.
automatic_by_platform_settings LinuxVMGuestPatchAutomaticByPlatformSettingsResponse
Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Linux.
patch_mode str
Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible. Possible values are: ImageDefault - The virtual machine's default patching configuration is used. AutomaticByPlatform - The virtual machine will be automatically updated by the platform. The property provisionVMAgent must be true
assessmentMode String
Specifies the mode of VM Guest Patch Assessment for the IaaS virtual machine. Possible values are: ImageDefault - You control the timing of patch assessments on a virtual machine. AutomaticByPlatform - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true.
automaticByPlatformSettings Property Map
Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Linux.
patchMode String
Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible. Possible values are: ImageDefault - The virtual machine's default patching configuration is used. AutomaticByPlatform - The virtual machine will be automatically updated by the platform. The property provisionVMAgent must be true

LinuxVMGuestPatchAutomaticByPlatformSettingsResponse

BypassPlatformSafetyChecksOnUserSchedule bool
Enables customer to schedule patching without accidental upgrades
RebootSetting string
Specifies the reboot setting for all AutomaticByPlatform patch installation operations.
BypassPlatformSafetyChecksOnUserSchedule bool
Enables customer to schedule patching without accidental upgrades
RebootSetting string
Specifies the reboot setting for all AutomaticByPlatform patch installation operations.
bypassPlatformSafetyChecksOnUserSchedule Boolean
Enables customer to schedule patching without accidental upgrades
rebootSetting String
Specifies the reboot setting for all AutomaticByPlatform patch installation operations.
bypassPlatformSafetyChecksOnUserSchedule boolean
Enables customer to schedule patching without accidental upgrades
rebootSetting string
Specifies the reboot setting for all AutomaticByPlatform patch installation operations.
bypass_platform_safety_checks_on_user_schedule bool
Enables customer to schedule patching without accidental upgrades
reboot_setting str
Specifies the reboot setting for all AutomaticByPlatform patch installation operations.
bypassPlatformSafetyChecksOnUserSchedule Boolean
Enables customer to schedule patching without accidental upgrades
rebootSetting String
Specifies the reboot setting for all AutomaticByPlatform patch installation operations.

ManagedDiskParametersResponse

DiskEncryptionSet Pulumi.AzureNative.Compute.Inputs.DiskEncryptionSetParametersResponse
Specifies the customer managed disk encryption set resource id for the managed disk.
Id string
Resource Id
SecurityProfile Pulumi.AzureNative.Compute.Inputs.VMDiskSecurityProfileResponse
Specifies the security profile for the managed disk.
StorageAccountType string
Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk.
DiskEncryptionSet DiskEncryptionSetParametersResponse
Specifies the customer managed disk encryption set resource id for the managed disk.
Id string
Resource Id
SecurityProfile VMDiskSecurityProfileResponse
Specifies the security profile for the managed disk.
StorageAccountType string
Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk.
diskEncryptionSet DiskEncryptionSetParametersResponse
Specifies the customer managed disk encryption set resource id for the managed disk.
id String
Resource Id
securityProfile VMDiskSecurityProfileResponse
Specifies the security profile for the managed disk.
storageAccountType String
Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk.
diskEncryptionSet DiskEncryptionSetParametersResponse
Specifies the customer managed disk encryption set resource id for the managed disk.
id string
Resource Id
securityProfile VMDiskSecurityProfileResponse
Specifies the security profile for the managed disk.
storageAccountType string
Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk.
disk_encryption_set DiskEncryptionSetParametersResponse
Specifies the customer managed disk encryption set resource id for the managed disk.
id str
Resource Id
security_profile VMDiskSecurityProfileResponse
Specifies the security profile for the managed disk.
storage_account_type str
Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk.
diskEncryptionSet Property Map
Specifies the customer managed disk encryption set resource id for the managed disk.
id String
Resource Id
securityProfile Property Map
Specifies the security profile for the managed disk.
storageAccountType String
Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk.

OSProfileResponse

AdminPassword string
Specifies the password of the administrator account. Minimum-length (Windows): 8 characters Minimum-length (Linux): 6 characters Max-length (Windows): 123 characters Max-length (Linux): 72 characters Complexity requirements: 3 out of 4 conditions below need to be fulfilled Has lower characters Has upper characters Has a digit Has a special character (Regex match [\W_]) **Disallowed values:** "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!" For resetting the password, see How to reset the Remote Desktop service or its login password in a Windows VM For resetting root password, see Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension
AdminUsername string
Specifies the name of the administrator account. This property cannot be updated after the VM is created. Windows-only restriction: Cannot end in "." Disallowed values: "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5". Minimum-length (Linux): 1 character Max-length (Linux): 64 characters Max-length (Windows): 20 characters.
AllowExtensionOperations bool
Specifies whether extension operations should be allowed on the virtual machine. This may only be set to False when no extensions are present on the virtual machine.
ComputerName string
Specifies the host OS name of the virtual machine. This name cannot be updated after the VM is created. Max-length (Windows): 15 characters. Max-length (Linux): 64 characters. For naming conventions and restrictions see Azure infrastructure services implementation guidelines.
CustomData string
Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes. Note: Do not pass any secrets or passwords in customData property. This property cannot be updated after the VM is created. The property 'customData' is passed to the VM to be saved as a file, for more information see Custom Data on Azure VMs. For using cloud-init for your Linux VM, see Using cloud-init to customize a Linux VM during creation.
LinuxConfiguration Pulumi.AzureNative.Compute.Inputs.LinuxConfigurationResponse
Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see Linux on Azure-Endorsed Distributions.
RequireGuestProvisionSignal bool
Optional property which must either be set to True or omitted.
Secrets List<Pulumi.AzureNative.Compute.Inputs.VaultSecretGroupResponse>
Specifies set of certificates that should be installed onto the virtual machine. To install certificates on a virtual machine it is recommended to use the Azure Key Vault virtual machine extension for Linux or the Azure Key Vault virtual machine extension for Windows.
WindowsConfiguration Pulumi.AzureNative.Compute.Inputs.WindowsConfigurationResponse
Specifies Windows operating system settings on the virtual machine.
AdminPassword string
Specifies the password of the administrator account. Minimum-length (Windows): 8 characters Minimum-length (Linux): 6 characters Max-length (Windows): 123 characters Max-length (Linux): 72 characters Complexity requirements: 3 out of 4 conditions below need to be fulfilled Has lower characters Has upper characters Has a digit Has a special character (Regex match [\W_]) **Disallowed values:** "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!" For resetting the password, see How to reset the Remote Desktop service or its login password in a Windows VM For resetting root password, see Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension
AdminUsername string
Specifies the name of the administrator account. This property cannot be updated after the VM is created. Windows-only restriction: Cannot end in "." Disallowed values: "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5". Minimum-length (Linux): 1 character Max-length (Linux): 64 characters Max-length (Windows): 20 characters.
AllowExtensionOperations bool
Specifies whether extension operations should be allowed on the virtual machine. This may only be set to False when no extensions are present on the virtual machine.
ComputerName string
Specifies the host OS name of the virtual machine. This name cannot be updated after the VM is created. Max-length (Windows): 15 characters. Max-length (Linux): 64 characters. For naming conventions and restrictions see Azure infrastructure services implementation guidelines.
CustomData string
Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes. Note: Do not pass any secrets or passwords in customData property. This property cannot be updated after the VM is created. The property 'customData' is passed to the VM to be saved as a file, for more information see Custom Data on Azure VMs. For using cloud-init for your Linux VM, see Using cloud-init to customize a Linux VM during creation.
LinuxConfiguration LinuxConfigurationResponse
Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see Linux on Azure-Endorsed Distributions.
RequireGuestProvisionSignal bool
Optional property which must either be set to True or omitted.
Secrets []VaultSecretGroupResponse
Specifies set of certificates that should be installed onto the virtual machine. To install certificates on a virtual machine it is recommended to use the Azure Key Vault virtual machine extension for Linux or the Azure Key Vault virtual machine extension for Windows.
WindowsConfiguration WindowsConfigurationResponse
Specifies Windows operating system settings on the virtual machine.
adminPassword String
Specifies the password of the administrator account. Minimum-length (Windows): 8 characters Minimum-length (Linux): 6 characters Max-length (Windows): 123 characters Max-length (Linux): 72 characters Complexity requirements: 3 out of 4 conditions below need to be fulfilled Has lower characters Has upper characters Has a digit Has a special character (Regex match [\W_]) **Disallowed values:** "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!" For resetting the password, see How to reset the Remote Desktop service or its login password in a Windows VM For resetting root password, see Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension
adminUsername String
Specifies the name of the administrator account. This property cannot be updated after the VM is created. Windows-only restriction: Cannot end in "." Disallowed values: "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5". Minimum-length (Linux): 1 character Max-length (Linux): 64 characters Max-length (Windows): 20 characters.
allowExtensionOperations Boolean
Specifies whether extension operations should be allowed on the virtual machine. This may only be set to False when no extensions are present on the virtual machine.
computerName String
Specifies the host OS name of the virtual machine. This name cannot be updated after the VM is created. Max-length (Windows): 15 characters. Max-length (Linux): 64 characters. For naming conventions and restrictions see Azure infrastructure services implementation guidelines.
customData String
Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes. Note: Do not pass any secrets or passwords in customData property. This property cannot be updated after the VM is created. The property 'customData' is passed to the VM to be saved as a file, for more information see Custom Data on Azure VMs. For using cloud-init for your Linux VM, see Using cloud-init to customize a Linux VM during creation.
linuxConfiguration LinuxConfigurationResponse
Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see Linux on Azure-Endorsed Distributions.
requireGuestProvisionSignal Boolean
Optional property which must either be set to True or omitted.
secrets List<VaultSecretGroupResponse>
Specifies set of certificates that should be installed onto the virtual machine. To install certificates on a virtual machine it is recommended to use the Azure Key Vault virtual machine extension for Linux or the Azure Key Vault virtual machine extension for Windows.
windowsConfiguration WindowsConfigurationResponse
Specifies Windows operating system settings on the virtual machine.
adminPassword string
Specifies the password of the administrator account. Minimum-length (Windows): 8 characters Minimum-length (Linux): 6 characters Max-length (Windows): 123 characters Max-length (Linux): 72 characters Complexity requirements: 3 out of 4 conditions below need to be fulfilled Has lower characters Has upper characters Has a digit Has a special character (Regex match [\W_]) **Disallowed values:** "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!" For resetting the password, see How to reset the Remote Desktop service or its login password in a Windows VM For resetting root password, see Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension
adminUsername string
Specifies the name of the administrator account. This property cannot be updated after the VM is created. Windows-only restriction: Cannot end in "." Disallowed values: "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5". Minimum-length (Linux): 1 character Max-length (Linux): 64 characters Max-length (Windows): 20 characters.
allowExtensionOperations boolean
Specifies whether extension operations should be allowed on the virtual machine. This may only be set to False when no extensions are present on the virtual machine.
computerName string
Specifies the host OS name of the virtual machine. This name cannot be updated after the VM is created. Max-length (Windows): 15 characters. Max-length (Linux): 64 characters. For naming conventions and restrictions see Azure infrastructure services implementation guidelines.
customData string
Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes. Note: Do not pass any secrets or passwords in customData property. This property cannot be updated after the VM is created. The property 'customData' is passed to the VM to be saved as a file, for more information see Custom Data on Azure VMs. For using cloud-init for your Linux VM, see Using cloud-init to customize a Linux VM during creation.
linuxConfiguration LinuxConfigurationResponse
Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see Linux on Azure-Endorsed Distributions.
requireGuestProvisionSignal boolean
Optional property which must either be set to True or omitted.
secrets VaultSecretGroupResponse[]
Specifies set of certificates that should be installed onto the virtual machine. To install certificates on a virtual machine it is recommended to use the Azure Key Vault virtual machine extension for Linux or the Azure Key Vault virtual machine extension for Windows.
windowsConfiguration WindowsConfigurationResponse
Specifies Windows operating system settings on the virtual machine.
admin_password str
Specifies the password of the administrator account. Minimum-length (Windows): 8 characters Minimum-length (Linux): 6 characters Max-length (Windows): 123 characters Max-length (Linux): 72 characters Complexity requirements: 3 out of 4 conditions below need to be fulfilled Has lower characters Has upper characters Has a digit Has a special character (Regex match [\W_]) **Disallowed values:** "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!" For resetting the password, see How to reset the Remote Desktop service or its login password in a Windows VM For resetting root password, see Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension
admin_username str
Specifies the name of the administrator account. This property cannot be updated after the VM is created. Windows-only restriction: Cannot end in "." Disallowed values: "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5". Minimum-length (Linux): 1 character Max-length (Linux): 64 characters Max-length (Windows): 20 characters.
allow_extension_operations bool
Specifies whether extension operations should be allowed on the virtual machine. This may only be set to False when no extensions are present on the virtual machine.
computer_name str
Specifies the host OS name of the virtual machine. This name cannot be updated after the VM is created. Max-length (Windows): 15 characters. Max-length (Linux): 64 characters. For naming conventions and restrictions see Azure infrastructure services implementation guidelines.
custom_data str
Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes. Note: Do not pass any secrets or passwords in customData property. This property cannot be updated after the VM is created. The property 'customData' is passed to the VM to be saved as a file, for more information see Custom Data on Azure VMs. For using cloud-init for your Linux VM, see Using cloud-init to customize a Linux VM during creation.
linux_configuration LinuxConfigurationResponse
Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see Linux on Azure-Endorsed Distributions.
require_guest_provision_signal bool
Optional property which must either be set to True or omitted.
secrets Sequence[VaultSecretGroupResponse]
Specifies set of certificates that should be installed onto the virtual machine. To install certificates on a virtual machine it is recommended to use the Azure Key Vault virtual machine extension for Linux or the Azure Key Vault virtual machine extension for Windows.
windows_configuration WindowsConfigurationResponse
Specifies Windows operating system settings on the virtual machine.
adminPassword String
Specifies the password of the administrator account. Minimum-length (Windows): 8 characters Minimum-length (Linux): 6 characters Max-length (Windows): 123 characters Max-length (Linux): 72 characters Complexity requirements: 3 out of 4 conditions below need to be fulfilled Has lower characters Has upper characters Has a digit Has a special character (Regex match [\W_]) **Disallowed values:** "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!" For resetting the password, see How to reset the Remote Desktop service or its login password in a Windows VM For resetting root password, see Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension
adminUsername String
Specifies the name of the administrator account. This property cannot be updated after the VM is created. Windows-only restriction: Cannot end in "." Disallowed values: "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5". Minimum-length (Linux): 1 character Max-length (Linux): 64 characters Max-length (Windows): 20 characters.
allowExtensionOperations Boolean
Specifies whether extension operations should be allowed on the virtual machine. This may only be set to False when no extensions are present on the virtual machine.
computerName String
Specifies the host OS name of the virtual machine. This name cannot be updated after the VM is created. Max-length (Windows): 15 characters. Max-length (Linux): 64 characters. For naming conventions and restrictions see Azure infrastructure services implementation guidelines.
customData String
Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes. Note: Do not pass any secrets or passwords in customData property. This property cannot be updated after the VM is created. The property 'customData' is passed to the VM to be saved as a file, for more information see Custom Data on Azure VMs. For using cloud-init for your Linux VM, see Using cloud-init to customize a Linux VM during creation.
linuxConfiguration Property Map
Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see Linux on Azure-Endorsed Distributions.
requireGuestProvisionSignal Boolean
Optional property which must either be set to True or omitted.
secrets List<Property Map>
Specifies set of certificates that should be installed onto the virtual machine. To install certificates on a virtual machine it is recommended to use the Azure Key Vault virtual machine extension for Linux or the Azure Key Vault virtual machine extension for Windows.
windowsConfiguration Property Map
Specifies Windows operating system settings on the virtual machine.

PatchSettingsResponse

AssessmentMode string
Specifies the mode of VM Guest patch assessment for the IaaS virtual machine. Possible values are: ImageDefault - You control the timing of patch assessments on a virtual machine. AutomaticByPlatform - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true.
AutomaticByPlatformSettings Pulumi.AzureNative.Compute.Inputs.WindowsVMGuestPatchAutomaticByPlatformSettingsResponse
Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Windows.
EnableHotpatching bool
Enables customers to patch their Azure VMs without requiring a reboot. For enableHotpatching, the 'provisionVMAgent' must be set to true and 'patchMode' must be set to 'AutomaticByPlatform'.
PatchMode string
Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible. Possible values are: Manual - You control the application of patches to a virtual machine. You do this by applying patches manually inside the VM. In this mode, automatic updates are disabled; the property WindowsConfiguration.enableAutomaticUpdates must be false AutomaticByOS - The virtual machine will automatically be updated by the OS. The property WindowsConfiguration.enableAutomaticUpdates must be true. AutomaticByPlatform - the virtual machine will automatically updated by the platform. The properties provisionVMAgent and WindowsConfiguration.enableAutomaticUpdates must be true
AssessmentMode string
Specifies the mode of VM Guest patch assessment for the IaaS virtual machine. Possible values are: ImageDefault - You control the timing of patch assessments on a virtual machine. AutomaticByPlatform - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true.
AutomaticByPlatformSettings WindowsVMGuestPatchAutomaticByPlatformSettingsResponse
Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Windows.
EnableHotpatching bool
Enables customers to patch their Azure VMs without requiring a reboot. For enableHotpatching, the 'provisionVMAgent' must be set to true and 'patchMode' must be set to 'AutomaticByPlatform'.
PatchMode string
Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible. Possible values are: Manual - You control the application of patches to a virtual machine. You do this by applying patches manually inside the VM. In this mode, automatic updates are disabled; the property WindowsConfiguration.enableAutomaticUpdates must be false AutomaticByOS - The virtual machine will automatically be updated by the OS. The property WindowsConfiguration.enableAutomaticUpdates must be true. AutomaticByPlatform - the virtual machine will automatically updated by the platform. The properties provisionVMAgent and WindowsConfiguration.enableAutomaticUpdates must be true
assessmentMode String
Specifies the mode of VM Guest patch assessment for the IaaS virtual machine. Possible values are: ImageDefault - You control the timing of patch assessments on a virtual machine. AutomaticByPlatform - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true.
automaticByPlatformSettings WindowsVMGuestPatchAutomaticByPlatformSettingsResponse
Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Windows.
enableHotpatching Boolean
Enables customers to patch their Azure VMs without requiring a reboot. For enableHotpatching, the 'provisionVMAgent' must be set to true and 'patchMode' must be set to 'AutomaticByPlatform'.
patchMode String
Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible. Possible values are: Manual - You control the application of patches to a virtual machine. You do this by applying patches manually inside the VM. In this mode, automatic updates are disabled; the property WindowsConfiguration.enableAutomaticUpdates must be false AutomaticByOS - The virtual machine will automatically be updated by the OS. The property WindowsConfiguration.enableAutomaticUpdates must be true. AutomaticByPlatform - the virtual machine will automatically updated by the platform. The properties provisionVMAgent and WindowsConfiguration.enableAutomaticUpdates must be true
assessmentMode string
Specifies the mode of VM Guest patch assessment for the IaaS virtual machine. Possible values are: ImageDefault - You control the timing of patch assessments on a virtual machine. AutomaticByPlatform - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true.
automaticByPlatformSettings WindowsVMGuestPatchAutomaticByPlatformSettingsResponse
Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Windows.
enableHotpatching boolean
Enables customers to patch their Azure VMs without requiring a reboot. For enableHotpatching, the 'provisionVMAgent' must be set to true and 'patchMode' must be set to 'AutomaticByPlatform'.
patchMode string
Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible. Possible values are: Manual - You control the application of patches to a virtual machine. You do this by applying patches manually inside the VM. In this mode, automatic updates are disabled; the property WindowsConfiguration.enableAutomaticUpdates must be false AutomaticByOS - The virtual machine will automatically be updated by the OS. The property WindowsConfiguration.enableAutomaticUpdates must be true. AutomaticByPlatform - the virtual machine will automatically updated by the platform. The properties provisionVMAgent and WindowsConfiguration.enableAutomaticUpdates must be true
assessment_mode str
Specifies the mode of VM Guest patch assessment for the IaaS virtual machine. Possible values are: ImageDefault - You control the timing of patch assessments on a virtual machine. AutomaticByPlatform - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true.
automatic_by_platform_settings WindowsVMGuestPatchAutomaticByPlatformSettingsResponse
Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Windows.
enable_hotpatching bool
Enables customers to patch their Azure VMs without requiring a reboot. For enableHotpatching, the 'provisionVMAgent' must be set to true and 'patchMode' must be set to 'AutomaticByPlatform'.
patch_mode str
Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible. Possible values are: Manual - You control the application of patches to a virtual machine. You do this by applying patches manually inside the VM. In this mode, automatic updates are disabled; the property WindowsConfiguration.enableAutomaticUpdates must be false AutomaticByOS - The virtual machine will automatically be updated by the OS. The property WindowsConfiguration.enableAutomaticUpdates must be true. AutomaticByPlatform - the virtual machine will automatically updated by the platform. The properties provisionVMAgent and WindowsConfiguration.enableAutomaticUpdates must be true
assessmentMode String
Specifies the mode of VM Guest patch assessment for the IaaS virtual machine. Possible values are: ImageDefault - You control the timing of patch assessments on a virtual machine. AutomaticByPlatform - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true.
automaticByPlatformSettings Property Map
Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Windows.
enableHotpatching Boolean
Enables customers to patch their Azure VMs without requiring a reboot. For enableHotpatching, the 'provisionVMAgent' must be set to true and 'patchMode' must be set to 'AutomaticByPlatform'.
patchMode String
Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible. Possible values are: Manual - You control the application of patches to a virtual machine. You do this by applying patches manually inside the VM. In this mode, automatic updates are disabled; the property WindowsConfiguration.enableAutomaticUpdates must be false AutomaticByOS - The virtual machine will automatically be updated by the OS. The property WindowsConfiguration.enableAutomaticUpdates must be true. AutomaticByPlatform - the virtual machine will automatically updated by the platform. The properties provisionVMAgent and WindowsConfiguration.enableAutomaticUpdates must be true

RestorePointEncryptionResponse

DiskEncryptionSet Pulumi.AzureNative.Compute.Inputs.DiskEncryptionSetParametersResponse
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.
Type string
The type of key used to encrypt the data of the disk restore point.
DiskEncryptionSet DiskEncryptionSetParametersResponse
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.
Type string
The type of key used to encrypt the data of the disk restore point.
diskEncryptionSet DiskEncryptionSetParametersResponse
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.
type String
The type of key used to encrypt the data of the disk restore point.
diskEncryptionSet DiskEncryptionSetParametersResponse
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.
type string
The type of key used to encrypt the data of the disk restore point.
disk_encryption_set DiskEncryptionSetParametersResponse
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.
type str
The type of key used to encrypt the data of the disk restore point.
diskEncryptionSet Property Map
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.
type String
The type of key used to encrypt the data of the disk restore point.

RestorePointInstanceViewResponse

DiskRestorePoints []DiskRestorePointInstanceViewResponse
The disk restore points information.
Statuses []InstanceViewStatusResponse
The resource status information.
diskRestorePoints List<DiskRestorePointInstanceViewResponse>
The disk restore points information.
statuses List<InstanceViewStatusResponse>
The resource status information.
diskRestorePoints DiskRestorePointInstanceViewResponse[]
The disk restore points information.
statuses InstanceViewStatusResponse[]
The resource status information.
diskRestorePoints List<Property Map>
The disk restore points information.
statuses List<Property Map>
The resource status information.

RestorePointSourceMetadataResponse

DiagnosticsProfile This property is required. Pulumi.AzureNative.Compute.Inputs.DiagnosticsProfileResponse
Gets the diagnostics profile.
HardwareProfile This property is required. Pulumi.AzureNative.Compute.Inputs.HardwareProfileResponse
Gets the hardware profile.
HyperVGeneration This property is required. string
HyperVGeneration of the source VM for which restore point is captured.
LicenseType This property is required. string
Gets the license type, which is for bring your own license scenario.
Location This property is required. string
Location of the VM from which the restore point was created.
OsProfile This property is required. Pulumi.AzureNative.Compute.Inputs.OSProfileResponse
Gets the OS profile.
SecurityProfile This property is required. Pulumi.AzureNative.Compute.Inputs.SecurityProfileResponse
Gets the security profile.
UserData This property is required. string
UserData associated with the source VM for which restore point is captured, which is a base-64 encoded value.
VmId This property is required. string
Gets the virtual machine unique id.
StorageProfile Pulumi.AzureNative.Compute.Inputs.RestorePointSourceVMStorageProfileResponse
Gets the storage profile.
DiagnosticsProfile This property is required. DiagnosticsProfileResponse
Gets the diagnostics profile.
HardwareProfile This property is required. HardwareProfileResponse
Gets the hardware profile.
HyperVGeneration This property is required. string
HyperVGeneration of the source VM for which restore point is captured.
LicenseType This property is required. string
Gets the license type, which is for bring your own license scenario.
Location This property is required. string
Location of the VM from which the restore point was created.
OsProfile This property is required. OSProfileResponse
Gets the OS profile.
SecurityProfile This property is required. SecurityProfileResponse
Gets the security profile.
UserData This property is required. string
UserData associated with the source VM for which restore point is captured, which is a base-64 encoded value.
VmId This property is required. string
Gets the virtual machine unique id.
StorageProfile RestorePointSourceVMStorageProfileResponse
Gets the storage profile.
diagnosticsProfile This property is required. DiagnosticsProfileResponse
Gets the diagnostics profile.
hardwareProfile This property is required. HardwareProfileResponse
Gets the hardware profile.
hyperVGeneration This property is required. String
HyperVGeneration of the source VM for which restore point is captured.
licenseType This property is required. String
Gets the license type, which is for bring your own license scenario.
location This property is required. String
Location of the VM from which the restore point was created.
osProfile This property is required. OSProfileResponse
Gets the OS profile.
securityProfile This property is required. SecurityProfileResponse
Gets the security profile.
userData This property is required. String
UserData associated with the source VM for which restore point is captured, which is a base-64 encoded value.
vmId This property is required. String
Gets the virtual machine unique id.
storageProfile RestorePointSourceVMStorageProfileResponse
Gets the storage profile.
diagnosticsProfile This property is required. DiagnosticsProfileResponse
Gets the diagnostics profile.
hardwareProfile This property is required. HardwareProfileResponse
Gets the hardware profile.
hyperVGeneration This property is required. string
HyperVGeneration of the source VM for which restore point is captured.
licenseType This property is required. string
Gets the license type, which is for bring your own license scenario.
location This property is required. string
Location of the VM from which the restore point was created.
osProfile This property is required. OSProfileResponse
Gets the OS profile.
securityProfile This property is required. SecurityProfileResponse
Gets the security profile.
userData This property is required. string
UserData associated with the source VM for which restore point is captured, which is a base-64 encoded value.
vmId This property is required. string
Gets the virtual machine unique id.
storageProfile RestorePointSourceVMStorageProfileResponse
Gets the storage profile.
diagnostics_profile This property is required. DiagnosticsProfileResponse
Gets the diagnostics profile.
hardware_profile This property is required. HardwareProfileResponse
Gets the hardware profile.
hyper_v_generation This property is required. str
HyperVGeneration of the source VM for which restore point is captured.
license_type This property is required. str
Gets the license type, which is for bring your own license scenario.
location This property is required. str
Location of the VM from which the restore point was created.
os_profile This property is required. OSProfileResponse
Gets the OS profile.
security_profile This property is required. SecurityProfileResponse
Gets the security profile.
user_data This property is required. str
UserData associated with the source VM for which restore point is captured, which is a base-64 encoded value.
vm_id This property is required. str
Gets the virtual machine unique id.
storage_profile RestorePointSourceVMStorageProfileResponse
Gets the storage profile.
diagnosticsProfile This property is required. Property Map
Gets the diagnostics profile.
hardwareProfile This property is required. Property Map
Gets the hardware profile.
hyperVGeneration This property is required. String
HyperVGeneration of the source VM for which restore point is captured.
licenseType This property is required. String
Gets the license type, which is for bring your own license scenario.
location This property is required. String
Location of the VM from which the restore point was created.
osProfile This property is required. Property Map
Gets the OS profile.
securityProfile This property is required. Property Map
Gets the security profile.
userData This property is required. String
UserData associated with the source VM for which restore point is captured, which is a base-64 encoded value.
vmId This property is required. String
Gets the virtual machine unique id.
storageProfile Property Map
Gets the storage profile.

RestorePointSourceVMDataDiskResponse

Caching This property is required. string
Gets the caching type.
DiskSizeGB This property is required. int
Gets the initial disk size in GB for blank data disks, and the new desired size for existing OS and Data disks.
Lun This property is required. int
Gets the logical unit number.
Name This property is required. string
Gets the disk name.
WriteAcceleratorEnabled This property is required. bool
Shows true if the disk is write-accelerator enabled.
DiskRestorePoint Pulumi.AzureNative.Compute.Inputs.DiskRestorePointAttributesResponse
Contains Disk Restore Point properties.
ManagedDisk Pulumi.AzureNative.Compute.Inputs.ManagedDiskParametersResponse
Contains the managed disk details.
Caching This property is required. string
Gets the caching type.
DiskSizeGB This property is required. int
Gets the initial disk size in GB for blank data disks, and the new desired size for existing OS and Data disks.
Lun This property is required. int
Gets the logical unit number.
Name This property is required. string
Gets the disk name.
WriteAcceleratorEnabled This property is required. bool
Shows true if the disk is write-accelerator enabled.
DiskRestorePoint DiskRestorePointAttributesResponse
Contains Disk Restore Point properties.
ManagedDisk ManagedDiskParametersResponse
Contains the managed disk details.
caching This property is required. String
Gets the caching type.
diskSizeGB This property is required. Integer
Gets the initial disk size in GB for blank data disks, and the new desired size for existing OS and Data disks.
lun This property is required. Integer
Gets the logical unit number.
name This property is required. String
Gets the disk name.
writeAcceleratorEnabled This property is required. Boolean
Shows true if the disk is write-accelerator enabled.
diskRestorePoint DiskRestorePointAttributesResponse
Contains Disk Restore Point properties.
managedDisk ManagedDiskParametersResponse
Contains the managed disk details.
caching This property is required. string
Gets the caching type.
diskSizeGB This property is required. number
Gets the initial disk size in GB for blank data disks, and the new desired size for existing OS and Data disks.
lun This property is required. number
Gets the logical unit number.
name This property is required. string
Gets the disk name.
writeAcceleratorEnabled This property is required. boolean
Shows true if the disk is write-accelerator enabled.
diskRestorePoint DiskRestorePointAttributesResponse
Contains Disk Restore Point properties.
managedDisk ManagedDiskParametersResponse
Contains the managed disk details.
caching This property is required. str
Gets the caching type.
disk_size_gb This property is required. int
Gets the initial disk size in GB for blank data disks, and the new desired size for existing OS and Data disks.
lun This property is required. int
Gets the logical unit number.
name This property is required. str
Gets the disk name.
write_accelerator_enabled This property is required. bool
Shows true if the disk is write-accelerator enabled.
disk_restore_point DiskRestorePointAttributesResponse
Contains Disk Restore Point properties.
managed_disk ManagedDiskParametersResponse
Contains the managed disk details.
caching This property is required. String
Gets the caching type.
diskSizeGB This property is required. Number
Gets the initial disk size in GB for blank data disks, and the new desired size for existing OS and Data disks.
lun This property is required. Number
Gets the logical unit number.
name This property is required. String
Gets the disk name.
writeAcceleratorEnabled This property is required. Boolean
Shows true if the disk is write-accelerator enabled.
diskRestorePoint Property Map
Contains Disk Restore Point properties.
managedDisk Property Map
Contains the managed disk details.

RestorePointSourceVMOSDiskResponse

Caching This property is required. string
Gets the caching type.
DiskSizeGB This property is required. int
Gets the disk size in GB.
EncryptionSettings This property is required. Pulumi.AzureNative.Compute.Inputs.DiskEncryptionSettingsResponse
Gets the disk encryption settings.
Name This property is required. string
Gets the disk name.
OsType This property is required. string
Gets the Operating System type.
WriteAcceleratorEnabled This property is required. bool
Shows true if the disk is write-accelerator enabled.
DiskRestorePoint Pulumi.AzureNative.Compute.Inputs.DiskRestorePointAttributesResponse
Contains Disk Restore Point properties.
ManagedDisk Pulumi.AzureNative.Compute.Inputs.ManagedDiskParametersResponse
Gets the managed disk details
Caching This property is required. string
Gets the caching type.
DiskSizeGB This property is required. int
Gets the disk size in GB.
EncryptionSettings This property is required. DiskEncryptionSettingsResponse
Gets the disk encryption settings.
Name This property is required. string
Gets the disk name.
OsType This property is required. string
Gets the Operating System type.
WriteAcceleratorEnabled This property is required. bool
Shows true if the disk is write-accelerator enabled.
DiskRestorePoint DiskRestorePointAttributesResponse
Contains Disk Restore Point properties.
ManagedDisk ManagedDiskParametersResponse
Gets the managed disk details
caching This property is required. String
Gets the caching type.
diskSizeGB This property is required. Integer
Gets the disk size in GB.
encryptionSettings This property is required. DiskEncryptionSettingsResponse
Gets the disk encryption settings.
name This property is required. String
Gets the disk name.
osType This property is required. String
Gets the Operating System type.
writeAcceleratorEnabled This property is required. Boolean
Shows true if the disk is write-accelerator enabled.
diskRestorePoint DiskRestorePointAttributesResponse
Contains Disk Restore Point properties.
managedDisk ManagedDiskParametersResponse
Gets the managed disk details
caching This property is required. string
Gets the caching type.
diskSizeGB This property is required. number
Gets the disk size in GB.
encryptionSettings This property is required. DiskEncryptionSettingsResponse
Gets the disk encryption settings.
name This property is required. string
Gets the disk name.
osType This property is required. string
Gets the Operating System type.
writeAcceleratorEnabled This property is required. boolean
Shows true if the disk is write-accelerator enabled.
diskRestorePoint DiskRestorePointAttributesResponse
Contains Disk Restore Point properties.
managedDisk ManagedDiskParametersResponse
Gets the managed disk details
caching This property is required. str
Gets the caching type.
disk_size_gb This property is required. int
Gets the disk size in GB.
encryption_settings This property is required. DiskEncryptionSettingsResponse
Gets the disk encryption settings.
name This property is required. str
Gets the disk name.
os_type This property is required. str
Gets the Operating System type.
write_accelerator_enabled This property is required. bool
Shows true if the disk is write-accelerator enabled.
disk_restore_point DiskRestorePointAttributesResponse
Contains Disk Restore Point properties.
managed_disk ManagedDiskParametersResponse
Gets the managed disk details
caching This property is required. String
Gets the caching type.
diskSizeGB This property is required. Number
Gets the disk size in GB.
encryptionSettings This property is required. Property Map
Gets the disk encryption settings.
name This property is required. String
Gets the disk name.
osType This property is required. String
Gets the Operating System type.
writeAcceleratorEnabled This property is required. Boolean
Shows true if the disk is write-accelerator enabled.
diskRestorePoint Property Map
Contains Disk Restore Point properties.
managedDisk Property Map
Gets the managed disk details

RestorePointSourceVMStorageProfileResponse

DataDisks List<Pulumi.AzureNative.Compute.Inputs.RestorePointSourceVMDataDiskResponse>
Gets the data disks of the VM captured at the time of the restore point creation.
OsDisk Pulumi.AzureNative.Compute.Inputs.RestorePointSourceVMOSDiskResponse
Gets the OS disk of the VM captured at the time of the restore point creation.
DataDisks []RestorePointSourceVMDataDiskResponse
Gets the data disks of the VM captured at the time of the restore point creation.
OsDisk RestorePointSourceVMOSDiskResponse
Gets the OS disk of the VM captured at the time of the restore point creation.
dataDisks List<RestorePointSourceVMDataDiskResponse>
Gets the data disks of the VM captured at the time of the restore point creation.
osDisk RestorePointSourceVMOSDiskResponse
Gets the OS disk of the VM captured at the time of the restore point creation.
dataDisks RestorePointSourceVMDataDiskResponse[]
Gets the data disks of the VM captured at the time of the restore point creation.
osDisk RestorePointSourceVMOSDiskResponse
Gets the OS disk of the VM captured at the time of the restore point creation.
data_disks Sequence[RestorePointSourceVMDataDiskResponse]
Gets the data disks of the VM captured at the time of the restore point creation.
os_disk RestorePointSourceVMOSDiskResponse
Gets the OS disk of the VM captured at the time of the restore point creation.
dataDisks List<Property Map>
Gets the data disks of the VM captured at the time of the restore point creation.
osDisk Property Map
Gets the OS disk of the VM captured at the time of the restore point creation.

SecurityProfileResponse

EncryptionAtHost bool
This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself. The default behavior is: The Encryption at host will be disabled unless this property is set to true for the resource.
SecurityType string
Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. The default behavior is: UefiSettings will not be enabled unless this property is set.
UefiSettings Pulumi.AzureNative.Compute.Inputs.UefiSettingsResponse
Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum api-version: 2020-12-01.
EncryptionAtHost bool
This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself. The default behavior is: The Encryption at host will be disabled unless this property is set to true for the resource.
SecurityType string
Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. The default behavior is: UefiSettings will not be enabled unless this property is set.
UefiSettings UefiSettingsResponse
Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum api-version: 2020-12-01.
encryptionAtHost Boolean
This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself. The default behavior is: The Encryption at host will be disabled unless this property is set to true for the resource.
securityType String
Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. The default behavior is: UefiSettings will not be enabled unless this property is set.
uefiSettings UefiSettingsResponse
Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum api-version: 2020-12-01.
encryptionAtHost boolean
This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself. The default behavior is: The Encryption at host will be disabled unless this property is set to true for the resource.
securityType string
Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. The default behavior is: UefiSettings will not be enabled unless this property is set.
uefiSettings UefiSettingsResponse
Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum api-version: 2020-12-01.
encryption_at_host bool
This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself. The default behavior is: The Encryption at host will be disabled unless this property is set to true for the resource.
security_type str
Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. The default behavior is: UefiSettings will not be enabled unless this property is set.
uefi_settings UefiSettingsResponse
Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum api-version: 2020-12-01.
encryptionAtHost Boolean
This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself. The default behavior is: The Encryption at host will be disabled unless this property is set to true for the resource.
securityType String
Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. The default behavior is: UefiSettings will not be enabled unless this property is set.
uefiSettings Property Map
Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum api-version: 2020-12-01.

SshConfigurationResponse

PublicKeys List<Pulumi.AzureNative.Compute.Inputs.SshPublicKeyResponse>
The list of SSH public keys used to authenticate with linux based VMs.
PublicKeys []SshPublicKeyResponse
The list of SSH public keys used to authenticate with linux based VMs.
publicKeys List<SshPublicKeyResponse>
The list of SSH public keys used to authenticate with linux based VMs.
publicKeys SshPublicKeyResponse[]
The list of SSH public keys used to authenticate with linux based VMs.
public_keys Sequence[SshPublicKeyResponse]
The list of SSH public keys used to authenticate with linux based VMs.
publicKeys List<Property Map>
The list of SSH public keys used to authenticate with linux based VMs.

SshPublicKeyResponse

KeyData string
SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format. For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed).
Path string
Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys
KeyData string
SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format. For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed).
Path string
Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys
keyData String
SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format. For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed).
path String
Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys
keyData string
SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format. For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed).
path string
Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys
key_data str
SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format. For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed).
path str
Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys
keyData String
SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format. For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed).
path String
Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys

SubResourceResponse

Id string
Resource Id
Id string
Resource Id
id String
Resource Id
id string
Resource Id
id str
Resource Id
id String
Resource Id

UefiSettingsResponse

SecureBootEnabled bool
Specifies whether secure boot should be enabled on the virtual machine. Minimum api-version: 2020-12-01.
VTpmEnabled bool
Specifies whether vTPM should be enabled on the virtual machine. Minimum api-version: 2020-12-01.
SecureBootEnabled bool
Specifies whether secure boot should be enabled on the virtual machine. Minimum api-version: 2020-12-01.
VTpmEnabled bool
Specifies whether vTPM should be enabled on the virtual machine. Minimum api-version: 2020-12-01.
secureBootEnabled Boolean
Specifies whether secure boot should be enabled on the virtual machine. Minimum api-version: 2020-12-01.
vTpmEnabled Boolean
Specifies whether vTPM should be enabled on the virtual machine. Minimum api-version: 2020-12-01.
secureBootEnabled boolean
Specifies whether secure boot should be enabled on the virtual machine. Minimum api-version: 2020-12-01.
vTpmEnabled boolean
Specifies whether vTPM should be enabled on the virtual machine. Minimum api-version: 2020-12-01.
secure_boot_enabled bool
Specifies whether secure boot should be enabled on the virtual machine. Minimum api-version: 2020-12-01.
v_tpm_enabled bool
Specifies whether vTPM should be enabled on the virtual machine. Minimum api-version: 2020-12-01.
secureBootEnabled Boolean
Specifies whether secure boot should be enabled on the virtual machine. Minimum api-version: 2020-12-01.
vTpmEnabled Boolean
Specifies whether vTPM should be enabled on the virtual machine. Minimum api-version: 2020-12-01.

VMDiskSecurityProfileResponse

DiskEncryptionSet Pulumi.AzureNative.Compute.Inputs.DiskEncryptionSetParametersResponse
Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob.
SecurityEncryptionType string
Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, and VMGuestStateOnly for encryption of just the VMGuestState blob. Note: It can be set for only Confidential VMs.
DiskEncryptionSet DiskEncryptionSetParametersResponse
Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob.
SecurityEncryptionType string
Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, and VMGuestStateOnly for encryption of just the VMGuestState blob. Note: It can be set for only Confidential VMs.
diskEncryptionSet DiskEncryptionSetParametersResponse
Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob.
securityEncryptionType String
Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, and VMGuestStateOnly for encryption of just the VMGuestState blob. Note: It can be set for only Confidential VMs.
diskEncryptionSet DiskEncryptionSetParametersResponse
Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob.
securityEncryptionType string
Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, and VMGuestStateOnly for encryption of just the VMGuestState blob. Note: It can be set for only Confidential VMs.
disk_encryption_set DiskEncryptionSetParametersResponse
Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob.
security_encryption_type str
Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, and VMGuestStateOnly for encryption of just the VMGuestState blob. Note: It can be set for only Confidential VMs.
diskEncryptionSet Property Map
Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob.
securityEncryptionType String
Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, and VMGuestStateOnly for encryption of just the VMGuestState blob. Note: It can be set for only Confidential VMs.

VMSizePropertiesResponse

VCPUsAvailable int
Specifies the number of vCPUs available for the VM. When this property is not specified in the request body the default behavior is to set it to the value of vCPUs available for that VM size exposed in api response of List all available virtual machine sizes in a region.
VCPUsPerCore int
Specifies the vCPU to physical core ratio. When this property is not specified in the request body the default behavior is set to the value of vCPUsPerCore for the VM Size exposed in api response of List all available virtual machine sizes in a region. Setting this property to 1 also means that hyper-threading is disabled.
VCPUsAvailable int
Specifies the number of vCPUs available for the VM. When this property is not specified in the request body the default behavior is to set it to the value of vCPUs available for that VM size exposed in api response of List all available virtual machine sizes in a region.
VCPUsPerCore int
Specifies the vCPU to physical core ratio. When this property is not specified in the request body the default behavior is set to the value of vCPUsPerCore for the VM Size exposed in api response of List all available virtual machine sizes in a region. Setting this property to 1 also means that hyper-threading is disabled.
vCPUsAvailable Integer
Specifies the number of vCPUs available for the VM. When this property is not specified in the request body the default behavior is to set it to the value of vCPUs available for that VM size exposed in api response of List all available virtual machine sizes in a region.
vCPUsPerCore Integer
Specifies the vCPU to physical core ratio. When this property is not specified in the request body the default behavior is set to the value of vCPUsPerCore for the VM Size exposed in api response of List all available virtual machine sizes in a region. Setting this property to 1 also means that hyper-threading is disabled.
vCPUsAvailable number
Specifies the number of vCPUs available for the VM. When this property is not specified in the request body the default behavior is to set it to the value of vCPUs available for that VM size exposed in api response of List all available virtual machine sizes in a region.
vCPUsPerCore number
Specifies the vCPU to physical core ratio. When this property is not specified in the request body the default behavior is set to the value of vCPUsPerCore for the VM Size exposed in api response of List all available virtual machine sizes in a region. Setting this property to 1 also means that hyper-threading is disabled.
v_cpus_available int
Specifies the number of vCPUs available for the VM. When this property is not specified in the request body the default behavior is to set it to the value of vCPUs available for that VM size exposed in api response of List all available virtual machine sizes in a region.
v_cpus_per_core int
Specifies the vCPU to physical core ratio. When this property is not specified in the request body the default behavior is set to the value of vCPUsPerCore for the VM Size exposed in api response of List all available virtual machine sizes in a region. Setting this property to 1 also means that hyper-threading is disabled.
vCPUsAvailable Number
Specifies the number of vCPUs available for the VM. When this property is not specified in the request body the default behavior is to set it to the value of vCPUs available for that VM size exposed in api response of List all available virtual machine sizes in a region.
vCPUsPerCore Number
Specifies the vCPU to physical core ratio. When this property is not specified in the request body the default behavior is set to the value of vCPUsPerCore for the VM Size exposed in api response of List all available virtual machine sizes in a region. Setting this property to 1 also means that hyper-threading is disabled.

VaultCertificateResponse

CertificateStore string
For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account. For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name <UppercaseThumbprint>.crt for the X509 certificate file and <UppercaseThumbprint>.prv for private key. Both of these files are .pem formatted.
CertificateUrl string
This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see Add a key or secret to the key vault. In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8: { "data":"", "dataType":"pfx", "password":""} To install certificates on a virtual machine it is recommended to use the Azure Key Vault virtual machine extension for Linux or the Azure Key Vault virtual machine extension for Windows.
CertificateStore string
For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account. For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name <UppercaseThumbprint>.crt for the X509 certificate file and <UppercaseThumbprint>.prv for private key. Both of these files are .pem formatted.
CertificateUrl string
This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see Add a key or secret to the key vault. In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8: { "data":"", "dataType":"pfx", "password":""} To install certificates on a virtual machine it is recommended to use the Azure Key Vault virtual machine extension for Linux or the Azure Key Vault virtual machine extension for Windows.
certificateStore String
For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account. For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name <UppercaseThumbprint>.crt for the X509 certificate file and <UppercaseThumbprint>.prv for private key. Both of these files are .pem formatted.
certificateUrl String
This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see Add a key or secret to the key vault. In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8: { "data":"", "dataType":"pfx", "password":""} To install certificates on a virtual machine it is recommended to use the Azure Key Vault virtual machine extension for Linux or the Azure Key Vault virtual machine extension for Windows.
certificateStore string
For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account. For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name <UppercaseThumbprint>.crt for the X509 certificate file and <UppercaseThumbprint>.prv for private key. Both of these files are .pem formatted.
certificateUrl string
This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see Add a key or secret to the key vault. In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8: { "data":"", "dataType":"pfx", "password":""} To install certificates on a virtual machine it is recommended to use the Azure Key Vault virtual machine extension for Linux or the Azure Key Vault virtual machine extension for Windows.
certificate_store str
For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account. For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name <UppercaseThumbprint>.crt for the X509 certificate file and <UppercaseThumbprint>.prv for private key. Both of these files are .pem formatted.
certificate_url str
This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see Add a key or secret to the key vault. In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8: { "data":"", "dataType":"pfx", "password":""} To install certificates on a virtual machine it is recommended to use the Azure Key Vault virtual machine extension for Linux or the Azure Key Vault virtual machine extension for Windows.
certificateStore String
For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account. For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name <UppercaseThumbprint>.crt for the X509 certificate file and <UppercaseThumbprint>.prv for private key. Both of these files are .pem formatted.
certificateUrl String
This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see Add a key or secret to the key vault. In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8: { "data":"", "dataType":"pfx", "password":""} To install certificates on a virtual machine it is recommended to use the Azure Key Vault virtual machine extension for Linux or the Azure Key Vault virtual machine extension for Windows.

VaultSecretGroupResponse

SourceVault Pulumi.AzureNative.Compute.Inputs.SubResourceResponse
The relative URL of the Key Vault containing all of the certificates in VaultCertificates.
VaultCertificates List<Pulumi.AzureNative.Compute.Inputs.VaultCertificateResponse>
The list of key vault references in SourceVault which contain certificates.
SourceVault SubResourceResponse
The relative URL of the Key Vault containing all of the certificates in VaultCertificates.
VaultCertificates []VaultCertificateResponse
The list of key vault references in SourceVault which contain certificates.
sourceVault SubResourceResponse
The relative URL of the Key Vault containing all of the certificates in VaultCertificates.
vaultCertificates List<VaultCertificateResponse>
The list of key vault references in SourceVault which contain certificates.
sourceVault SubResourceResponse
The relative URL of the Key Vault containing all of the certificates in VaultCertificates.
vaultCertificates VaultCertificateResponse[]
The list of key vault references in SourceVault which contain certificates.
source_vault SubResourceResponse
The relative URL of the Key Vault containing all of the certificates in VaultCertificates.
vault_certificates Sequence[VaultCertificateResponse]
The list of key vault references in SourceVault which contain certificates.
sourceVault Property Map
The relative URL of the Key Vault containing all of the certificates in VaultCertificates.
vaultCertificates List<Property Map>
The list of key vault references in SourceVault which contain certificates.

WinRMConfigurationResponse

Listeners List<Pulumi.AzureNative.Compute.Inputs.WinRMListenerResponse>
The list of Windows Remote Management listeners
Listeners []WinRMListenerResponse
The list of Windows Remote Management listeners
listeners List<WinRMListenerResponse>
The list of Windows Remote Management listeners
listeners WinRMListenerResponse[]
The list of Windows Remote Management listeners
listeners Sequence[WinRMListenerResponse]
The list of Windows Remote Management listeners
listeners List<Property Map>
The list of Windows Remote Management listeners

WinRMListenerResponse

CertificateUrl string
This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see Add a key or secret to the key vault. In this case, your certificate needs to be the Base64 encoding of the following JSON Object which is encoded in UTF-8: { "data":"", "dataType":"pfx", "password":""} To install certificates on a virtual machine it is recommended to use the Azure Key Vault virtual machine extension for Linux or the Azure Key Vault virtual machine extension for Windows.
Protocol string
Specifies the protocol of WinRM listener. Possible values are: http, https.
CertificateUrl string
This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see Add a key or secret to the key vault. In this case, your certificate needs to be the Base64 encoding of the following JSON Object which is encoded in UTF-8: { "data":"", "dataType":"pfx", "password":""} To install certificates on a virtual machine it is recommended to use the Azure Key Vault virtual machine extension for Linux or the Azure Key Vault virtual machine extension for Windows.
Protocol string
Specifies the protocol of WinRM listener. Possible values are: http, https.
certificateUrl String
This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see Add a key or secret to the key vault. In this case, your certificate needs to be the Base64 encoding of the following JSON Object which is encoded in UTF-8: { "data":"", "dataType":"pfx", "password":""} To install certificates on a virtual machine it is recommended to use the Azure Key Vault virtual machine extension for Linux or the Azure Key Vault virtual machine extension for Windows.
protocol String
Specifies the protocol of WinRM listener. Possible values are: http, https.
certificateUrl string
This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see Add a key or secret to the key vault. In this case, your certificate needs to be the Base64 encoding of the following JSON Object which is encoded in UTF-8: { "data":"", "dataType":"pfx", "password":""} To install certificates on a virtual machine it is recommended to use the Azure Key Vault virtual machine extension for Linux or the Azure Key Vault virtual machine extension for Windows.
protocol string
Specifies the protocol of WinRM listener. Possible values are: http, https.
certificate_url str
This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see Add a key or secret to the key vault. In this case, your certificate needs to be the Base64 encoding of the following JSON Object which is encoded in UTF-8: { "data":"", "dataType":"pfx", "password":""} To install certificates on a virtual machine it is recommended to use the Azure Key Vault virtual machine extension for Linux or the Azure Key Vault virtual machine extension for Windows.
protocol str
Specifies the protocol of WinRM listener. Possible values are: http, https.
certificateUrl String
This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see Add a key or secret to the key vault. In this case, your certificate needs to be the Base64 encoding of the following JSON Object which is encoded in UTF-8: { "data":"", "dataType":"pfx", "password":""} To install certificates on a virtual machine it is recommended to use the Azure Key Vault virtual machine extension for Linux or the Azure Key Vault virtual machine extension for Windows.
protocol String
Specifies the protocol of WinRM listener. Possible values are: http, https.

WindowsConfigurationResponse

AdditionalUnattendContent List<Pulumi.AzureNative.Compute.Inputs.AdditionalUnattendContentResponse>
Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup.
EnableAutomaticUpdates bool
Indicates whether Automatic Updates is enabled for the Windows virtual machine. Default value is true. For virtual machine scale sets, this property can be updated and updates will take effect on OS reprovisioning.
EnableVMAgentPlatformUpdates bool
Indicates whether VMAgent Platform Updates is enabled for the Windows virtual machine. Default value is false.
PatchSettings Pulumi.AzureNative.Compute.Inputs.PatchSettingsResponse
[Preview Feature] Specifies settings related to VM Guest Patching on Windows.
ProvisionVMAgent bool
Indicates whether virtual machine agent should be provisioned on the virtual machine. When this property is not specified in the request body, it is set to true by default. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later.
TimeZone string
Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time". Possible values can be TimeZoneInfo.Id value from time zones returned by TimeZoneInfo.GetSystemTimeZones.
WinRM Pulumi.AzureNative.Compute.Inputs.WinRMConfigurationResponse
Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell.
AdditionalUnattendContent []AdditionalUnattendContentResponse
Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup.
EnableAutomaticUpdates bool
Indicates whether Automatic Updates is enabled for the Windows virtual machine. Default value is true. For virtual machine scale sets, this property can be updated and updates will take effect on OS reprovisioning.
EnableVMAgentPlatformUpdates bool
Indicates whether VMAgent Platform Updates is enabled for the Windows virtual machine. Default value is false.
PatchSettings PatchSettingsResponse
[Preview Feature] Specifies settings related to VM Guest Patching on Windows.
ProvisionVMAgent bool
Indicates whether virtual machine agent should be provisioned on the virtual machine. When this property is not specified in the request body, it is set to true by default. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later.
TimeZone string
Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time". Possible values can be TimeZoneInfo.Id value from time zones returned by TimeZoneInfo.GetSystemTimeZones.
WinRM WinRMConfigurationResponse
Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell.
additionalUnattendContent List<AdditionalUnattendContentResponse>
Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup.
enableAutomaticUpdates Boolean
Indicates whether Automatic Updates is enabled for the Windows virtual machine. Default value is true. For virtual machine scale sets, this property can be updated and updates will take effect on OS reprovisioning.
enableVMAgentPlatformUpdates Boolean
Indicates whether VMAgent Platform Updates is enabled for the Windows virtual machine. Default value is false.
patchSettings PatchSettingsResponse
[Preview Feature] Specifies settings related to VM Guest Patching on Windows.
provisionVMAgent Boolean
Indicates whether virtual machine agent should be provisioned on the virtual machine. When this property is not specified in the request body, it is set to true by default. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later.
timeZone String
Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time". Possible values can be TimeZoneInfo.Id value from time zones returned by TimeZoneInfo.GetSystemTimeZones.
winRM WinRMConfigurationResponse
Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell.
additionalUnattendContent AdditionalUnattendContentResponse[]
Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup.
enableAutomaticUpdates boolean
Indicates whether Automatic Updates is enabled for the Windows virtual machine. Default value is true. For virtual machine scale sets, this property can be updated and updates will take effect on OS reprovisioning.
enableVMAgentPlatformUpdates boolean
Indicates whether VMAgent Platform Updates is enabled for the Windows virtual machine. Default value is false.
patchSettings PatchSettingsResponse
[Preview Feature] Specifies settings related to VM Guest Patching on Windows.
provisionVMAgent boolean
Indicates whether virtual machine agent should be provisioned on the virtual machine. When this property is not specified in the request body, it is set to true by default. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later.
timeZone string
Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time". Possible values can be TimeZoneInfo.Id value from time zones returned by TimeZoneInfo.GetSystemTimeZones.
winRM WinRMConfigurationResponse
Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell.
additional_unattend_content Sequence[AdditionalUnattendContentResponse]
Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup.
enable_automatic_updates bool
Indicates whether Automatic Updates is enabled for the Windows virtual machine. Default value is true. For virtual machine scale sets, this property can be updated and updates will take effect on OS reprovisioning.
enable_vm_agent_platform_updates bool
Indicates whether VMAgent Platform Updates is enabled for the Windows virtual machine. Default value is false.
patch_settings PatchSettingsResponse
[Preview Feature] Specifies settings related to VM Guest Patching on Windows.
provision_vm_agent bool
Indicates whether virtual machine agent should be provisioned on the virtual machine. When this property is not specified in the request body, it is set to true by default. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later.
time_zone str
Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time". Possible values can be TimeZoneInfo.Id value from time zones returned by TimeZoneInfo.GetSystemTimeZones.
win_rm WinRMConfigurationResponse
Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell.
additionalUnattendContent List<Property Map>
Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup.
enableAutomaticUpdates Boolean
Indicates whether Automatic Updates is enabled for the Windows virtual machine. Default value is true. For virtual machine scale sets, this property can be updated and updates will take effect on OS reprovisioning.
enableVMAgentPlatformUpdates Boolean
Indicates whether VMAgent Platform Updates is enabled for the Windows virtual machine. Default value is false.
patchSettings Property Map
[Preview Feature] Specifies settings related to VM Guest Patching on Windows.
provisionVMAgent Boolean
Indicates whether virtual machine agent should be provisioned on the virtual machine. When this property is not specified in the request body, it is set to true by default. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later.
timeZone String
Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time". Possible values can be TimeZoneInfo.Id value from time zones returned by TimeZoneInfo.GetSystemTimeZones.
winRM Property Map
Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell.

WindowsVMGuestPatchAutomaticByPlatformSettingsResponse

BypassPlatformSafetyChecksOnUserSchedule bool
Enables customer to schedule patching without accidental upgrades
RebootSetting string
Specifies the reboot setting for all AutomaticByPlatform patch installation operations.
BypassPlatformSafetyChecksOnUserSchedule bool
Enables customer to schedule patching without accidental upgrades
RebootSetting string
Specifies the reboot setting for all AutomaticByPlatform patch installation operations.
bypassPlatformSafetyChecksOnUserSchedule Boolean
Enables customer to schedule patching without accidental upgrades
rebootSetting String
Specifies the reboot setting for all AutomaticByPlatform patch installation operations.
bypassPlatformSafetyChecksOnUserSchedule boolean
Enables customer to schedule patching without accidental upgrades
rebootSetting string
Specifies the reboot setting for all AutomaticByPlatform patch installation operations.
bypass_platform_safety_checks_on_user_schedule bool
Enables customer to schedule patching without accidental upgrades
reboot_setting str
Specifies the reboot setting for all AutomaticByPlatform patch installation operations.
bypassPlatformSafetyChecksOnUserSchedule Boolean
Enables customer to schedule patching without accidental upgrades
rebootSetting String
Specifies the reboot setting for all AutomaticByPlatform patch installation operations.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi