Skip to main content

account_connections

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

Overview​

Nameaccount_connections
TypeResource
Idazure.cognitive_services.account_connections

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
idstringFully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
namestringThe name of the resource.
authTypestringAuthentication type of the connection target. Required. Known values are: "PAT", "ManagedIdentity", "UsernamePassword", "None", "SAS", "AccountKey", "ServicePrincipal", "AccessKey", "ApiKey", "CustomKeys", "OAuth2", "AAD", "DelegatedSAS", "ProjectManagedIdentity", "AccountManagedIdentity", "UserEntraToken", "AgentUserImpersonation", "AgenticIdentityToken", and "AgenticUser".
categorystringCategory of the connection. Known values are: "PythonFeed", "ContainerRegistry", "Git", "S3", "Snowflake", "AzureKeyVault", "AzureSqlDb", "AzureSynapseAnalytics", "AzureMySqlDb", "AzurePostgresDb", "ADLSGen2", "AzureContainerAppEnvironment", "Redis", "ApiKey", "AzureOpenAI", "AIServices", "CognitiveSearch", "CognitiveService", "CustomKeys", "AzureBlob", "AzureStorageAccount", "AzureOneLake", "CosmosDb", "CosmosDbMongoDbApi", "AzureDataExplorer", "AzureMariaDb", "AzureDatabricksDeltaLake", "AzureSqlMi", "AzureTableStorage", "AmazonRdsForOracle", "AmazonRdsForSqlServer", "AmazonRedshift", "Db2", "Drill", "GoogleBigQuery", "Greenplum", "Hbase", "Hive", "Impala", "Informix", "MariaDb", "MicrosoftAccess", "MySql", "Netezza", "Oracle", "Phoenix", "PostgreSql", "Presto", "SapOpenHub", "SapBw", "SapHana", "SapTable", "Spark", "SqlServer", "Sybase", "Teradata", "Vertica", "Pinecone", "Databricks", "Cassandra", "Couchbase", "MongoDbV2", "MongoDbAtlas", "AmazonS3Compatible", "FileServer", "FtpServer", "GoogleCloudStorage", "Hdfs", "OracleCloudStorage", "Sftp", "GenericHttp", "ODataRest", "Odbc", "GenericRest", "RemoteTool", "AmazonMws", "Concur", "Dynamics", "DynamicsAx", "DynamicsCrm", "GoogleAdWords", "Hubspot", "Jira", "Magento", "Marketo", "Office365", "Eloqua", "Responsys", "OracleServiceCloud", "PayPal", "QuickBooks", "Salesforce", "SalesforceServiceCloud", "SalesforceMarketingCloud", "SapCloudForCustomer", "SapEcc", "ServiceNow", "SharePointOnlineList", "Shopify", "Square", "WebTable", "Xero", "Zoho", "GenericContainerRegistry", "Elasticsearch", "AppInsights", "AppConfig", "OpenAI", "Serp", "BingLLMSearch", "Serverless", "ManagedOnlineEndpoint", "ApiManagement", "ModelGateway", "GroundingWithBingSearch", "GroundingWithCustomSearch", "Sharepoint", "MicrosoftFabric", "PowerPlatformEnvironment", and "RemoteA2A". (PythonFeed, ContainerRegistry, Git, S3, Snowflake, AzureKeyVault, AzureSqlDb, AzureSynapseAnalytics, AzureMySqlDb, AzurePostgresDb, ADLSGen2, AzureContainerAppEnvironment, Redis, ApiKey, AzureOpenAI, AIServices, CognitiveSearch, CognitiveService, CustomKeys, AzureBlob, AzureStorageAccount, AzureOneLake, CosmosDb, CosmosDbMongoDbApi, AzureDataExplorer, AzureMariaDb, AzureDatabricksDeltaLake, AzureSqlMi, AzureTableStorage, AmazonRdsForOracle, AmazonRdsForSqlServer, AmazonRedshift, Db2, Drill, GoogleBigQuery, Greenplum, Hbase, Hive, Impala, Informix, MariaDb, MicrosoftAccess, MySql, Netezza, Oracle, Phoenix, PostgreSql, Presto, SapOpenHub, SapBw, SapHana, SapTable, Spark, SqlServer, Sybase, Teradata, Vertica, Pinecone, Databricks, Cassandra, Couchbase, MongoDbV2, MongoDbAtlas, AmazonS3Compatible, FileServer, FtpServer, GoogleCloudStorage, Hdfs, OracleCloudStorage, Sftp, GenericHttp, ODataRest, Odbc, GenericRest, RemoteTool, AmazonMws, Concur, Dynamics, DynamicsAx, DynamicsCrm, GoogleAdWords, Hubspot, Jira, Magento, Marketo, Office365, Eloqua, Responsys, OracleServiceCloud, PayPal, QuickBooks, Salesforce, SalesforceServiceCloud, SalesforceMarketingCloud, SapCloudForCustomer, SapEcc, ServiceNow, SharePointOnlineList, Shopify, Square, WebTable, Xero, Zoho, GenericContainerRegistry, Elasticsearch, AppInsights, AppConfig, OpenAI, Serp, BingLLMSearch, Serverless, ManagedOnlineEndpoint, ApiManagement, ModelGateway, GroundingWithBingSearch, GroundingWithCustomSearch, Sharepoint, MicrosoftFabric, PowerPlatformEnvironment, RemoteA2A)
createdByWorkspaceArmIdstring:vartype created_by_workspace_arm_id: str
errorstringProvides the error message if the connection fails.
expiryTimestring (date-time):vartype expiry_time: ~datetime.datetime
groupstringGroup based on connection category. Known values are: "Azure", "AzureAI", "Database", "NoSQL", "File", "GenericProtocol", and "ServicesAndApps". (Azure, AzureAI, Database, NoSQL, File, GenericProtocol, ServicesAndApps)
isSharedToAllboolean:vartype is_shared_to_all: bool
metadataobjectStore user metadata for this connection.
peRequirementstringSpecifies how private endpoints are used with this connection: 'Required', 'NotRequired', or 'NotApplicable'. Known values are: "Required", "NotRequired", and "NotApplicable". (Required, NotRequired, NotApplicable)
peStatusstringSpecifies the status of private endpoints for this connection: 'Inactive', 'Active', or 'NotApplicable'. Known values are: "Inactive", "Active", and "NotApplicable". (Inactive, Active, NotApplicable)
sharedUserListarray:vartype shared_user_list: list[str]
systemDataobjectAzure Resource Manager metadata containing createdBy and modifiedBy information.
targetstringThe connection URL to be used.
typestringThe type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
useWorkspaceManagedIdentityboolean:vartype use_workspace_managed_identity: bool

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectresource_group_name, account_name, connection_name, subscription_idLists Cognitive Services account connection by name. Lists Cognitive Services account connection by name.
listselectresource_group_name, account_name, subscription_idtarget, category, includeAllLists all the available Cognitive Services account connections under the specified account. Lists all the available Cognitive Services account connections under the specified account.
createinsertresource_group_name, account_name, connection_name, subscription_id, propertiesCreate or update Cognitive Services account connection under the specified account. Create or update Cognitive Services account connection under the specified account.
updateupdateresource_group_name, account_name, connection_name, subscription_idUpdate Cognitive Services account connection under the specified account. Update Cognitive Services account connection under the specified account.
deletedeleteresource_group_name, account_name, connection_name, subscription_idDelete Cognitive Services account connection by name. Delete Cognitive Services account connection by name.

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.

