Sql Pool Connection Policies - Get
Get a Sql pool's connection policy, which is used with table auditing.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/connectionPolicies/default?api-version=2021-06-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
connection
|
path | True |
The name of the connection policy. |
|
resource
|
path | True |
string |
The name of the resource group. The name is case insensitive. |
sql
|
path | True |
string |
SQL pool name |
subscription
|
path | True |
string |
The ID of the target subscription. |
workspace
|
path | True |
string |
The name of the workspace. |
api-version
|
query | True |
string |
The API version to use for this operation. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
Examples
Get a connection policy of a SQL Analytics pool
Sample Request
Sample Response
{
"id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/blobauditingtest-6852/providers/Microsoft.Synapse/workspaces/blobauditingtest-2080/sqlPools/testdb/connectionPolicies/default",
"name": "default",
"type": "Microsoft.Synapse/workspaces/sqlPools/connectionPolicies",
"location": "West US",
"kind": null,
"properties": {
"securityEnabledAccess": "Optional",
"proxyDnsName": "blobauditingtest-2080.database.secure.windows.net",
"proxyPort": "1433",
"visibility": "Visible",
"useServerDefault": "Enabled",
"redirectionState": "Disabled",
"state": "New"
}
}
Definitions
Name | Description |
---|---|
Connection |
The name of the connection policy. |
Error |
The resource management error additional info. |
Error |
The error detail. |
Error |
Error response |
Sql |
A Sql pool connection policy. |
ConnectionPolicyName
The name of the connection policy.
Name | Type | Description |
---|---|---|
default |
string |
ErrorAdditionalInfo
The resource management error additional info.
Name | Type | Description |
---|---|---|
info |
object |
The additional info. |
type |
string |
The additional info type. |
ErrorDetail
The error detail.
Name | Type | Description |
---|---|---|
additionalInfo |
The error additional info. |
|
code |
string |
The error code. |
details |
The error details. |
|
message |
string |
The error message. |
target |
string |
The error target. |
ErrorResponse
Error response
Name | Type | Description |
---|---|---|
error |
The error object. |
SqlPoolConnectionPolicy
A Sql pool connection policy.
Name | Type | Description |
---|---|---|
id |
string |
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
kind |
string |
Resource kind. |
location |
string |
Resource location. |
name |
string |
The name of the resource |
properties.proxyDnsName |
string |
The fully qualified host name of the auditing proxy. |
properties.proxyPort |
string |
The port number of the auditing proxy. |
properties.redirectionState |
string |
The state of proxy redirection. |
properties.securityEnabledAccess |
string |
The state of security access. |
properties.state |
string |
The connection policy state. |
properties.useServerDefault |
string |
Whether server default is enabled or disabled. |
properties.visibility |
string |
The visibility of the auditing proxy. |
type |
string |
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |