VirtualMachine

Manages a Microsoft SQL Virtual Machine

Create a VirtualMachine Resource

new VirtualMachine(name: string, args: VirtualMachineArgs, opts?: CustomResourceOptions);

def VirtualMachine(resource_name, opts=None, auto_patching=None, key_vault_credential=None, r_services_enabled=None, sql_connectivity_port=None, sql_connectivity_type=None, sql_connectivity_update_password=None, sql_connectivity_update_username=None, sql_license_type=None, tags=None, virtual_machine_id=None, __props__=None);

func NewVirtualMachine(ctx *Context, name string, args VirtualMachineArgs, opts ...ResourceOption) (*VirtualMachine, error)

public VirtualMachine(string name, VirtualMachineArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args VirtualMachineArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args VirtualMachineArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args VirtualMachineArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

VirtualMachine Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The VirtualMachine resource accepts the following input properties:

SqlLicenseType string: The SQL Server license type. Possible values are AHUB (Azure Hybrid Benefit) and PAYG (Pay-As-You-Go). Changing this forces a new resource to be created.
VirtualMachineId string: The ID of the Virtual Machine. Changing this forces a new resource to be created.
AutoPatching VirtualMachineAutoPatchingArgs: An auto_patching block as defined below.
KeyVaultCredential VirtualMachineKeyVaultCredentialArgs: (Optional) An key_vault_credential block as defined below.
RServicesEnabled bool: Should R Services be enabled?
SqlConnectivityPort int: The SQL Server port. Defaults to 1433.
SqlConnectivityType string: The connectivity type used for this SQL Server. Defaults to PRIVATE.
SqlConnectivityUpdatePassword string: The SQL Server sysadmin login password.
SqlConnectivityUpdateUsername string: The SQL Server sysadmin login to create.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.

SqlLicenseType string: The SQL Server license type. Possible values are AHUB (Azure Hybrid Benefit) and PAYG (Pay-As-You-Go). Changing this forces a new resource to be created.
VirtualMachineId string: The ID of the Virtual Machine. Changing this forces a new resource to be created.
AutoPatching VirtualMachineAutoPatching: An auto_patching block as defined below.
KeyVaultCredential VirtualMachineKeyVaultCredential: (Optional) An key_vault_credential block as defined below.
RServicesEnabled bool: Should R Services be enabled?
SqlConnectivityPort int: The SQL Server port. Defaults to 1433.
SqlConnectivityType string: The connectivity type used for this SQL Server. Defaults to PRIVATE.
SqlConnectivityUpdatePassword string: The SQL Server sysadmin login password.
SqlConnectivityUpdateUsername string: The SQL Server sysadmin login to create.
Tags map[string]string: A mapping of tags to assign to the resource.

sqlLicenseType string: The SQL Server license type. Possible values are AHUB (Azure Hybrid Benefit) and PAYG (Pay-As-You-Go). Changing this forces a new resource to be created.
virtualMachineId string: The ID of the Virtual Machine. Changing this forces a new resource to be created.
autoPatching VirtualMachineAutoPatching: An auto_patching block as defined below.
keyVaultCredential VirtualMachineKeyVaultCredential: (Optional) An key_vault_credential block as defined below.
rServicesEnabled boolean: Should R Services be enabled?
sqlConnectivityPort number: The SQL Server port. Defaults to 1433.
sqlConnectivityType string: The connectivity type used for this SQL Server. Defaults to PRIVATE.
sqlConnectivityUpdatePassword string: The SQL Server sysadmin login password.
sqlConnectivityUpdateUsername string: The SQL Server sysadmin login to create.
tags {[key: string]: string}: A mapping of tags to assign to the resource.

sql_license_type str: The SQL Server license type. Possible values are AHUB (Azure Hybrid Benefit) and PAYG (Pay-As-You-Go). Changing this forces a new resource to be created.
virtual_machine_id str: The ID of the Virtual Machine. Changing this forces a new resource to be created.
auto_patching Dict[VirtualMachineAutoPatching]: An auto_patching block as defined below.
key_vault_credential Dict[VirtualMachineKeyVaultCredential]: (Optional) An key_vault_credential block as defined below.
r_services_enabled bool: Should R Services be enabled?
sql_connectivity_port float: The SQL Server port. Defaults to 1433.
sql_connectivity_type str: The connectivity type used for this SQL Server. Defaults to PRIVATE.
sql_connectivity_update_password str: The SQL Server sysadmin login password.
sql_connectivity_update_username str: The SQL Server sysadmin login to create.
tags Dict[str, str]: A mapping of tags to assign to the resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the VirtualMachine resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

Look up an Existing VirtualMachine Resource

Get an existing VirtualMachine resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: VirtualMachineState, opts?: CustomResourceOptions): VirtualMachine

static get(resource_name, id, opts=None, auto_patching=None, key_vault_credential=None, r_services_enabled=None, sql_connectivity_port=None, sql_connectivity_type=None, sql_connectivity_update_password=None, sql_connectivity_update_username=None, sql_license_type=None, tags=None, virtual_machine_id=None, __props__=None);

func GetVirtualMachine(ctx *Context, name string, id IDInput, state *VirtualMachineState, opts ...ResourceOption) (*VirtualMachine, error)

