Sql Pool Connection Policies - Get

Service:

Synapse

API Version:

2021-06-01

Obtenga la directiva de conexión de un grupo de Sql, que se usa con la auditoría de tablas.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/connectionPolicies/default?api-version=2021-06-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
connectionPolicyName	path	True	ConnectionPolicyName	Nombre de la directiva de conexión.
resourceGroupName	path	True	string	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
sqlPoolName	path	True	string	Nombre del grupo de SQL
subscriptionId	path	True	string	Identificador de la suscripción de destino.
workspaceName	path	True	string	El nombre del área de trabajo.
api-version	query	True	string	Versión de API que se usará para la operación.

Respuestas

Nombre	Tipo	Description
200 OK	SqlPoolConnectionPolicy	Aceptar
Other Status Codes	ErrorResponse

Ejemplos

Get a connection policy of a SQL Analytics pool

Sample Request

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/blobauditingtest-6852/providers/Microsoft.Synapse/workspaces/blobauditingtest-2080/sqlPools/testdb/connectionPolicies/default?api-version=2021-06-01

Java

import com.azure.resourcemanager.synapse.models.ConnectionPolicyName;

/** Samples for SqlPoolConnectionPolicies Get. */
public final class Main {
    /*
     * x-ms-original-file: specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/GetSqlPoolConnectionPolicy.json
     */
    /**
     * Sample code: Get a connection policy of a SQL Analytics pool.
     *
     * @param manager Entry point to SynapseManager.
     */
    public static void getAConnectionPolicyOfASQLAnalyticsPool(
        com.azure.resourcemanager.synapse.SynapseManager manager) {
        manager
            .sqlPoolConnectionPolicies()
            .getWithResponse(
                "blobauditingtest-6852",
                "blobauditingtest-2080",
                "testdb",
                ConnectionPolicyName.DEFAULT,
                com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.synapse import SynapseManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-synapse
# USAGE
    python get_sql_pool_connection_policy.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = SynapseManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-1111-2222-3333-444444444444",
    )

    response = client.sql_pool_connection_policies.get(
        resource_group_name="blobauditingtest-6852",
        workspace_name="blobauditingtest-2080",
        sql_pool_name="testdb",
        connection_policy_name="default",
    )
    print(response)


# x-ms-original-file: specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/GetSqlPoolConnectionPolicy.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armsynapse_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/GetSqlPoolConnectionPolicy.json
func ExampleSQLPoolConnectionPoliciesClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSQLPoolConnectionPoliciesClient().Get(ctx, "blobauditingtest-6852", "blobauditingtest-2080", "testdb", armsynapse.ConnectionPolicyNameDefault, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.SQLPoolConnectionPolicy = armsynapse.SQLPoolConnectionPolicy{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/connectionPolicies"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/blobauditingtest-6852/providers/Microsoft.Synapse/workspaces/blobauditingtest-2080/sqlPools/testdb/connectionPolicies/default"),
	// 	Location: to.Ptr("West US"),
	// 	Properties: &armsynapse.SQLPoolConnectionPolicyProperties{
	// 		ProxyDNSName: to.Ptr("blobauditingtest-2080.database.secure.windows.net"),
	// 		ProxyPort: to.Ptr("1433"),
	// 		RedirectionState: to.Ptr("Disabled"),
	// 		SecurityEnabledAccess: to.Ptr("Optional"),
	// 		State: to.Ptr("New"),
	// 		UseServerDefault: to.Ptr("Enabled"),
	// 		Visibility: to.Ptr("Visible"),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { SynapseManagementClient } = require("@azure/arm-synapse");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Get a Sql pool's connection policy, which is used with table auditing.
 *
 * @summary Get a Sql pool's connection policy, which is used with table auditing.
 * x-ms-original-file: specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/GetSqlPoolConnectionPolicy.json
 */
async function getAConnectionPolicyOfASqlAnalyticsPool() {
  const subscriptionId =
    process.env["SYNAPSE_SUBSCRIPTION_ID"] || "00000000-1111-2222-3333-444444444444";
  const resourceGroupName = process.env["SYNAPSE_RESOURCE_GROUP"] || "blobauditingtest-6852";
  const workspaceName = "blobauditingtest-2080";
  const sqlPoolName = "testdb";
  const connectionPolicyName = "default";
  const credential = new DefaultAzureCredential();
  const client = new SynapseManagementClient(credential, subscriptionId);
  const result = await client.sqlPoolConnectionPolicies.get(
    resourceGroupName,
    workspaceName,
    sqlPoolName,
    connectionPolicyName
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Synapse;
using Azure.ResourceManager.Synapse.Models;

// Generated from example definition: specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/GetSqlPoolConnectionPolicy.json
// this example is just showing the usage of "SqlPoolConnectionPolicies_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SynapseSqlPoolResource created on azure
// for more information of creating SynapseSqlPoolResource, please refer to the document of SynapseSqlPoolResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "blobauditingtest-6852";
string workspaceName = "blobauditingtest-2080";
string sqlPoolName = "testdb";
ResourceIdentifier synapseSqlPoolResourceId = SynapseSqlPoolResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, workspaceName, sqlPoolName);
SynapseSqlPoolResource synapseSqlPool = client.GetSynapseSqlPoolResource(synapseSqlPoolResourceId);

// get the collection of this SynapseSqlPoolConnectionPolicyResource
SynapseSqlPoolConnectionPolicyCollection collection = synapseSqlPool.GetSynapseSqlPoolConnectionPolicies();

// invoke the operation
SqlPoolConnectionPolicyName connectionPolicyName = SqlPoolConnectionPolicyName.Default;
NullableResponse<SynapseSqlPoolConnectionPolicyResource> response = await collection.GetIfExistsAsync(connectionPolicyName);
SynapseSqlPoolConnectionPolicyResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine($"Succeeded with null as result");
}
else
{
    // the variable result is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    SynapseSqlPoolConnectionPolicyData resourceData = result.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "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"
  }
}

Definiciones

Nombre	Description
ConnectionPolicyName	Nombre de la directiva de conexión.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
SqlPoolConnectionPolicy	Una directiva de conexión del grupo de Sql.

ConnectionPolicyName

Nombre de la directiva de conexión.

Nombre	Tipo	Description
default	string

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Los detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

SqlPoolConnectionPolicy

Una directiva de conexión del grupo de Sql.

Nombre	Tipo	Description
id	string	Identificador de recurso completo del recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind	string	Tipo de recurso.
location	string	Ubicación del recurso
name	string	Nombre del recurso.
properties.proxyDnsName	string	Nombre de host completo del proxy de auditoría.
properties.proxyPort	string	Número de puerto del proxy de auditoría.
properties.redirectionState	string	Estado del redireccionamiento de proxy.
properties.securityEnabledAccess	string	Estado del acceso de seguridad.
properties.state	string	Estado de la directiva de conexión.
properties.useServerDefault	string	Si el valor predeterminado del servidor está habilitado o deshabilitado.
properties.visibility	string	Visibilidad del proxy de auditoría.
type	string	Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"