Project Connections - Get

Lista a conexão do projeto dos Serviços Cognitivos por nome.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}/connections/{connectionName}?api-version=2025-06-01

Parâmetros de URI

Nome Em Obrigatório Tipo Description
accountName
path True

string

minLength: 2
maxLength: 64
pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$

O nome da conta dos Serviços Cognitivos.

connectionName
path True

string

pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$

Nome amigável da conexão

projectName
path True

string

minLength: 2
maxLength: 64
pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$

O nome do projeto da conta dos Serviços Cognitivos.

resourceGroupName
path True

string

minLength: 1
maxLength: 90

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

subscriptionId
path True

string

minLength: 1

O ID da assinatura de destino.

api-version
query True

string

minLength: 1

A versão da API a ser usada para esta operação.

Respostas

Nome Tipo Description
200 OK

ConnectionPropertiesV2BasicResource

O pedido foi bem-sucedido; O pedido foi bem formulado e recebido adequadamente.

Other Status Codes

ErrorResponse

Erro

Exemplos

GetProjectConnection

Solicitação de exemplo

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.CognitiveServices/accounts/account-1/projects/project-1/connections/connection-1?api-version=2025-06-01

Resposta de exemplo

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.CognitiveServices/accounts/account-1/projects/project-1/connections/connection-1",
  "name": "connection-1",
  "type": "Microsoft.CognitiveServices/accounts/projects/connections",
  "properties": {
    "category": "ContainerRegistry",
    "expiryTime": "2024-03-15T14:30:00Z",
    "target": "[tartget url]",
    "authType": "None"
  }
}

Definições

Nome Description
AADAuthTypeConnectionProperties

Esse tipo de conexão abrange a autenticação do AAD para qualquer serviço do Azure aplicável

AccessKeyAuthTypeConnectionProperties
AccountKeyAuthTypeConnectionProperties

Esse tipo de conexão abrange a conexão de chave de conta para o armazenamento do Azure

ApiKeyAuthConnectionProperties

Esse tipo de conexão abrange as categorias genéricas de conexão de autenticação ApiKey, por exemplo: AzureOpenAI: Category:= AzureOpenAI AuthType:= ApiKey (como discriminador de tipo) Credentials:= {ApiKey} como . Destino ApiKey:= {ApiBase}

CognitiveService: Category:= CognitiveService AuthType:= ApiKey (como discriminador de tipo) Credenciais:= {SubscriptionKey} como ApiKey Target:= ServiceRegion={serviceRegion}

CognitiveSearch: Category:= CognitiveSearch AuthType:= ApiKey (como discriminador de tipo) Credenciais:= {Key} como ApiKey Target:= {Endpoint}

Usar o recipiente de propriedades de metadados para ApiType, ApiVersion, Kind e outros campos de metadados

ConnectionAccessKey
ConnectionAccountKey

Objeto de chave de conta para credencial de conexão.

ConnectionApiKey

Objeto de chave de API para credencial de conexão.

ConnectionAuthType

Tipo de autenticação do destino da conexão

ConnectionCategory

Categoria da conexão

ConnectionGroup

Agrupar com base na categoria de conexão

ConnectionManagedIdentity
ConnectionOAuth2

ClientId e ClientSecret são necessários. Outras propriedades são opcionais dependendo da implementação de cada provedor OAuth2.

ConnectionPersonalAccessToken
ConnectionPropertiesV2BasicResource

Esquema de recurso base de conexão.

ConnectionServicePrincipal
ConnectionSharedAccessSignature
ConnectionUsernamePassword
CustomKeys

Objeto de credencial de chaves personalizadas

CustomKeysConnectionProperties

Category:= CustomKeys AuthType:= CustomKeys (como discriminador de tipo) Credentials:= {CustomKeys} como CustomKeys Target:= {any value} Use o recipiente de propriedades de metadados para ApiVersion e outros campos de metadados

ErrorAdditionalInfo

Informações adicionais sobre o erro de gerenciamento de recursos.

ErrorDetail

O detalhe do erro.

ErrorResponse

Resposta de erro

ManagedIdentityAuthTypeConnectionProperties
ManagedPERequirement
ManagedPEStatus
NoneAuthTypeConnectionProperties
OAuth2AuthTypeConnectionProperties
PATAuthTypeConnectionProperties
SASAuthTypeConnectionProperties
ServicePrincipalAuthTypeConnectionProperties
UsernamePasswordAuthTypeConnectionProperties

