server_connection_policies

Creates, updates, deletes, gets or lists a server_connection_policies resource.

Overview

Name	server_connection_policies
Type	Resource
Id	azure.sql.server_connection_policies

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
connectionType	string	The server connection type. Required. Known values are: "Default", "Redirect", and "Proxy". (Default, Redirect, Proxy)
kind	string	Metadata used for the Azure portal experience.
location	string	Resource location.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_server

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
connectionType	string	The server connection type. Required. Known values are: "Default", "Redirect", and "Proxy". (Default, Redirect, Proxy)
kind	string	Metadata used for the Azure portal experience.
location	string	Resource location.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, server_name, connection_policy_name, subscription_id		Gets a server connection policy.
list_by_server	select	resource_group_name, server_name, subscription_id		Lists connection policy.
create_or_update	insert	resource_group_name, server_name, connection_policy_name, subscription_id		Updates a server connection policy.
create_or_update	replace	resource_group_name, server_name, connection_policy_name, subscription_id		Updates a server connection policy.

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
connection_policy_name	string	The name of the connection policy. "default" Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
server_name	string	The name of the server. Required.
subscription_id	string

SELECT examples

get

Gets a server connection policy.

SELECT
id,
name,
connectionType,
kind,
location,
systemData,
type
FROM azure.sql.server_connection_policies
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND connection_policy_name = '{{ connection_policy_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_server

Lists connection policy.

SELECT
id,
name,
connectionType,
kind,
location,
systemData,
type
FROM azure.sql.server_connection_policies
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Updates a server connection policy.

INSERT INTO azure.sql.server_connection_policies (
properties,
resource_group_name,
server_name,
connection_policy_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ server_name }}',
'{{ connection_policy_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
kind,
location,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: server_connection_policies
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the server_connection_policies resource.
  - name: server_name
    value: "{{ server_name }}"
    description: Required parameter for the server_connection_policies resource.
  - name: connection_policy_name
    value: "{{ connection_policy_name }}"
    description: Required parameter for the server_connection_policies resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the server_connection_policies resource.
  - name: properties
    description: |
      Resource properties.
    value:
      connectionType: "{{ connectionType }}"

REPLACE examples

create_or_update

Updates a server connection policy.

REPLACE azure.sql.server_connection_policies
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND server_name = '{{ server_name }}' --required
AND connection_policy_name = '{{ connection_policy_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
kind,
location,
properties,
systemData,
type;