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
- list_by_server
Successfully retrieved the server connection policy.
Name | Datatype | Description |
---|---|---|
kind | string | Metadata used for the Azure portal experience. |
location | string | Resource location. |
properties | object | Resource properties. |
Successfully retrieved the server connection policy list
Name | Datatype | Description |
---|---|---|
kind | string | Metadata used for the Azure portal experience. |
location | string | Resource location. |
properties | object | Resource properties. |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
get | select | resourceGroupName , serverName , connectionPolicyName , subscriptionId | Gets a server connection policy | |
list_by_server | select | resourceGroupName , serverName , subscriptionId | Lists connection policy | |
create_or_update | insert | resourceGroupName , serverName , connectionPolicyName , subscriptionId | 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 |
---|---|---|
connectionPolicyName | string | The name of the connection policy. |
resourceGroupName | string | The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. |
serverName | string | The name of the server. |
subscriptionId | string | The subscription ID that identifies an Azure subscription. |
SELECT
examples
- get
- list_by_server
Gets a server connection policy
SELECT
kind,
location,
properties
FROM azure.sql.server_connection_policies
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serverName = '{{ serverName }}' -- required
AND connectionPolicyName = '{{ connectionPolicyName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;
Lists connection policy
SELECT
kind,
location,
properties
FROM azure.sql.server_connection_policies
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serverName = '{{ serverName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;
INSERT
examples
- create_or_update
- Manifest
Updates a server connection policy
INSERT INTO azure.sql.server_connection_policies (
data__properties,
resourceGroupName,
serverName,
connectionPolicyName,
subscriptionId
)
SELECT
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ serverName }}',
'{{ connectionPolicyName }}',
'{{ subscriptionId }}'
RETURNING
kind,
location,
properties
;
# Description fields are for documentation purposes
- name: server_connection_policies
props:
- name: resourceGroupName
value: string
description: Required parameter for the server_connection_policies resource.
- name: serverName
value: string
description: Required parameter for the server_connection_policies resource.
- name: connectionPolicyName
value: string
description: Required parameter for the server_connection_policies resource.
- name: subscriptionId
value: string
description: Required parameter for the server_connection_policies resource.
- name: properties
value: object
description: |
Resource properties.