AADAuthTypeConnectionProperties

Esse tipo de conexão abrange a autenticação do AAD para qualquer serviço do Azure aplicável

Nome Tipo Description
authType string:

AAD

Tipo de autenticação do destino da conexão

category

ConnectionCategory

Categoria da conexão

createdByWorkspaceArmId

string (arm-id)

error

string

Fornece a mensagem de erro se a conexão falhar

expiryTime

string (date-time)

group

ConnectionGroup

Agrupar com base na categoria de conexão

isSharedToAll

boolean

metadata

object

Armazenar metadados de usuário para essa conexão

peRequirement

ManagedPERequirement

Especifica como os pontos de extremidade privados são usados com esta conexão: 'Required', 'NotRequired' ou 'NotApplicable'.

peStatus

ManagedPEStatus

Especifica o status dos pontos de extremidade privados para esta conexão: 'Inativo', 'Ativo' ou 'Não aplicável'.

sharedUserList

string[]

target

string

A URL de conexão a ser usada.

useWorkspaceManagedIdentity

boolean

AccessKeyAuthTypeConnectionProperties

Nome Tipo Description
authType string:

AccessKey

Tipo de autenticação do destino da conexão

category

ConnectionCategory

Categoria da conexão

createdByWorkspaceArmId

string (arm-id)

credentials

ConnectionAccessKey

error

string

Fornece a mensagem de erro se a conexão falhar

expiryTime

string (date-time)

group

ConnectionGroup

Agrupar com base na categoria de conexão

isSharedToAll

boolean

metadata

object

Armazenar metadados de usuário para essa conexão

peRequirement

ManagedPERequirement

Especifica como os pontos de extremidade privados são usados com esta conexão: 'Required', 'NotRequired' ou 'NotApplicable'.

peStatus

ManagedPEStatus

Especifica o status dos pontos de extremidade privados para esta conexão: 'Inativo', 'Ativo' ou 'Não aplicável'.

sharedUserList

string[]

target

string

A URL de conexão a ser usada.

useWorkspaceManagedIdentity

boolean

AccountKeyAuthTypeConnectionProperties

Esse tipo de conexão abrange a conexão de chave de conta para o armazenamento do Azure

Nome Tipo Description
authType string:

AccountKey

Tipo de autenticação do destino da conexão

category

ConnectionCategory

Categoria da conexão

createdByWorkspaceArmId

string (arm-id)

credentials

ConnectionAccountKey

Objeto de chave de conta para credencial de conexão.

error

string

Fornece a mensagem de erro se a conexão falhar

expiryTime

string (date-time)

group

ConnectionGroup

Agrupar com base na categoria de conexão

isSharedToAll

boolean

metadata

object

Armazenar metadados de usuário para essa conexão

peRequirement

ManagedPERequirement

Especifica como os pontos de extremidade privados são usados com esta conexão: 'Required', 'NotRequired' ou 'NotApplicable'.

peStatus

ManagedPEStatus

Especifica o status dos pontos de extremidade privados para esta conexão: 'Inativo', 'Ativo' ou 'Não aplicável'.

sharedUserList

string[]

target

string

A URL de conexão a ser usada.

useWorkspaceManagedIdentity

boolean

ApiKeyAuthConnectionProperties

Esse tipo de conexão abrange as categorias genéricas de conexão de autenticação ApiKey, por exemplo: AzureOpenAI: Category:= AzureOpenAI AuthType:= ApiKey (como discriminador de tipo) Credentials:= {ApiKey} como . Destino ApiKey:= {ApiBase}

CognitiveService: Category:= CognitiveService AuthType:= ApiKey (como discriminador de tipo) Credenciais:= {SubscriptionKey} como ApiKey Target:= ServiceRegion={serviceRegion}

CognitiveSearch: Category:= CognitiveSearch AuthType:= ApiKey (como discriminador de tipo) Credenciais:= {Key} como ApiKey Target:= {Endpoint}

Usar o recipiente de propriedades de metadados para ApiType, ApiVersion, Kind e outros campos de metadados

Nome Tipo Description
authType string:

ApiKey

Tipo de autenticação do destino da conexão

category

ConnectionCategory

Categoria da conexão

createdByWorkspaceArmId

string (arm-id)

credentials

ConnectionApiKey

Objeto de chave de API para credencial de conexão.

error

string

Fornece a mensagem de erro se a conexão falhar

expiryTime

string (date-time)

group

ConnectionGroup

Agrupar com base na categoria de conexão

isSharedToAll

boolean

metadata

object

Armazenar metadados de usuário para essa conexão

peRequirement

ManagedPERequirement

Especifica como os pontos de extremidade privados são usados com esta conexão: 'Required', 'NotRequired' ou 'NotApplicable'.

peStatus

ManagedPEStatus

Especifica o status dos pontos de extremidade privados para esta conexão: 'Inativo', 'Ativo' ou 'Não aplicável'.

sharedUserList

string[]

target

string

A URL de conexão a ser usada.

useWorkspaceManagedIdentity

boolean

ConnectionAccessKey

Nome Tipo Description
accessKeyId

string

secretAccessKey

string

ConnectionAccountKey

Objeto de chave de conta para credencial de conexão.

Nome Tipo Description
key

string

ConnectionApiKey

Objeto de chave de API para credencial de conexão.

Nome Tipo Description
key

string

ConnectionAuthType

Tipo de autenticação do destino da conexão

Valor Description
PAT
ManagedIdentity
UsernamePassword
None
SAS
AccountKey
ServicePrincipal
AccessKey
ApiKey
CustomKeys
OAuth2
AAD

ConnectionCategory

Categoria da conexão

Valor Description
PythonFeed
ContainerRegistry
Git
S3
Snowflake
AzureSqlDb
AzureSynapseAnalytics
AzureMySqlDb
AzurePostgresDb
ADLSGen2
Redis
ApiKey
AzureOpenAI
AIServices
CognitiveSearch
CognitiveService
CustomKeys
AzureBlob
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
Cassandra
Couchbase
MongoDbV2
MongoDbAtlas
AmazonS3Compatible
FileServer
FtpServer
GoogleCloudStorage
Hdfs
OracleCloudStorage
Sftp
GenericHttp
ODataRest
Odbc
GenericRest
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
OpenAI
Serp
BingLLMSearch
Serverless
ManagedOnlineEndpoint

ConnectionGroup

Agrupar com base na categoria de conexão

Valor Description
Azure
AzureAI
Database
NoSQL
File
GenericProtocol
ServicesAndApps

ConnectionManagedIdentity

Nome Tipo Description
clientId

string

resourceId

string

ConnectionOAuth2

ClientId e ClientSecret são necessários. Outras propriedades são opcionais dependendo da implementação de cada provedor OAuth2.

Nome Tipo Description
authUrl

string (uri)

Exigido pela categoria de conexão Concur

clientId

string (uuid)

ID do cliente no formato UUID

clientSecret

string

developerToken

string

Exigido pela categoria de conexão GoogleAdWords

password

string

refreshToken

string

Exigido pelo GoogleBigQuery, GoogleAdWords, Hubspot, QuickBooks, Square, Xero, Zoho, onde o usuário precisa colocar o RefreshToken offline

tenantId

string

Exigido pelas categorias de conexão QuickBooks e Xero

username

string

Concordo, o tipo de concessão AccessToken do servidor de autenticação ServiceNow é 'Password', que requer UsernamePassword

ConnectionPersonalAccessToken

Nome Tipo Description
pat

string

ConnectionPropertiesV2BasicResource

Esquema de recurso base de conexão.

Nome Tipo Description
id

string

ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

O nome do recurso

properties ConnectionPropertiesV2:

Esquema base da propriedade de conexão.

type

string

O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

ConnectionServicePrincipal

Nome Tipo Description
clientId

string

clientSecret

string

tenantId

string

ConnectionSharedAccessSignature

Nome Tipo Description
sas

string

ConnectionUsernamePassword

Nome Tipo Description
password

string

securityToken

string

Opcional, exigido por conexões como SalesForce para segurança extra, além de UsernamePassword

username

string

CustomKeys

Objeto de credencial de chaves personalizadas

Nome Tipo Description
keys

object

CustomKeysConnectionProperties

Category:= CustomKeys AuthType:= CustomKeys (como discriminador de tipo) Credentials:= {CustomKeys} como CustomKeys Target:= {any value} Use o recipiente de propriedades de metadados para ApiVersion e outros campos de metadados

Nome Tipo Description
authType string:

CustomKeys

Tipo de autenticação do destino da conexão

category

ConnectionCategory

Categoria da conexão

createdByWorkspaceArmId

string (arm-id)

credentials

CustomKeys

Objeto de credencial de chaves personalizadas

error

string

Fornece a mensagem de erro se a conexão falhar

expiryTime

string (date-time)

group

ConnectionGroup

Agrupar com base na categoria de conexão

isSharedToAll

boolean

metadata

object

Armazenar metadados de usuário para essa conexão

peRequirement

ManagedPERequirement

Especifica como os pontos de extremidade privados são usados com esta conexão: 'Required', 'NotRequired' ou 'NotApplicable'.

peStatus

ManagedPEStatus

Especifica o status dos pontos de extremidade privados para esta conexão: 'Inativo', 'Ativo' ou 'Não aplicável'.

sharedUserList

string[]

target

string

A URL de conexão a ser usada.

useWorkspaceManagedIdentity

boolean

ErrorAdditionalInfo

Informações adicionais sobre o erro de gerenciamento de recursos.

Nome Tipo Description
info

object

As informações adicionais.

type

string

O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Nome Tipo Description
additionalInfo

ErrorAdditionalInfo[]

Informações adicionais do erro.

code

string

O código de erro.

details

ErrorDetail[]

Os detalhes do erro.

message

string

A mensagem de erro.

target

string

O alvo do erro.

ErrorResponse

Resposta de erro

Nome Tipo Description
error

ErrorDetail

O objeto de erro.

ManagedIdentityAuthTypeConnectionProperties

Nome Tipo Description
authType string:

ManagedIdentity

Tipo de autenticação do destino da conexão

category

ConnectionCategory

Categoria da conexão

createdByWorkspaceArmId

string (arm-id)

credentials

ConnectionManagedIdentity

error

string

Fornece a mensagem de erro se a conexão falhar

expiryTime

string (date-time)

group

ConnectionGroup

Agrupar com base na categoria de conexão

isSharedToAll

boolean

metadata

object

Armazenar metadados de usuário para essa conexão

peRequirement

ManagedPERequirement

Especifica como os pontos de extremidade privados são usados com esta conexão: 'Required', 'NotRequired' ou 'NotApplicable'.

peStatus

ManagedPEStatus

Especifica o status dos pontos de extremidade privados para esta conexão: 'Inativo', 'Ativo' ou 'Não aplicável'.

sharedUserList

string[]

target

string

A URL de conexão a ser usada.

useWorkspaceManagedIdentity

boolean

ManagedPERequirement

Valor Description
Required
NotRequired
NotApplicable

ManagedPEStatus

Valor Description
Inactive
Active
NotApplicable

NoneAuthTypeConnectionProperties

Nome Tipo Description
authType string:

None

Tipo de autenticação do destino da conexão

category

ConnectionCategory

Categoria da conexão

createdByWorkspaceArmId

string (arm-id)

error

string

Fornece a mensagem de erro se a conexão falhar

expiryTime

string (date-time)

group

ConnectionGroup

Agrupar com base na categoria de conexão

isSharedToAll

boolean

metadata

object

Armazenar metadados de usuário para essa conexão

peRequirement

ManagedPERequirement

Especifica como os pontos de extremidade privados são usados com esta conexão: 'Required', 'NotRequired' ou 'NotApplicable'.

peStatus

ManagedPEStatus

Especifica o status dos pontos de extremidade privados para esta conexão: 'Inativo', 'Ativo' ou 'Não aplicável'.

sharedUserList

string[]

target

string

A URL de conexão a ser usada.

useWorkspaceManagedIdentity

boolean

OAuth2AuthTypeConnectionProperties

Nome Tipo Description
authType string:

OAuth2

Tipo de autenticação do destino da conexão

category

ConnectionCategory

Categoria da conexão

createdByWorkspaceArmId

string (arm-id)

credentials

ConnectionOAuth2

ClientId e ClientSecret são necessários. Outras propriedades são opcionais dependendo da implementação de cada provedor OAuth2.

error

string

Fornece a mensagem de erro se a conexão falhar

expiryTime

string (date-time)

group

ConnectionGroup

Agrupar com base na categoria de conexão

isSharedToAll

boolean

metadata

object

Armazenar metadados de usuário para essa conexão

peRequirement

ManagedPERequirement

Especifica como os pontos de extremidade privados são usados com esta conexão: 'Required', 'NotRequired' ou 'NotApplicable'.

