availability_group_listeners

Creates, updates, deletes, gets or lists an availability_group_listeners resource.

Overview

Name	availability_group_listeners
Type	Resource
Id	azure.sql_vm.availability_group_listeners

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved the availability group listener.

Name	Datatype	Description
properties	object	Resource properties.
systemData	object	Metadata pertaining to creation and last modification of the resource.

list_by_group

Successfully retrieved all availability group listeners in a SQL virtual machine group.

Name	Datatype	Description
properties	object	Resource properties.
systemData	object	Metadata pertaining to creation and last modification of the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, sqlVirtualMachineGroupName, availabilityGroupListenerName, subscriptionId	$expand	Gets an availability group listener.
list_by_group	select	resourceGroupName, sqlVirtualMachineGroupName, subscriptionId		Lists all availability group listeners in a SQL virtual machine group.
create_or_update	insert	resourceGroupName, sqlVirtualMachineGroupName, availabilityGroupListenerName, subscriptionId		Creates or updates an availability group listener.
delete	delete	resourceGroupName, sqlVirtualMachineGroupName, availabilityGroupListenerName, subscriptionId		Deletes an availability group listener.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
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.
subscriptionId	string	The ID of the target subscription.
$expand	string	The child resources to include in the response.

SELECT examples

get

Gets an availability group listener.

SELECT
properties,
systemData
FROM azure.sql_vm.availability_group_listeners
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND sqlVirtualMachineGroupName = '{{ sqlVirtualMachineGroupName }}' -- required
AND availabilityGroupListenerName = '{{ availabilityGroupListenerName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $expand = '{{ $expand }}'
;

list_by_group

Lists all availability group listeners in a SQL virtual machine group.

SELECT
properties,
systemData
FROM azure.sql_vm.availability_group_listeners
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND sqlVirtualMachineGroupName = '{{ sqlVirtualMachineGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates an availability group listener.

INSERT INTO azure.sql_vm.availability_group_listeners (
data__properties,
resourceGroupName,
sqlVirtualMachineGroupName,
availabilityGroupListenerName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ sqlVirtualMachineGroupName }}',
'{{ availabilityGroupListenerName }}',
'{{ subscriptionId }}'
RETURNING
properties,
systemData
;

Manifest

# Description fields are for documentation purposes
- name: availability_group_listeners
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the availability_group_listeners resource.
    - name: sqlVirtualMachineGroupName
      value: string
      description: Required parameter for the availability_group_listeners resource.
    - name: availabilityGroupListenerName
      value: string
      description: Required parameter for the availability_group_listeners resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the availability_group_listeners resource.
    - name: properties
      value: object
      description: |
        Resource properties.

DELETE examples

delete

Deletes an availability group listener.

DELETE FROM azure.sql_vm.availability_group_listeners
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND sqlVirtualMachineGroupName = '{{ sqlVirtualMachineGroupName }}' --required
AND availabilityGroupListenerName = '{{ availabilityGroupListenerName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;