public static VirtualMachine Get(string name, Input<string> id, VirtualMachineState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AutoPatching VirtualMachineAutoPatchingArgs: An auto_patching block as defined below.
KeyVaultCredential VirtualMachineKeyVaultCredentialArgs: (Optional) An key_vault_credential block as defined below.
RServicesEnabled bool: Should R Services be enabled?
SqlConnectivityPort int: The SQL Server port. Defaults to 1433.
SqlConnectivityType string: The connectivity type used for this SQL Server. Defaults to PRIVATE.
SqlConnectivityUpdatePassword string: The SQL Server sysadmin login password.
SqlConnectivityUpdateUsername string: The SQL Server sysadmin login to create.
SqlLicenseType string: The SQL Server license type. Possible values are AHUB (Azure Hybrid Benefit) and PAYG (Pay-As-You-Go). Changing this forces a new resource to be created.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.
VirtualMachineId string: The ID of the Virtual Machine. Changing this forces a new resource to be created.

AutoPatching VirtualMachineAutoPatching: An auto_patching block as defined below.
KeyVaultCredential VirtualMachineKeyVaultCredential: (Optional) An key_vault_credential block as defined below.
RServicesEnabled bool: Should R Services be enabled?
SqlConnectivityPort int: The SQL Server port. Defaults to 1433.
SqlConnectivityType string: The connectivity type used for this SQL Server. Defaults to PRIVATE.
SqlConnectivityUpdatePassword string: The SQL Server sysadmin login password.
SqlConnectivityUpdateUsername string: The SQL Server sysadmin login to create.
SqlLicenseType string: The SQL Server license type. Possible values are AHUB (Azure Hybrid Benefit) and PAYG (Pay-As-You-Go). Changing this forces a new resource to be created.
Tags map[string]string: A mapping of tags to assign to the resource.
VirtualMachineId string: The ID of the Virtual Machine. Changing this forces a new resource to be created.

autoPatching VirtualMachineAutoPatching: An auto_patching block as defined below.
keyVaultCredential VirtualMachineKeyVaultCredential: (Optional) An key_vault_credential block as defined below.
rServicesEnabled boolean: Should R Services be enabled?
sqlConnectivityPort number: The SQL Server port. Defaults to 1433.
sqlConnectivityType string: The connectivity type used for this SQL Server. Defaults to PRIVATE.
sqlConnectivityUpdatePassword string: The SQL Server sysadmin login password.
sqlConnectivityUpdateUsername string: The SQL Server sysadmin login to create.
sqlLicenseType string: The SQL Server license type. Possible values are AHUB (Azure Hybrid Benefit) and PAYG (Pay-As-You-Go). Changing this forces a new resource to be created.
tags {[key: string]: string}: A mapping of tags to assign to the resource.
virtualMachineId string: The ID of the Virtual Machine. Changing this forces a new resource to be created.

auto_patching Dict[VirtualMachineAutoPatching]: An auto_patching block as defined below.
key_vault_credential Dict[VirtualMachineKeyVaultCredential]: (Optional) An key_vault_credential block as defined below.
r_services_enabled bool: Should R Services be enabled?
sql_connectivity_port float: The SQL Server port. Defaults to 1433.
sql_connectivity_type str: The connectivity type used for this SQL Server. Defaults to PRIVATE.
sql_connectivity_update_password str: The SQL Server sysadmin login password.
sql_connectivity_update_username str: The SQL Server sysadmin login to create.
sql_license_type str: The SQL Server license type. Possible values are AHUB (Azure Hybrid Benefit) and PAYG (Pay-As-You-Go). Changing this forces a new resource to be created.
tags Dict[str, str]: A mapping of tags to assign to the resource.
virtual_machine_id str: The ID of the Virtual Machine. Changing this forces a new resource to be created.

Supporting Types

VirtualMachineAutoPatching

See the input and output API doc for this type.

DayOfWeek string: The day of week to apply the patch on.
MaintenanceWindowDurationInMinutes int: The size of the Maintenance Window in minutes.
MaintenanceWindowStartingHour int: The Hour, in the Virtual Machine Time-Zone when the patching maintenance window should begin.

DayOfWeek string: The day of week to apply the patch on.
MaintenanceWindowDurationInMinutes int: The size of the Maintenance Window in minutes.
MaintenanceWindowStartingHour int: The Hour, in the Virtual Machine Time-Zone when the patching maintenance window should begin.

dayOfWeek string: The day of week to apply the patch on.
maintenanceWindowDurationInMinutes number: The size of the Maintenance Window in minutes.
maintenanceWindowStartingHour number: The Hour, in the Virtual Machine Time-Zone when the patching maintenance window should begin.

dayOfWeek str: The day of week to apply the patch on.
maintenanceWindowDurationInMinutes float: The size of the Maintenance Window in minutes.
maintenanceWindowStartingHour float: The Hour, in the Virtual Machine Time-Zone when the patching maintenance window should begin.

VirtualMachineKeyVaultCredential

See the input and output API doc for this type.

KeyVaultUrl string: The azure Key Vault url. Changing this forces a new resource to be created.
Name string: The credential name.
ServicePrincipalName string: The service principal name to access key vault. Changing this forces a new resource to be created.
ServicePrincipalSecret string: The service principal name secret to access key vault. Changing this forces a new resource to be created.

KeyVaultUrl string: The azure Key Vault url. Changing this forces a new resource to be created.
Name string: The credential name.
ServicePrincipalName string: The service principal name to access key vault. Changing this forces a new resource to be created.
ServicePrincipalSecret string: The service principal name secret to access key vault. Changing this forces a new resource to be created.

keyVaultUrl string: The azure Key Vault url. Changing this forces a new resource to be created.
name string: The credential name.
servicePrincipalName string: The service principal name to access key vault. Changing this forces a new resource to be created.
servicePrincipalSecret string: The service principal name secret to access key vault. Changing this forces a new resource to be created.

keyVaultUrl str: The azure Key Vault url. Changing this forces a new resource to be created.
name str: The credential name.
servicePrincipalName str: The service principal name to access key vault. Changing this forces a new resource to be created.
servicePrincipalSecret str: The service principal name secret to access key vault. Changing this forces a new resource to be created.

Package Details

Repository: https://github.com/pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud