Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. mssql
  5. VirtualMachineAvailabilityGroupListener

We recommend using Azure Native.

Azure v6.21.0 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-azure

azure.mssql.VirtualMachineAvailabilityGroupListener

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure v6.21.0 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-azure

    Manages a Microsoft SQL Virtual Machine Availability Group Listener.

    Create VirtualMachineAvailabilityGroupListener Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new VirtualMachineAvailabilityGroupListener(name: string, args: VirtualMachineAvailabilityGroupListenerArgs, opts?: CustomResourceOptions);
    @overload
def VirtualMachineAvailabilityGroupListener(resource_name: str,
                                            args: VirtualMachineAvailabilityGroupListenerArgs,
                                            opts: Optional[ResourceOptions] = None)

@overload
def VirtualMachineAvailabilityGroupListener(resource_name: str,
                                            opts: Optional[ResourceOptions] = None,
                                            replicas: Optional[Sequence[VirtualMachineAvailabilityGroupListenerReplicaArgs]] = None,
                                            sql_virtual_machine_group_id: Optional[str] = None,
                                            availability_group_name: Optional[str] = None,
                                            load_balancer_configuration: Optional[VirtualMachineAvailabilityGroupListenerLoadBalancerConfigurationArgs] = None,
                                            multi_subnet_ip_configurations: Optional[Sequence[VirtualMachineAvailabilityGroupListenerMultiSubnetIpConfigurationArgs]] = None,
                                            name: Optional[str] = None,
                                            port: Optional[int] = None)
    func NewVirtualMachineAvailabilityGroupListener(ctx *Context, name string, args VirtualMachineAvailabilityGroupListenerArgs, opts ...ResourceOption) (*VirtualMachineAvailabilityGroupListener, error)
    public VirtualMachineAvailabilityGroupListener(string name, VirtualMachineAvailabilityGroupListenerArgs args, CustomResourceOptions? opts = null)
    public VirtualMachineAvailabilityGroupListener(String name, VirtualMachineAvailabilityGroupListenerArgs args)
