1. Packages
  2. Azure Native
  3. API Docs
  4. sqlvirtualmachine
  5. getAvailabilityGroupListener
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.21.2 published on Friday, Dec 8, 2023 by Pulumi

azure-native.sqlvirtualmachine.getAvailabilityGroupListener

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.21.2 published on Friday, Dec 8, 2023 by Pulumi

    Gets an availability group listener. Azure REST API version: 2022-02-01.

    Other available API versions: 2023-01-01-preview.

    Using getAvailabilityGroupListener

    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 getAvailabilityGroupListener(args: GetAvailabilityGroupListenerArgs, opts?: InvokeOptions): Promise<GetAvailabilityGroupListenerResult>
    function getAvailabilityGroupListenerOutput(args: GetAvailabilityGroupListenerOutputArgs, opts?: InvokeOptions): Output<GetAvailabilityGroupListenerResult>
    def get_availability_group_listener(availability_group_listener_name: Optional[str] = None,
                                        expand: Optional[str] = None,
                                        resource_group_name: Optional[str] = None,
                                        sql_virtual_machine_group_name: Optional[str] = None,
                                        opts: Optional[InvokeOptions] = None) -> GetAvailabilityGroupListenerResult
    def get_availability_group_listener_output(availability_group_listener_name: Optional[pulumi.Input[str]] = None,
                                        expand: Optional[pulumi.Input[str]] = None,
                                        resource_group_name: Optional[pulumi.Input[str]] = None,
                                        sql_virtual_machine_group_name: Optional[pulumi.Input[str]] = None,
                                        opts: Optional[InvokeOptions] = None) -> Output[GetAvailabilityGroupListenerResult]
    func LookupAvailabilityGroupListener(ctx *Context, args *LookupAvailabilityGroupListenerArgs, opts ...InvokeOption) (*LookupAvailabilityGroupListenerResult, error)
    func LookupAvailabilityGroupListenerOutput(ctx *Context, args *LookupAvailabilityGroupListenerOutputArgs, opts ...InvokeOption) LookupAvailabilityGroupListenerResultOutput

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

    public static class GetAvailabilityGroupListener 
    {
        public static Task<GetAvailabilityGroupListenerResult> InvokeAsync(GetAvailabilityGroupListenerArgs args, InvokeOptions? opts = null)
        public static Output<GetAvailabilityGroupListenerResult> Invoke(GetAvailabilityGroupListenerInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetAvailabilityGroupListenerResult> getAvailabilityGroupListener(GetAvailabilityGroupListenerArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:sqlvirtualmachine:getAvailabilityGroupListener
      arguments:
        # arguments dictionary

    The following arguments are supported:

    AvailabilityGroupListenerName string

    Name of the availability group listener.

    ResourceGroupName string

    Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

    SqlVirtualMachineGroupName string

    Name of the SQL virtual machine group.

    Expand string

    The child resources to include in the response.

    AvailabilityGroupListenerName string

    Name of the availability group listener.

    ResourceGroupName string

    Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

    SqlVirtualMachineGroupName string

    Name of the SQL virtual machine group.

    Expand string

    The child resources to include in the response.

    availabilityGroupListenerName String

    Name of the availability group listener.

    resourceGroupName String

    Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

    sqlVirtualMachineGroupName String

    Name of the SQL virtual machine group.

    expand String

    The child resources to include in the response.

    availabilityGroupListenerName string

    Name of the availability group listener.

    resourceGroupName string

    Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

    sqlVirtualMachineGroupName string

    Name of the SQL virtual machine group.

    expand string

    The child resources to include in the response.

    availability_group_listener_name str

    Name of the availability group listener.

    resource_group_name str

    Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

    sql_virtual_machine_group_name str

    Name of the SQL virtual machine group.

    expand str

    The child resources to include in the response.

    availabilityGroupListenerName String

    Name of the availability group listener.

    resourceGroupName String

    Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

    sqlVirtualMachineGroupName String

    Name of the SQL virtual machine group.

    expand String

    The child resources to include in the response.

    getAvailabilityGroupListener Result

    The following output properties are available:

    Id string

    Resource ID.

    Name string

    Resource name.

    ProvisioningState string

    Provisioning state to track the async operation status.

    SystemData Pulumi.AzureNative.SqlVirtualMachine.Outputs.SystemDataResponse

    Metadata pertaining to creation and last modification of the resource.

    Type string

    Resource type.

    AvailabilityGroupConfiguration Pulumi.AzureNative.SqlVirtualMachine.Outputs.AgConfigurationResponse

    Availability Group configuration.

    AvailabilityGroupName string

    Name of the availability group.

    CreateDefaultAvailabilityGroupIfNotExist bool

    Create a default availability group if it does not exist.

    LoadBalancerConfigurations List<Pulumi.AzureNative.SqlVirtualMachine.Outputs.LoadBalancerConfigurationResponse>

    List of load balancer configurations for an availability group listener.

    MultiSubnetIpConfigurations List<Pulumi.AzureNative.SqlVirtualMachine.Outputs.MultiSubnetIpConfigurationResponse>

    List of multi subnet IP configurations for an AG listener.

    Port int

    Listener port.

    Id string

    Resource ID.

    Name string

    Resource name.

    ProvisioningState string

    Provisioning state to track the async operation status.

    SystemData SystemDataResponse

    Metadata pertaining to creation and last modification of the resource.

    Type string

    Resource type.

    AvailabilityGroupConfiguration AgConfigurationResponse

    Availability Group configuration.

    AvailabilityGroupName string

    Name of the availability group.

    CreateDefaultAvailabilityGroupIfNotExist bool

    Create a default availability group if it does not exist.

    LoadBalancerConfigurations []LoadBalancerConfigurationResponse

    List of load balancer configurations for an availability group listener.

    MultiSubnetIpConfigurations []MultiSubnetIpConfigurationResponse

    List of multi subnet IP configurations for an AG listener.

    Port int

    Listener port.

    id String

    Resource ID.

    name String

    Resource name.

    provisioningState String

    Provisioning state to track the async operation status.

    systemData SystemDataResponse

    Metadata pertaining to creation and last modification of the resource.

    type String

    Resource type.

    availabilityGroupConfiguration AgConfigurationResponse

    Availability Group configuration.

    availabilityGroupName String

    Name of the availability group.

    createDefaultAvailabilityGroupIfNotExist Boolean

    Create a default availability group if it does not exist.

    loadBalancerConfigurations List<LoadBalancerConfigurationResponse>

    List of load balancer configurations for an availability group listener.

    multiSubnetIpConfigurations List<MultiSubnetIpConfigurationResponse>

    List of multi subnet IP configurations for an AG listener.

    port Integer

    Listener port.

    id string

    Resource ID.

    name string

    Resource name.

    provisioningState string

    Provisioning state to track the async operation status.

    systemData SystemDataResponse

    Metadata pertaining to creation and last modification of the resource.

    type string

    Resource type.

    availabilityGroupConfiguration AgConfigurationResponse

    Availability Group configuration.

    availabilityGroupName string

    Name of the availability group.

    createDefaultAvailabilityGroupIfNotExist boolean

    Create a default availability group if it does not exist.

    loadBalancerConfigurations LoadBalancerConfigurationResponse[]

    List of load balancer configurations for an availability group listener.

    multiSubnetIpConfigurations MultiSubnetIpConfigurationResponse[]

    List of multi subnet IP configurations for an AG listener.

    port number

    Listener port.

    id str

    Resource ID.

    name str

    Resource name.

    provisioning_state str

    Provisioning state to track the async operation status.

    system_data SystemDataResponse

    Metadata pertaining to creation and last modification of the resource.

    type str

    Resource type.

    availability_group_configuration AgConfigurationResponse

    Availability Group configuration.

    availability_group_name str

    Name of the availability group.

    create_default_availability_group_if_not_exist bool

    Create a default availability group if it does not exist.

    load_balancer_configurations Sequence[LoadBalancerConfigurationResponse]

    List of load balancer configurations for an availability group listener.

    multi_subnet_ip_configurations Sequence[MultiSubnetIpConfigurationResponse]

    List of multi subnet IP configurations for an AG listener.

    port int

    Listener port.

    id String

    Resource ID.

    name String

    Resource name.

    provisioningState String

    Provisioning state to track the async operation status.

    systemData Property Map

    Metadata pertaining to creation and last modification of the resource.

    type String

    Resource type.

    availabilityGroupConfiguration Property Map

    Availability Group configuration.

    availabilityGroupName String

    Name of the availability group.

    createDefaultAvailabilityGroupIfNotExist Boolean

    Create a default availability group if it does not exist.

    loadBalancerConfigurations List<Property Map>

    List of load balancer configurations for an availability group listener.

    multiSubnetIpConfigurations List<Property Map>

    List of multi subnet IP configurations for an AG listener.

    port Number

    Listener port.

    Supporting Types

    AgConfigurationResponse

    Replicas []AgReplicaResponse

    Replica configurations.

    replicas List<AgReplicaResponse>

    Replica configurations.

    replicas AgReplicaResponse[]

    Replica configurations.

    replicas Sequence[AgReplicaResponse]

    Replica configurations.

    replicas List<Property Map>

    Replica configurations.

    AgReplicaResponse

    Commit string

    Replica commit mode in availability group.

    Failover string

    Replica failover mode in availability group.

    ReadableSecondary string

    Replica readable secondary mode in availability group.

    Role string

    Replica Role in availability group.

    SqlVirtualMachineInstanceId string

    Sql VirtualMachine Instance Id.

    Commit string

    Replica commit mode in availability group.

    Failover string

    Replica failover mode in availability group.

    ReadableSecondary string

    Replica readable secondary mode in availability group.

    Role string

    Replica Role in availability group.

    SqlVirtualMachineInstanceId string

    Sql VirtualMachine Instance Id.

    commit String

    Replica commit mode in availability group.

    failover String

    Replica failover mode in availability group.

    readableSecondary String

    Replica readable secondary mode in availability group.

    role String

    Replica Role in availability group.

    sqlVirtualMachineInstanceId String

    Sql VirtualMachine Instance Id.

    commit string

    Replica commit mode in availability group.

    failover string

    Replica failover mode in availability group.

    readableSecondary string

    Replica readable secondary mode in availability group.

    role string

    Replica Role in availability group.

    sqlVirtualMachineInstanceId string

    Sql VirtualMachine Instance Id.

    commit str

    Replica commit mode in availability group.

    failover str

    Replica failover mode in availability group.

    readable_secondary str

    Replica readable secondary mode in availability group.

    role str

    Replica Role in availability group.

    sql_virtual_machine_instance_id str

    Sql VirtualMachine Instance Id.

    commit String

    Replica commit mode in availability group.

    failover String

    Replica failover mode in availability group.

    readableSecondary String

    Replica readable secondary mode in availability group.

    role String

    Replica Role in availability group.

    sqlVirtualMachineInstanceId String

    Sql VirtualMachine Instance Id.

    LoadBalancerConfigurationResponse

    LoadBalancerResourceId string

    Resource id of the load balancer.

    PrivateIpAddress Pulumi.AzureNative.SqlVirtualMachine.Inputs.PrivateIPAddressResponse

    Private IP address.

    ProbePort int

    Probe port.

    PublicIpAddressResourceId string

    Resource id of the public IP.

    SqlVirtualMachineInstances List<string>

    List of the SQL virtual machine instance resource id's that are enrolled into the availability group listener.

    LoadBalancerResourceId string

    Resource id of the load balancer.

    PrivateIpAddress PrivateIPAddressResponse

    Private IP address.

    ProbePort int

    Probe port.

    PublicIpAddressResourceId string

    Resource id of the public IP.

    SqlVirtualMachineInstances []string

    List of the SQL virtual machine instance resource id's that are enrolled into the availability group listener.

    loadBalancerResourceId String

    Resource id of the load balancer.

    privateIpAddress PrivateIPAddressResponse

    Private IP address.

    probePort Integer

    Probe port.

    publicIpAddressResourceId String

    Resource id of the public IP.

    sqlVirtualMachineInstances List<String>

    List of the SQL virtual machine instance resource id's that are enrolled into the availability group listener.

    loadBalancerResourceId string

    Resource id of the load balancer.

    privateIpAddress PrivateIPAddressResponse

    Private IP address.

    probePort number

    Probe port.

    publicIpAddressResourceId string

    Resource id of the public IP.

    sqlVirtualMachineInstances string[]

    List of the SQL virtual machine instance resource id's that are enrolled into the availability group listener.

    load_balancer_resource_id str

    Resource id of the load balancer.

    private_ip_address PrivateIPAddressResponse

    Private IP address.

    probe_port int

    Probe port.

    public_ip_address_resource_id str

    Resource id of the public IP.

    sql_virtual_machine_instances Sequence[str]

    List of the SQL virtual machine instance resource id's that are enrolled into the availability group listener.

    loadBalancerResourceId String

    Resource id of the load balancer.

    privateIpAddress Property Map

    Private IP address.

    probePort Number

    Probe port.

    publicIpAddressResourceId String

    Resource id of the public IP.

    sqlVirtualMachineInstances List<String>

    List of the SQL virtual machine instance resource id's that are enrolled into the availability group listener.

    MultiSubnetIpConfigurationResponse

    PrivateIpAddress Pulumi.AzureNative.SqlVirtualMachine.Inputs.PrivateIPAddressResponse

    Private IP address.

    SqlVirtualMachineInstance string

    SQL virtual machine instance resource id that are enrolled into the availability group listener.

    PrivateIpAddress PrivateIPAddressResponse

    Private IP address.

    SqlVirtualMachineInstance string

    SQL virtual machine instance resource id that are enrolled into the availability group listener.

    privateIpAddress PrivateIPAddressResponse

    Private IP address.

    sqlVirtualMachineInstance String

    SQL virtual machine instance resource id that are enrolled into the availability group listener.

    privateIpAddress PrivateIPAddressResponse

    Private IP address.

    sqlVirtualMachineInstance string

    SQL virtual machine instance resource id that are enrolled into the availability group listener.

    private_ip_address PrivateIPAddressResponse

    Private IP address.

    sql_virtual_machine_instance str

    SQL virtual machine instance resource id that are enrolled into the availability group listener.

    privateIpAddress Property Map

    Private IP address.

    sqlVirtualMachineInstance String

    SQL virtual machine instance resource id that are enrolled into the availability group listener.

    PrivateIPAddressResponse

    IpAddress string

    Private IP address bound to the availability group listener.

    SubnetResourceId string

    Subnet used to include private IP.

    IpAddress string

    Private IP address bound to the availability group listener.

    SubnetResourceId string

    Subnet used to include private IP.

    ipAddress String

    Private IP address bound to the availability group listener.

    subnetResourceId String

    Subnet used to include private IP.

    ipAddress string

    Private IP address bound to the availability group listener.

    subnetResourceId string

    Subnet used to include private IP.

    ip_address str

    Private IP address bound to the availability group listener.

    subnet_resource_id str

    Subnet used to include private IP.

    ipAddress String

    Private IP address bound to the availability group listener.

    subnetResourceId String

    Subnet used to include private IP.

    SystemDataResponse

    CreatedAt string

    The timestamp of resource creation (UTC).

    CreatedBy string

    The identity that created the resource.

    CreatedByType string

    The type of identity that created the resource.

    LastModifiedAt string

    The timestamp of resource last modification (UTC)

    LastModifiedBy string

    The identity that last modified the resource.

    LastModifiedByType string

    The type of identity that last modified the resource.

    CreatedAt string

    The timestamp of resource creation (UTC).

    CreatedBy string

    The identity that created the resource.

    CreatedByType string

    The type of identity that created the resource.

    LastModifiedAt string

    The timestamp of resource last modification (UTC)

    LastModifiedBy string

    The identity that last modified the resource.

    LastModifiedByType string

    The type of identity that last modified the resource.

    createdAt String

    The timestamp of resource creation (UTC).

    createdBy String

    The identity that created the resource.

    createdByType String

    The type of identity that created the resource.

    lastModifiedAt String

    The timestamp of resource last modification (UTC)

    lastModifiedBy String

    The identity that last modified the resource.

    lastModifiedByType String

    The type of identity that last modified the resource.

    createdAt string

    The timestamp of resource creation (UTC).

    createdBy string

    The identity that created the resource.

    createdByType string

    The type of identity that created the resource.

    lastModifiedAt string

    The timestamp of resource last modification (UTC)

    lastModifiedBy string

    The identity that last modified the resource.

    lastModifiedByType string

    The type of identity that last modified the resource.

    created_at str

    The timestamp of resource creation (UTC).

    created_by str

    The identity that created the resource.

    created_by_type str

    The type of identity that created the resource.

    last_modified_at str

    The timestamp of resource last modification (UTC)

    last_modified_by str

    The identity that last modified the resource.

    last_modified_by_type str

    The type of identity that last modified the resource.

    createdAt String

    The timestamp of resource creation (UTC).

    createdBy String

    The identity that created the resource.

    createdByType String

    The type of identity that created the resource.

    lastModifiedAt String

    The timestamp of resource last modification (UTC)

    lastModifiedBy String

    The identity that last modified the resource.

    lastModifiedByType String

    The type of identity that last modified the resource.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.21.2 published on Friday, Dec 8, 2023 by Pulumi