NameDatatypeDescription
account_namestringThe name of Cognitive Services account. Required.
connection_namestringFriendly name of the connection. Required.
resource_group_namestringThe name of the resource group. The name is case insensitive. Required.
subscription_idstring
categorystringCategory of the connection. Default value is None.
includeAllbooleanquery parameter that indicates if get connection call should return both connections and datastores. Default value is False.
targetstringTarget of the connection. Default value is None.

SELECT examples​

Lists Cognitive Services account connection by name. Lists Cognitive Services account connection by name.

SELECT
id,
name,
authType,
category,
createdByWorkspaceArmId,
error,
expiryTime,
group,
isSharedToAll,
metadata,
peRequirement,
peStatus,
sharedUserList,
systemData,
target,
type,
useWorkspaceManagedIdentity
FROM azure.cognitive_services.account_connections
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND connection_name = '{{ connection_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples​

Create or update Cognitive Services account connection under the specified account. Create or update Cognitive Services account connection under the specified account.

INSERT INTO azure.cognitive_services.account_connections (
properties,
resource_group_name,
account_name,
connection_name,
subscription_id
)
SELECT 
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ account_name }}',
'{{ connection_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

UPDATE examples​

Update Cognitive Services account connection under the specified account. Update Cognitive Services account connection under the specified account.

UPDATE azure.cognitive_services.account_connections
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND connection_name = '{{ connection_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples​

Delete Cognitive Services account connection by name. Delete Cognitive Services account connection by name.

DELETE FROM azure.cognitive_services.account_connections
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND connection_name = '{{ connection_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;