public VirtualMachineAvailabilityGroupListener(String name, VirtualMachineAvailabilityGroupListenerArgs args, CustomResourceOptions options)

    type: azure:mssql:VirtualMachineAvailabilityGroupListener
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args VirtualMachineAvailabilityGroupListenerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args VirtualMachineAvailabilityGroupListenerArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args VirtualMachineAvailabilityGroupListenerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VirtualMachineAvailabilityGroupListenerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VirtualMachineAvailabilityGroupListenerArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var virtualMachineAvailabilityGroupListenerResource = new Azure.MSSql.VirtualMachineAvailabilityGroupListener("virtualMachineAvailabilityGroupListenerResource", new()
{
    Replicas = new[]
    {
        new Azure.MSSql.Inputs.VirtualMachineAvailabilityGroupListenerReplicaArgs
        {
            Commit = "string",
            FailoverMode = "string",
            ReadableSecondary = "string",
            Role = "string",
            SqlVirtualMachineId = "string",
        },
    },
    SqlVirtualMachineGroupId = "string",
    AvailabilityGroupName = "string",
    LoadBalancerConfiguration = new Azure.MSSql.Inputs.VirtualMachineAvailabilityGroupListenerLoadBalancerConfigurationArgs
    {
        LoadBalancerId = "string",
        PrivateIpAddress = "string",
        ProbePort = 0,
        SqlVirtualMachineIds = new[]
        {
            "string",
        },
        SubnetId = "string",
    },
    MultiSubnetIpConfigurations = new[]
    {
        new Azure.MSSql.Inputs.VirtualMachineAvailabilityGroupListenerMultiSubnetIpConfigurationArgs
        {
            PrivateIpAddress = "string",
            SqlVirtualMachineId = "string",
            SubnetId = "string",
        },
    },
    Name = "string",
    Port = 0,
});

    example, err := mssql.NewVirtualMachineAvailabilityGroupListener(ctx, "virtualMachineAvailabilityGroupListenerResource", &mssql.VirtualMachineAvailabilityGroupListenerArgs{
	Replicas: mssql.VirtualMachineAvailabilityGroupListenerReplicaArray{
		&mssql.VirtualMachineAvailabilityGroupListenerReplicaArgs{
			Commit:              pulumi.String("string"),
			FailoverMode:        pulumi.String("string"),
			ReadableSecondary:   pulumi.String("string"),
			Role:                pulumi.String("string"),
			SqlVirtualMachineId: pulumi.String("string"),
		},
	},
	SqlVirtualMachineGroupId: pulumi.String("string"),
	AvailabilityGroupName:    pulumi.String("string"),
	LoadBalancerConfiguration: &mssql.VirtualMachineAvailabilityGroupListenerLoadBalancerConfigurationArgs{
		LoadBalancerId:   pulumi.String("string"),
		PrivateIpAddress: pulumi.String("string"),
		ProbePort:        pulumi.Int(0),
		SqlVirtualMachineIds: pulumi.StringArray{
			pulumi.String("string"),
		},
		SubnetId: pulumi.String("string"),
	},
	MultiSubnetIpConfigurations: mssql.VirtualMachineAvailabilityGroupListenerMultiSubnetIpConfigurationArray{
		&mssql.VirtualMachineAvailabilityGroupListenerMultiSubnetIpConfigurationArgs{
			PrivateIpAddress:    pulumi.String("string"),
			SqlVirtualMachineId: pulumi.String("string"),
			SubnetId:            pulumi.String("string"),
		},
	},
	Name: pulumi.String("string"),
	Port: pulumi.Int(0),
})

    var virtualMachineAvailabilityGroupListenerResource = new VirtualMachineAvailabilityGroupListener("virtualMachineAvailabilityGroupListenerResource", VirtualMachineAvailabilityGroupListenerArgs.builder()
    .replicas(VirtualMachineAvailabilityGroupListenerReplicaArgs.builder()
        .commit("string")
        .failoverMode("string")
        .readableSecondary("string")
        .role("string")
        .sqlVirtualMachineId("string")
        .build())
    .sqlVirtualMachineGroupId("string")
    .availabilityGroupName("string")
    .loadBalancerConfiguration(VirtualMachineAvailabilityGroupListenerLoadBalancerConfigurationArgs.builder()
        .loadBalancerId("string")
        .privateIpAddress("string")
        .probePort(0)
        .sqlVirtualMachineIds("string")
        .subnetId("string")
        .build())
    .multiSubnetIpConfigurations(VirtualMachineAvailabilityGroupListenerMultiSubnetIpConfigurationArgs.builder()
        .privateIpAddress("string")
        .sqlVirtualMachineId("string")
        .subnetId("string")
        .build())
    .name("string")
    .port(0)
    .build());

    virtual_machine_availability_group_listener_resource = azure.mssql.VirtualMachineAvailabilityGroupListener("virtualMachineAvailabilityGroupListenerResource",
    replicas=[{
        "commit": "string",
        "failover_mode": "string",
        "readable_secondary": "string",
        "role": "string",
        "sql_virtual_machine_id": "string",
    }],
    sql_virtual_machine_group_id="string",
    availability_group_name="string",
    load_balancer_configuration={
        "load_balancer_id": "string",
        "private_ip_address": "string",
        "probe_port": 0,
        "sql_virtual_machine_ids": ["string"],
        "subnet_id": "string",
    },
    multi_subnet_ip_configurations=[{
        "private_ip_address": "string",
        "sql_virtual_machine_id": "string",
        "subnet_id": "string",
    }],
    name="string",
    port=0)

    const virtualMachineAvailabilityGroupListenerResource = new azure.mssql.VirtualMachineAvailabilityGroupListener("virtualMachineAvailabilityGroupListenerResource", {
    replicas: [{
        commit: "string",
        failoverMode: "string",
        readableSecondary: "string",
        role: "string",
        sqlVirtualMachineId: "string",
    }],
    sqlVirtualMachineGroupId: "string",
    availabilityGroupName: "string",
    loadBalancerConfiguration: {
        loadBalancerId: "string",
        privateIpAddress: "string",
        probePort: 0,
        sqlVirtualMachineIds: ["string"],
        subnetId: "string",
    },
    multiSubnetIpConfigurations: [{
        privateIpAddress: "string",
        sqlVirtualMachineId: "string",
        subnetId: "string",
    }],
    name: "string",
    port: 0,
});

    type: azure:mssql:VirtualMachineAvailabilityGroupListener