peStatus

ManagedPEStatus

Especifica o status dos pontos de extremidade privados para esta conexão: 'Inativo', 'Ativo' ou 'Não aplicável'.

sharedUserList

string[]

target

string

A URL de conexão a ser usada.

useWorkspaceManagedIdentity

boolean

PATAuthTypeConnectionProperties

Nome Tipo Description
authType string:

PAT

Tipo de autenticação do destino da conexão

category

ConnectionCategory

Categoria da conexão

createdByWorkspaceArmId

string (arm-id)

credentials

ConnectionPersonalAccessToken

error

string

Fornece a mensagem de erro se a conexão falhar

expiryTime

string (date-time)

group

ConnectionGroup

Agrupar com base na categoria de conexão

isSharedToAll

boolean

metadata

object

Armazenar metadados de usuário para essa conexão

peRequirement

ManagedPERequirement

Especifica como os pontos de extremidade privados são usados com esta conexão: 'Required', 'NotRequired' ou 'NotApplicable'.

peStatus

ManagedPEStatus

Especifica o status dos pontos de extremidade privados para esta conexão: 'Inativo', 'Ativo' ou 'Não aplicável'.

sharedUserList

string[]

target

string

A URL de conexão a ser usada.

useWorkspaceManagedIdentity

boolean

SASAuthTypeConnectionProperties

Nome Tipo Description
authType string:

SAS

Tipo de autenticação do destino da conexão

category

ConnectionCategory

Categoria da conexão

createdByWorkspaceArmId

string (arm-id)

credentials

ConnectionSharedAccessSignature

error

string

Fornece a mensagem de erro se a conexão falhar

expiryTime

string (date-time)

group

ConnectionGroup

Agrupar com base na categoria de conexão

isSharedToAll

boolean

metadata

object

Armazenar metadados de usuário para essa conexão

peRequirement

ManagedPERequirement

Especifica como os pontos de extremidade privados são usados com esta conexão: 'Required', 'NotRequired' ou 'NotApplicable'.

peStatus

ManagedPEStatus

Especifica o status dos pontos de extremidade privados para esta conexão: 'Inativo', 'Ativo' ou 'Não aplicável'.

sharedUserList

string[]

target

string

A URL de conexão a ser usada.

useWorkspaceManagedIdentity

boolean

ServicePrincipalAuthTypeConnectionProperties

Nome Tipo Description
authType string:

ServicePrincipal

Tipo de autenticação do destino da conexão

category

ConnectionCategory

Categoria da conexão

createdByWorkspaceArmId

string (arm-id)

credentials

ConnectionServicePrincipal

error

string

Fornece a mensagem de erro se a conexão falhar

expiryTime

string (date-time)

group

ConnectionGroup

Agrupar com base na categoria de conexão

isSharedToAll

boolean

metadata

object

Armazenar metadados de usuário para essa conexão

peRequirement

ManagedPERequirement

Especifica como os pontos de extremidade privados são usados com esta conexão: 'Required', 'NotRequired' ou 'NotApplicable'.

peStatus

ManagedPEStatus

Especifica o status dos pontos de extremidade privados para esta conexão: 'Inativo', 'Ativo' ou 'Não aplicável'.

sharedUserList

string[]

target

string

A URL de conexão a ser usada.

useWorkspaceManagedIdentity

boolean

UsernamePasswordAuthTypeConnectionProperties

Nome Tipo Description
authType string:

UsernamePassword

Tipo de autenticação do destino da conexão

category

ConnectionCategory

Categoria da conexão

createdByWorkspaceArmId

string (arm-id)

credentials

ConnectionUsernamePassword

error

string

Fornece a mensagem de erro se a conexão falhar

expiryTime

string (date-time)

group

ConnectionGroup

Agrupar com base na categoria de conexão

isSharedToAll

boolean

metadata

object

Armazenar metadados de usuário para essa conexão

peRequirement

ManagedPERequirement

Especifica como os pontos de extremidade privados são usados com esta conexão: 'Required', 'NotRequired' ou 'NotApplicable'.

peStatus

ManagedPEStatus

Especifica o status dos pontos de extremidade privados para esta conexão: 'Inativo', 'Ativo' ou 'Não aplicável'.

sharedUserList

string[]

target

string

A URL de conexão a ser usada.

useWorkspaceManagedIdentity

boolean