azure-native.sqlvirtualmachine.getAvailabilityGroupListener
Explore with Pulumi AI
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:
- Availability
Group stringListener Name Name of the availability group listener.
- Resource
Group stringName 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 stringMachine Group Name Name of the SQL virtual machine group.
- Expand string
The child resources to include in the response.
- Availability
Group stringListener Name Name of the availability group listener.
- Resource
Group stringName 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 stringMachine Group Name Name of the SQL virtual machine group.
- Expand string
The child resources to include in the response.
- availability
Group StringListener Name Name of the availability group listener.
- resource
Group StringName 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 StringMachine Group Name Name of the SQL virtual machine group.
- expand String
The child resources to include in the response.
- availability
Group stringListener Name Name of the availability group listener.
- resource
Group stringName 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 stringMachine Group Name Name of the SQL virtual machine group.
- expand string
The child resources to include in the response.
- availability_
group_ strlistener_ name Name of the availability group listener.
- resource_
group_ strname 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_ strmachine_ group_ name Name of the SQL virtual machine group.
- expand str
The child resources to include in the response.
- availability
Group StringListener Name Name of the availability group listener.
- resource
Group StringName 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 StringMachine Group Name 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.
- Provisioning
State string Provisioning state to track the async operation status.
- System
Data Pulumi.Azure Native. Sql Virtual Machine. Outputs. System Data Response Metadata pertaining to creation and last modification of the resource.
- Type string
Resource type.
- Availability
Group Pulumi.Configuration Azure Native. Sql Virtual Machine. Outputs. Ag Configuration Response Availability Group configuration.
- Availability
Group stringName Name of the availability group.
- Create
Default boolAvailability Group If Not Exist Create a default availability group if it does not exist.
- Load
Balancer List<Pulumi.Configurations Azure Native. Sql Virtual Machine. Outputs. Load Balancer Configuration Response> List of load balancer configurations for an availability group listener.
- Multi
Subnet List<Pulumi.Ip Configurations Azure Native. Sql Virtual Machine. Outputs. Multi Subnet Ip Configuration Response> List of multi subnet IP configurations for an AG listener.
- Port int
Listener port.
- Id string
Resource ID.
- Name string
Resource name.
- Provisioning
State string Provisioning state to track the async operation status.
- System
Data SystemData Response Metadata pertaining to creation and last modification of the resource.
- Type string
Resource type.
- Availability
Group AgConfiguration Configuration Response Availability Group configuration.
- Availability
Group stringName Name of the availability group.
- Create
Default boolAvailability Group If Not Exist Create a default availability group if it does not exist.
- Load
Balancer []LoadConfigurations Balancer Configuration Response List of load balancer configurations for an availability group listener.
- Multi
Subnet []MultiIp Configurations Subnet Ip Configuration Response List of multi subnet IP configurations for an AG listener.
- Port int
Listener port.
- id String
Resource ID.
- name String
Resource name.
- provisioning
State String Provisioning state to track the async operation status.
- system
Data SystemData Response Metadata pertaining to creation and last modification of the resource.
- type String
Resource type.
- availability
Group AgConfiguration Configuration Response Availability Group configuration.
- availability
Group StringName Name of the availability group.
- create
Default BooleanAvailability Group If Not Exist Create a default availability group if it does not exist.
- load
Balancer List<LoadConfigurations Balancer Configuration Response> List of load balancer configurations for an availability group listener.
- multi
Subnet List<MultiIp Configurations Subnet Ip Configuration Response> List of multi subnet IP configurations for an AG listener.
- port Integer
Listener port.
- id string
Resource ID.
- name string
Resource name.
- provisioning
State string Provisioning state to track the async operation status.
- system
Data SystemData Response Metadata pertaining to creation and last modification of the resource.
- type string
Resource type.
- availability
Group AgConfiguration Configuration Response Availability Group configuration.
- availability
Group stringName Name of the availability group.
- create
Default booleanAvailability Group If Not Exist Create a default availability group if it does not exist.
- load
Balancer LoadConfigurations Balancer Configuration Response[] List of load balancer configurations for an availability group listener.
- multi
Subnet MultiIp Configurations Subnet Ip Configuration Response[] 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 SystemData Response Metadata pertaining to creation and last modification of the resource.
- type str
Resource type.
- availability_
group_ Agconfiguration Configuration Response Availability Group configuration.
- availability_
group_ strname Name of the availability group.
- create_
default_ boolavailability_ group_ if_ not_ exist Create a default availability group if it does not exist.
- load_
balancer_ Sequence[Loadconfigurations Balancer Configuration Response] List of load balancer configurations for an availability group listener.
- multi_
subnet_ Sequence[Multiip_ configurations Subnet Ip Configuration Response] List of multi subnet IP configurations for an AG listener.
- port int
Listener port.
- id String
Resource ID.
- name String
Resource name.
- provisioning
State String Provisioning state to track the async operation status.
- system
Data Property Map Metadata pertaining to creation and last modification of the resource.
- type String
Resource type.
- availability
Group Property MapConfiguration Availability Group configuration.
- availability
Group StringName Name of the availability group.
- create
Default BooleanAvailability Group If Not Exist Create a default availability group if it does not exist.
- load
Balancer List<Property Map>Configurations List of load balancer configurations for an availability group listener.
- multi
Subnet List<Property Map>Ip Configurations List of multi subnet IP configurations for an AG listener.
- port Number
Listener port.
Supporting Types
AgConfigurationResponse
- Replicas
List<Pulumi.
Azure Native. Sql Virtual Machine. Inputs. Ag Replica Response> Replica configurations.
- Replicas
[]Ag
Replica Response Replica configurations.
- replicas
List<Ag
Replica Response> Replica configurations.
- replicas
Ag
Replica Response[] Replica configurations.
- replicas
Sequence[Ag
Replica Response] 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.
- Readable
Secondary string Replica readable secondary mode in availability group.
- Role string
Replica Role in availability group.
- Sql
Virtual stringMachine Instance Id Sql VirtualMachine Instance Id.
- Commit string
Replica commit mode in availability group.
- Failover string
Replica failover mode in availability group.
- Readable
Secondary string Replica readable secondary mode in availability group.
- Role string
Replica Role in availability group.
- Sql
Virtual stringMachine Instance Id Sql VirtualMachine Instance Id.
- commit String
Replica commit mode in availability group.
- failover String
Replica failover mode in availability group.
- readable
Secondary String Replica readable secondary mode in availability group.
- role String
Replica Role in availability group.
- sql
Virtual StringMachine Instance Id Sql VirtualMachine Instance Id.
- commit string
Replica commit mode in availability group.
- failover string
Replica failover mode in availability group.
- readable
Secondary string Replica readable secondary mode in availability group.
- role string
Replica Role in availability group.
- sql
Virtual stringMachine Instance Id 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_ strmachine_ instance_ id Sql VirtualMachine Instance Id.
- commit String
Replica commit mode in availability group.
- failover String
Replica failover mode in availability group.
- readable
Secondary String Replica readable secondary mode in availability group.
- role String
Replica Role in availability group.
- sql
Virtual StringMachine Instance Id Sql VirtualMachine Instance Id.
LoadBalancerConfigurationResponse
- Load
Balancer stringResource Id Resource id of the load balancer.
- Private
Ip Pulumi.Address Azure Native. Sql Virtual Machine. Inputs. Private IPAddress Response Private IP address.
- Probe
Port int Probe port.
- Public
Ip stringAddress Resource Id Resource id of the public IP.
- Sql
Virtual List<string>Machine Instances List of the SQL virtual machine instance resource id's that are enrolled into the availability group listener.
- Load
Balancer stringResource Id Resource id of the load balancer.
- Private
Ip PrivateAddress IPAddress Response Private IP address.
- Probe
Port int Probe port.
- Public
Ip stringAddress Resource Id Resource id of the public IP.
- Sql
Virtual []stringMachine Instances List of the SQL virtual machine instance resource id's that are enrolled into the availability group listener.
- load
Balancer StringResource Id Resource id of the load balancer.
- private
Ip PrivateAddress IPAddress Response Private IP address.
- probe
Port Integer Probe port.
- public
Ip StringAddress Resource Id Resource id of the public IP.
- sql
Virtual List<String>Machine Instances List of the SQL virtual machine instance resource id's that are enrolled into the availability group listener.
- load
Balancer stringResource Id Resource id of the load balancer.
- private
Ip PrivateAddress IPAddress Response Private IP address.
- probe
Port number Probe port.
- public
Ip stringAddress Resource Id Resource id of the public IP.
- sql
Virtual string[]Machine Instances List of the SQL virtual machine instance resource id's that are enrolled into the availability group listener.
- load_
balancer_ strresource_ id Resource id of the load balancer.
- private_
ip_ Privateaddress IPAddress Response Private IP address.
- probe_
port int Probe port.
- public_
ip_ straddress_ resource_ id Resource id of the public IP.
- sql_
virtual_ Sequence[str]machine_ instances List of the SQL virtual machine instance resource id's that are enrolled into the availability group listener.
- load
Balancer StringResource Id Resource id of the load balancer.
- private
Ip Property MapAddress Private IP address.
- probe
Port Number Probe port.
- public
Ip StringAddress Resource Id Resource id of the public IP.
- sql
Virtual List<String>Machine Instances List of the SQL virtual machine instance resource id's that are enrolled into the availability group listener.
MultiSubnetIpConfigurationResponse
- Private
Ip Pulumi.Address Azure Native. Sql Virtual Machine. Inputs. Private IPAddress Response Private IP address.
- Sql
Virtual stringMachine Instance SQL virtual machine instance resource id that are enrolled into the availability group listener.
- Private
Ip PrivateAddress IPAddress Response Private IP address.
- Sql
Virtual stringMachine Instance SQL virtual machine instance resource id that are enrolled into the availability group listener.
- private
Ip PrivateAddress IPAddress Response Private IP address.
- sql
Virtual StringMachine Instance SQL virtual machine instance resource id that are enrolled into the availability group listener.
- private
Ip PrivateAddress IPAddress Response Private IP address.
- sql
Virtual stringMachine Instance SQL virtual machine instance resource id that are enrolled into the availability group listener.
- private_
ip_ Privateaddress IPAddress Response Private IP address.
- sql_
virtual_ strmachine_ instance SQL virtual machine instance resource id that are enrolled into the availability group listener.
- private
Ip Property MapAddress Private IP address.
- sql
Virtual StringMachine Instance SQL virtual machine instance resource id that are enrolled into the availability group listener.
PrivateIPAddressResponse
- Ip
Address string Private IP address bound to the availability group listener.
- Subnet
Resource stringId Subnet used to include private IP.
- Ip
Address string Private IP address bound to the availability group listener.
- Subnet
Resource stringId Subnet used to include private IP.
- ip
Address String Private IP address bound to the availability group listener.
- subnet
Resource StringId Subnet used to include private IP.
- ip
Address string Private IP address bound to the availability group listener.
- subnet
Resource stringId Subnet used to include private IP.
- ip_
address str Private IP address bound to the availability group listener.
- subnet_
resource_ strid Subnet used to include private IP.
- ip
Address String Private IP address bound to the availability group listener.
- subnet
Resource StringId Subnet used to include private IP.
SystemDataResponse
- Created
At string The timestamp of resource creation (UTC).
- Created
By string The identity that created the resource.
- Created
By stringType The type of identity that created the resource.
- Last
Modified stringAt The timestamp of resource last modification (UTC)
- Last
Modified stringBy The identity that last modified the resource.
- Last
Modified stringBy Type The type of identity that last modified the resource.
- Created
At string The timestamp of resource creation (UTC).
- Created
By string The identity that created the resource.
- Created
By stringType The type of identity that created the resource.
- Last
Modified stringAt The timestamp of resource last modification (UTC)
- Last
Modified stringBy The identity that last modified the resource.
- Last
Modified stringBy Type The type of identity that last modified the resource.
- created
At String The timestamp of resource creation (UTC).
- created
By String The identity that created the resource.
- created
By StringType The type of identity that created the resource.
- last
Modified StringAt The timestamp of resource last modification (UTC)
- last
Modified StringBy The identity that last modified the resource.
- last
Modified StringBy Type The type of identity that last modified the resource.
- created
At string The timestamp of resource creation (UTC).
- created
By string The identity that created the resource.
- created
By stringType The type of identity that created the resource.
- last
Modified stringAt The timestamp of resource last modification (UTC)
- last
Modified stringBy The identity that last modified the resource.
- last
Modified stringBy Type 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_ strtype The type of identity that created the resource.
- last_
modified_ strat The timestamp of resource last modification (UTC)
- last_
modified_ strby The identity that last modified the resource.
- last_
modified_ strby_ type The type of identity that last modified the resource.
- created
At String The timestamp of resource creation (UTC).
- created
By String The identity that created the resource.
- created
By StringType The type of identity that created the resource.
- last
Modified StringAt The timestamp of resource last modification (UTC)
- last
Modified StringBy The identity that last modified the resource.
- last
Modified StringBy Type The type of identity that last modified the resource.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0