properties:
    availabilityGroupName: string
    loadBalancerConfiguration:
        loadBalancerId: string
        privateIpAddress: string
        probePort: 0
        sqlVirtualMachineIds:
            - string
        subnetId: string
    multiSubnetIpConfigurations:
        - privateIpAddress: string
          sqlVirtualMachineId: string
          subnetId: string
    name: string
    port: 0
    replicas:
        - commit: string
          failoverMode: string
          readableSecondary: string
          role: string
          sqlVirtualMachineId: string
    sqlVirtualMachineGroupId: string

    VirtualMachineAvailabilityGroupListener Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The VirtualMachineAvailabilityGroupListener resource accepts the following input properties:

    Replicas List<VirtualMachineAvailabilityGroupListenerReplica>
    One or more replica blocks as defined below. Changing this forces a new resource to be created.
    SqlVirtualMachineGroupId string
    The ID of the SQL Virtual Machine Group to create the listener. Changing this forces a new resource to be created.
    AvailabilityGroupName string
    The name of the Availability Group. Changing this forces a new resource to be created.
    LoadBalancerConfiguration VirtualMachineAvailabilityGroupListenerLoadBalancerConfiguration

    A load_balancer_configuration block as defined below. Changing this forces a new resource to be created.

    NOTE: Either one of load_balancer_configuration or multi_subnet_ip_configuration must be specified.

    MultiSubnetIpConfigurations List<VirtualMachineAvailabilityGroupListenerMultiSubnetIpConfiguration>
    One or more multi_subnet_ip_configuration blocks as defined below. Changing this forces a new resource to be created.
    Name string
    The name which should be used for the Microsoft SQL Virtual Machine Availability Group Listener. Changing this forces a new resource to be created.
    Port int
    The port of the listener. Changing this forces a new resource to be created.
    Replicas []VirtualMachineAvailabilityGroupListenerReplicaArgs
    One or more replica blocks as defined below. Changing this forces a new resource to be created.
    SqlVirtualMachineGroupId string
    The ID of the SQL Virtual Machine Group to create the listener. Changing this forces a new resource to be created.
    AvailabilityGroupName string
    The name of the Availability Group. Changing this forces a new resource to be created.
    LoadBalancerConfiguration VirtualMachineAvailabilityGroupListenerLoadBalancerConfigurationArgs

    A load_balancer_configuration block as defined below. Changing this forces a new resource to be created.

    NOTE: Either one of load_balancer_configuration or multi_subnet_ip_configuration must be specified.

    MultiSubnetIpConfigurations []VirtualMachineAvailabilityGroupListenerMultiSubnetIpConfigurationArgs
    One or more multi_subnet_ip_configuration blocks as defined below. Changing this forces a new resource to be created.
    Name string
    The name which should be used for the Microsoft SQL Virtual Machine Availability Group Listener. Changing this forces a new resource to be created.
    Port int
    The port of the listener. Changing this forces a new resource to be created.
    replicas List<VirtualMachineAvailabilityGroupListenerReplica>
    One or more replica blocks as defined below. Changing this forces a new resource to be created.
    sqlVirtualMachineGroupId String
    The ID of the SQL Virtual Machine Group to create the listener. Changing this forces a new resource to be created.
    availabilityGroupName String
    The name of the Availability Group. Changing this forces a new resource to be created.
    loadBalancerConfiguration VirtualMachineAvailabilityGroupListenerLoadBalancerConfiguration

    A load_balancer_configuration block as defined below. Changing this forces a new resource to be created.

    NOTE: Either one of load_balancer_configuration or multi_subnet_ip_configuration must be specified.

    multiSubnetIpConfigurations List<VirtualMachineAvailabilityGroupListenerMultiSubnetIpConfiguration>
    One or more multi_subnet_ip_configuration blocks as defined below. Changing this forces a new resource to be created.
    name String
    The name which should be used for the Microsoft SQL Virtual Machine Availability Group Listener. Changing this forces a new resource to be created.
    port Integer
    The port of the listener. Changing this forces a new resource to be created.
    replicas VirtualMachineAvailabilityGroupListenerReplica[]
    One or more replica blocks as defined below. Changing this forces a new resource to be created.
    sqlVirtualMachineGroupId string
    The ID of the SQL Virtual Machine Group to create the listener. Changing this forces a new resource to be created.
    availabilityGroupName string
    The name of the Availability Group. Changing this forces a new resource to be created.
    loadBalancerConfiguration VirtualMachineAvailabilityGroupListenerLoadBalancerConfiguration

    A load_balancer_configuration block as defined below. Changing this forces a new resource to be created.

    NOTE: Either one of load_balancer_configuration or multi_subnet_ip_configuration must be specified.

    multiSubnetIpConfigurations VirtualMachineAvailabilityGroupListenerMultiSubnetIpConfiguration[]
    One or more multi_subnet_ip_configuration blocks as defined below. Changing this forces a new resource to be created.
    name string
    The name which should be used for the Microsoft SQL Virtual Machine Availability Group Listener. Changing this forces a new resource to be created.
    port number
    The port of the listener. Changing this forces a new resource to be created.
    replicas Sequence[VirtualMachineAvailabilityGroupListenerReplicaArgs]
    One or more replica blocks as defined below. Changing this forces a new resource to be created.
    sql_virtual_machine_group_id str
    The ID of the SQL Virtual Machine Group to create the listener. Changing this forces a new resource to be created.
    availability_group_name str
    The name of the Availability Group. Changing this forces a new resource to be created.
    load_balancer_configuration VirtualMachineAvailabilityGroupListenerLoadBalancerConfigurationArgs

    A load_balancer_configuration block as defined below. Changing this forces a new resource to be created.

    NOTE: Either one of load_balancer_configuration or multi_subnet_ip_configuration must be specified.

    multi_subnet_ip_configurations Sequence[VirtualMachineAvailabilityGroupListenerMultiSubnetIpConfigurationArgs]
    One or more multi_subnet_ip_configuration blocks as defined below. Changing this forces a new resource to be created.
    name str
    The name which should be used for the Microsoft SQL Virtual Machine Availability Group Listener. Changing this forces a new resource to be created.
    port int
    The port of the listener. Changing this forces a new resource to be created.
    replicas List<Property Map>
    One or more replica blocks as defined below. Changing this forces a new resource to be created.
    sqlVirtualMachineGroupId String
    The ID of the SQL Virtual Machine Group to create the listener. Changing this forces a new resource to be created.
    availabilityGroupName String
    The name of the Availability Group. Changing this forces a new resource to be created.
    loadBalancerConfiguration Property Map

    A load_balancer_configuration block as defined below. Changing this forces a new resource to be created.

    NOTE: Either one of load_balancer_configuration or multi_subnet_ip_configuration must be specified.

    multiSubnetIpConfigurations List<Property Map>
    One or more multi_subnet_ip_configuration blocks as defined below. Changing this forces a new resource to be created.
    name String
    The name which should be used for the Microsoft SQL Virtual Machine Availability Group Listener. Changing this forces a new resource to be created.
    port Number
    The port of the listener. Changing this forces a new resource to be created.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the VirtualMachineAvailabilityGroupListener 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 string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing VirtualMachineAvailabilityGroupListener Resource

    Get an existing VirtualMachineAvailabilityGroupListener 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?: VirtualMachineAvailabilityGroupListenerState, opts?: CustomResourceOptions): VirtualMachineAvailabilityGroupListener
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        availability_group_name: Optional[str] = None,
        load_balancer_configuration: Optional[VirtualMachineAvailabilityGroupListenerLoadBalancerConfigurationArgs] = None,
        multi_subnet_ip_configurations: Optional[Sequence[VirtualMachineAvailabilityGroupListenerMultiSubnetIpConfigurationArgs]] = None,
        name: Optional[str] = None,
        port: Optional[int] = None,
        replicas: Optional[Sequence[VirtualMachineAvailabilityGroupListenerReplicaArgs]] = None,
        sql_virtual_machine_group_id: Optional[str] = None) -> VirtualMachineAvailabilityGroupListener
    func GetVirtualMachineAvailabilityGroupListener(ctx *Context, name string, id IDInput, state *VirtualMachineAvailabilityGroupListenerState, opts ...ResourceOption) (*VirtualMachineAvailabilityGroupListener, error)
    public static VirtualMachineAvailabilityGroupListener Get(string name, Input<string> id, VirtualMachineAvailabilityGroupListenerState? state, CustomResourceOptions? opts = null)
    public static VirtualMachineAvailabilityGroupListener get(String name, Output<String> id, VirtualMachineAvailabilityGroupListenerState state, CustomResourceOptions options)
    resources:  _:    type: azure:mssql:VirtualMachineAvailabilityGroupListener    get:      id: ${id}
    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.
    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:
    AvailabilityGroupName string
    The name of the Availability Group. Changing this forces a new resource to be created.
    LoadBalancerConfiguration VirtualMachineAvailabilityGroupListenerLoadBalancerConfiguration

    A load_balancer_configuration block as defined below. Changing this forces a new resource to be created.

    NOTE: Either one of load_balancer_configuration or multi_subnet_ip_configuration must be specified.

    MultiSubnetIpConfigurations List<VirtualMachineAvailabilityGroupListenerMultiSubnetIpConfiguration>
    One or more multi_subnet_ip_configuration blocks as defined below. Changing this forces a new resource to be created.
    Name string
    The name which should be used for the Microsoft SQL Virtual Machine Availability Group Listener. Changing this forces a new resource to be created.
    Port int
    The port of the listener. Changing this forces a new resource to be created.
    Replicas List<VirtualMachineAvailabilityGroupListenerReplica>
    One or more replica blocks as defined below. Changing this forces a new resource to be created.
    SqlVirtualMachineGroupId string
    The ID of the SQL Virtual Machine Group to create the listener. Changing this forces a new resource to be created.
    AvailabilityGroupName string
    The name of the Availability Group. Changing this forces a new resource to be created.
    LoadBalancerConfiguration VirtualMachineAvailabilityGroupListenerLoadBalancerConfigurationArgs

    A load_balancer_configuration block as defined below. Changing this forces a new resource to be created.

    NOTE: Either one of load_balancer_configuration or multi_subnet_ip_configuration must be specified.

    MultiSubnetIpConfigurations []VirtualMachineAvailabilityGroupListenerMultiSubnetIpConfigurationArgs
    One or more multi_subnet_ip_configuration blocks as defined below. Changing this forces a new resource to be created.
    Name string
    The name which should be used for the Microsoft SQL Virtual Machine Availability Group Listener. Changing this forces a new resource to be created.
    Port int
    The port of the listener. Changing this forces a new resource to be created.
    Replicas []VirtualMachineAvailabilityGroupListenerReplicaArgs
    One or more replica blocks as defined below. Changing this forces a new resource to be created.
    SqlVirtualMachineGroupId string
    The ID of the SQL Virtual Machine Group to create the listener. Changing this forces a new resource to be created.
    availabilityGroupName String
    The name of the Availability Group. Changing this forces a new resource to be created.
    loadBalancerConfiguration VirtualMachineAvailabilityGroupListenerLoadBalancerConfiguration

    A load_balancer_configuration block as defined below. Changing this forces a new resource to be created.

    NOTE: Either one of load_balancer_configuration or multi_subnet_ip_configuration must be specified.

    multiSubnetIpConfigurations List<VirtualMachineAvailabilityGroupListenerMultiSubnetIpConfiguration>
    One or more multi_subnet_ip_configuration blocks as defined below. Changing this forces a new resource to be created.
    name String
    The name which should be used for the Microsoft SQL Virtual Machine Availability Group Listener. Changing this forces a new resource to be created.
    port Integer
    The port of the listener. Changing this forces a new resource to be created.
    replicas List<VirtualMachineAvailabilityGroupListenerReplica>
    One or more replica blocks as defined below. Changing this forces a new resource to be created.
    sqlVirtualMachineGroupId String
    The ID of the SQL Virtual Machine Group to create the listener. Changing this forces a new resource to be created.
    availabilityGroupName string
    The name of the Availability Group. Changing this forces a new resource to be created.
    loadBalancerConfiguration VirtualMachineAvailabilityGroupListenerLoadBalancerConfiguration

    A load_balancer_configuration block as defined below. Changing this forces a new resource to be created.

    NOTE: Either one of load_balancer_configuration or multi_subnet_ip_configuration must be specified.

    multiSubnetIpConfigurations VirtualMachineAvailabilityGroupListenerMultiSubnetIpConfiguration[]
    One or more multi_subnet_ip_configuration blocks as defined below. Changing this forces a new resource to be created.
    name string
    The name which should be used for the Microsoft SQL Virtual Machine Availability Group Listener. Changing this forces a new resource to be created.
    port number
    The port of the listener. Changing this forces a new resource to be created.
    replicas VirtualMachineAvailabilityGroupListenerReplica[]
    One or more replica blocks as defined below. Changing this forces a new resource to be created.
    sqlVirtualMachineGroupId string
    The ID of the SQL Virtual Machine Group to create the listener. Changing this forces a new resource to be created.
    availability_group_name str
    The name of the Availability Group. Changing this forces a new resource to be created.
    load_balancer_configuration VirtualMachineAvailabilityGroupListenerLoadBalancerConfigurationArgs

    A load_balancer_configuration block as defined below. Changing this forces a new resource to be created.

    NOTE: Either one of load_balancer_configuration or multi_subnet_ip_configuration must be specified.

    multi_subnet_ip_configurations Sequence[VirtualMachineAvailabilityGroupListenerMultiSubnetIpConfigurationArgs]
    One or more multi_subnet_ip_configuration blocks as defined below. Changing this forces a new resource to be created.
    name str
    The name which should be used for the Microsoft SQL Virtual Machine Availability Group Listener. Changing this forces a new resource to be created.
    port int
    The port of the listener. Changing this forces a new resource to be created.
    replicas Sequence[VirtualMachineAvailabilityGroupListenerReplicaArgs]
    One or more replica blocks as defined below. Changing this forces a new resource to be created.
    sql_virtual_machine_group_id str
    The ID of the SQL Virtual Machine Group to create the listener. Changing this forces a new resource to be created.
    availabilityGroupName String
    The name of the Availability Group. Changing this forces a new resource to be created.
    loadBalancerConfiguration Property Map

    A load_balancer_configuration block as defined below. Changing this forces a new resource to be created.

    NOTE: Either one of load_balancer_configuration or multi_subnet_ip_configuration must be specified.

    multiSubnetIpConfigurations List<Property Map>
    One or more multi_subnet_ip_configuration blocks as defined below. Changing this forces a new resource to be created.
    name String
    The name which should be used for the Microsoft SQL Virtual Machine Availability Group Listener. Changing this forces a new resource to be created.
    port Number
    The port of the listener. Changing this forces a new resource to be created.
    replicas List<Property Map>
    One or more replica blocks as defined below. Changing this forces a new resource to be created.
    sqlVirtualMachineGroupId String
    The ID of the SQL Virtual Machine Group to create the listener. Changing this forces a new resource to be created.

    Supporting Types

    VirtualMachineAvailabilityGroupListenerLoadBalancerConfiguration, VirtualMachineAvailabilityGroupListenerLoadBalancerConfigurationArgs

    LoadBalancerId string
    The ID of the Load Balancer. Changing this forces a new resource to be created.
    PrivateIpAddress string
    The private IP Address of the listener. Changing this forces a new resource to be created.
    ProbePort int
    The probe port of the listener. Changing this forces a new resource to be created.
    SqlVirtualMachineIds List<string>
    Specifies a list of SQL Virtual Machine IDs. Changing this forces a new resource to be created.
    SubnetId string

    The ID of the Subnet to create the listener. Changing this forces a new resource to be created.

    NOTE: sql_virtual_machine_ids should match with the SQL Virtual Machines specified in replica.

    LoadBalancerId string
    The ID of the Load Balancer. Changing this forces a new resource to be created.
    PrivateIpAddress string
    The private IP Address of the listener. Changing this forces a new resource to be created.
    ProbePort int
    The probe port of the listener. Changing this forces a new resource to be created.
    SqlVirtualMachineIds []string
    Specifies a list of SQL Virtual Machine IDs. Changing this forces a new resource to be created.
    SubnetId string

    The ID of the Subnet to create the listener. Changing this forces a new resource to be created.

    NOTE: sql_virtual_machine_ids should match with the SQL Virtual Machines specified in replica.

    loadBalancerId String
    The ID of the Load Balancer. Changing this forces a new resource to be created.
    privateIpAddress String
    The private IP Address of the listener. Changing this forces a new resource to be created.
    probePort Integer
    The probe port of the listener. Changing this forces a new resource to be created.
    sqlVirtualMachineIds List<String>
    Specifies a list of SQL Virtual Machine IDs. Changing this forces a new resource to be created.
    subnetId String

    The ID of the Subnet to create the listener. Changing this forces a new resource to be created.

    NOTE: sql_virtual_machine_ids should match with the SQL Virtual Machines specified in replica.

    loadBalancerId string
    The ID of the Load Balancer. Changing this forces a new resource to be created.
    privateIpAddress string
    The private IP Address of the listener. Changing this forces a new resource to be created.
    probePort number
    The probe port of the listener. Changing this forces a new resource to be created.
    sqlVirtualMachineIds string[]
    Specifies a list of SQL Virtual Machine IDs. Changing this forces a new resource to be created.
    subnetId string

    The ID of the Subnet to create the listener. Changing this forces a new resource to be created.

    NOTE: sql_virtual_machine_ids should match with the SQL Virtual Machines specified in replica.

    load_balancer_id str
    The ID of the Load Balancer. Changing this forces a new resource to be created.
    private_ip_address str
    The private IP Address of the listener. Changing this forces a new resource to be created.
    probe_port int
    The probe port of the listener. Changing this forces a new resource to be created.
    sql_virtual_machine_ids Sequence[str]
    Specifies a list of SQL Virtual Machine IDs. Changing this forces a new resource to be created.
    subnet_id str

    The ID of the Subnet to create the listener. Changing this forces a new resource to be created.

    NOTE: sql_virtual_machine_ids should match with the SQL Virtual Machines specified in replica.

    loadBalancerId String
    The ID of the Load Balancer. Changing this forces a new resource to be created.
    privateIpAddress String
    The private IP Address of the listener. Changing this forces a new resource to be created.
    probePort Number
    The probe port of the listener. Changing this forces a new resource to be created.
    sqlVirtualMachineIds List<String>
    Specifies a list of SQL Virtual Machine IDs. Changing this forces a new resource to be created.
    subnetId String

    The ID of the Subnet to create the listener. Changing this forces a new resource to be created.

    NOTE: sql_virtual_machine_ids should match with the SQL Virtual Machines specified in replica.

    VirtualMachineAvailabilityGroupListenerMultiSubnetIpConfiguration, VirtualMachineAvailabilityGroupListenerMultiSubnetIpConfigurationArgs

    PrivateIpAddress string
    The private IP Address of the listener. Changing this forces a new resource to be created.
    SqlVirtualMachineId string
    The ID of the Sql Virtual Machine. Changing this forces a new resource to be created.
    SubnetId string

    The ID of the Subnet to create the listener. Changing this forces a new resource to be created.

    NOTE: sql_virtual_machine_id should match with the SQL Virtual Machines specified in replica.

    PrivateIpAddress string
    The private IP Address of the listener. Changing this forces a new resource to be created.
    SqlVirtualMachineId string
    The ID of the Sql Virtual Machine. Changing this forces a new resource to be created.
    SubnetId string

    The ID of the Subnet to create the listener. Changing this forces a new resource to be created.

    NOTE: sql_virtual_machine_id should match with the SQL Virtual Machines specified in replica.

    privateIpAddress String
    The private IP Address of the listener. Changing this forces a new resource to be created.
    sqlVirtualMachineId String
    The ID of the Sql Virtual Machine. Changing this forces a new resource to be created.
    subnetId String

    The ID of the Subnet to create the listener. Changing this forces a new resource to be created.

    NOTE: sql_virtual_machine_id should match with the SQL Virtual Machines specified in replica.

    privateIpAddress string
    The private IP Address of the listener. Changing this forces a new resource to be created.
    sqlVirtualMachineId string
    The ID of the Sql Virtual Machine. Changing this forces a new resource to be created.
    subnetId string

    The ID of the Subnet to create the listener. Changing this forces a new resource to be created.

    NOTE: sql_virtual_machine_id should match with the SQL Virtual Machines specified in replica.

    private_ip_address str
    The private IP Address of the listener. Changing this forces a new resource to be created.
    sql_virtual_machine_id str
    The ID of the Sql Virtual Machine. Changing this forces a new resource to be created.
    subnet_id str

    The ID of the Subnet to create the listener. Changing this forces a new resource to be created.

    NOTE: sql_virtual_machine_id should match with the SQL Virtual Machines specified in replica.

    privateIpAddress String
    The private IP Address of the listener. Changing this forces a new resource to be created.
    sqlVirtualMachineId String
    The ID of the Sql Virtual Machine. Changing this forces a new resource to be created.
    subnetId String

    The ID of the Subnet to create the listener. Changing this forces a new resource to be created.

    NOTE: sql_virtual_machine_id should match with the SQL Virtual Machines specified in replica.

    VirtualMachineAvailabilityGroupListenerReplica, VirtualMachineAvailabilityGroupListenerReplicaArgs

    Commit string
    The replica commit mode for the availability group. Possible values are Synchronous_Commit and Asynchronous_Commit. Changing this forces a new resource to be created.
    FailoverMode string
    The replica failover mode for the availability group. Possible values are Manual and Automatic. Changing this forces a new resource to be created.
    ReadableSecondary string
    The replica readable secondary mode for the availability group. Possible values are No, Read_Only and All. Changing this forces a new resource to be created.
    Role string
    The replica role for the availability group. Possible values are Primary and Secondary. Changing this forces a new resource to be created.
    SqlVirtualMachineId string
    The ID of the SQL Virtual Machine. Changing this forces a new resource to be created.
    Commit string
    The replica commit mode for the availability group. Possible values are Synchronous_Commit and Asynchronous_Commit. Changing this forces a new resource to be created.
    FailoverMode string
    The replica failover mode for the availability group. Possible values are Manual and Automatic. Changing this forces a new resource to be created.
    ReadableSecondary string
    The replica readable secondary mode for the availability group. Possible values are No, Read_Only and All. Changing this forces a new resource to be created.
    Role string
    The replica role for the availability group. Possible values are Primary and Secondary. Changing this forces a new resource to be created.
    SqlVirtualMachineId string
    The ID of the SQL Virtual Machine. Changing this forces a new resource to be created.
    commit String
    The replica commit mode for the availability group. Possible values are Synchronous_Commit and Asynchronous_Commit. Changing this forces a new resource to be created.
    failoverMode String
    The replica failover mode for the availability group. Possible values are Manual and Automatic. Changing this forces a new resource to be created.
    readableSecondary String
    The replica readable secondary mode for the availability group. Possible values are No, Read_Only and All. Changing this forces a new resource to be created.
    role String
    The replica role for the availability group. Possible values are Primary and Secondary. Changing this forces a new resource to be created.
    sqlVirtualMachineId String
    The ID of the SQL Virtual Machine. Changing this forces a new resource to be created.
    commit string
    The replica commit mode for the availability group. Possible values are Synchronous_Commit and Asynchronous_Commit. Changing this forces a new resource to be created.
    failoverMode string
    The replica failover mode for the availability group. Possible values are Manual and Automatic. Changing this forces a new resource to be created.
    readableSecondary string
    The replica readable secondary mode for the availability group. Possible values are No, Read_Only and All. Changing this forces a new resource to be created.
    role string
    The replica role for the availability group. Possible values are Primary and Secondary. Changing this forces a new resource to be created.
    sqlVirtualMachineId string
    The ID of the SQL Virtual Machine. Changing this forces a new resource to be created.
    commit str
    The replica commit mode for the availability group. Possible values are Synchronous_Commit and Asynchronous_Commit. Changing this forces a new resource to be created.
    failover_mode str
    The replica failover mode for the availability group. Possible values are Manual and Automatic. Changing this forces a new resource to be created.
    readable_secondary str
    The replica readable secondary mode for the availability group. Possible values are No, Read_Only and All. Changing this forces a new resource to be created.
    role str
    The replica role for the availability group. Possible values are Primary and Secondary. Changing this forces a new resource to be created.
    sql_virtual_machine_id str
    The ID of the SQL Virtual Machine. Changing this forces a new resource to be created.
    commit String
    The replica commit mode for the availability group. Possible values are Synchronous_Commit and Asynchronous_Commit. Changing this forces a new resource to be created.
    failoverMode String
    The replica failover mode for the availability group. Possible values are Manual and Automatic. Changing this forces a new resource to be created.
    readableSecondary String
    The replica readable secondary mode for the availability group. Possible values are No, Read_Only and All. Changing this forces a new resource to be created.
    role String
    The replica role for the availability group. Possible values are Primary and Secondary. Changing this forces a new resource to be created.
    sqlVirtualMachineId String
    The ID of the SQL Virtual Machine. Changing this forces a new resource to be created.

    Import

    Microsoft SQL Virtual Machine Availability Group Listeners can be imported using the resource id, e.g.

    $ pulumi import azure:mssql/virtualMachineAvailabilityGroupListener:VirtualMachineAvailabilityGroupListener example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/vmgroup1/availabilityGroupListeners/listener1

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure v6.21.0 published on Friday, Mar 7, 2025 by Pulumi
    pulumi/pulumi-azure