Workspace Connections - Get

Servizio:: Machine Learning

Versione API:: 2025-09-01

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}?api-version=2025-09-01

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
connectionName	path	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$	Nome descrittivo della connessione all'area di lavoro
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nome del gruppo di risorse. Il nome è insensibile alle maiuscole e minuscole.
subscriptionId	path	True	string minLength: 1	ID della sottoscrizione di destinazione.
workspaceName	path	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$	Nome dell'area di lavoro di Azure Machine Learning.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Risposte

Nome	Tipo	Descrizione
200 OK	WorkspaceConnectionPropertiesV2BasicResource	La richiesta è andata a buon fine; La richiesta era ben formata e ricevuta correttamente.
Other Status Codes	ErrorResponse	Errore

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

GetWorkspaceConnection

Esempio di richiesta

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.MachineLearningServices/workspaces/workspace-1/connections/connection-1?api-version=2025-09-01

Risposta di esempio

Codice di stato:: 200

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.MachineLearningServices/workspaces/workspace-1/connections/connection-1",
  "name": "connection-1",
  "type": "Microsoft.MachineLearningServices/workspaces/connections",
  "properties": {
    "category": "ContainerRegistry",
    "target": "www.facebook.com",
    "authType": "None"
  }
}

Definizioni

Nome	Descrizione
AADAuthTypeWorkspaceConnectionProperties	Questo tipo di connessione copre l'autenticazione AAD per qualsiasi servizio di Azure applicabile
AccessKeyAuthTypeWorkspaceConnectionProperties
AccountKeyAuthTypeWorkspaceConnectionProperties	Questo tipo di connessione copre la connessione della chiave dell'account per l'archiviazione di Azure
ApiKeyAuthWorkspaceConnectionProperties	Questo tipo di connessione copre le categorie di connessione di autenticazione ApiKey generiche, ad esempio: AzureOpenAI: Category:= AzureOpenAI AuthType:= ApiKey (come discriminatore di tipi) Credenziali:= {ApiKey} come Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= {ApiBase} CognitiveService: Category:= CognitiveService AuthType:= ApiKey (come discriminatore di tipi) Credenziali:= {SubscriptionKey} come Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= ServiceRegion={serviceRegion} CognitiveSearch: Category:= CognitiveSearch AuthType:= ApiKey (come discriminatore di tipi) Credenziali:= {Key} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= {Endpoint} Usare il contenitore delle proprietà Metadati per ApiType, ApiVersion, Kind e altri campi di metadati
ConnectionAuthType	Tipo di autenticazione della destinazione della connessione
ConnectionCategory	Categoria della connessione
ConnectionGroup	Raggruppa in base alla categoria di connessione
createdByType	Tipo di identità che ha creato la risorsa.
CustomKeys	Oggetto credenziali chiavi personalizzate
CustomKeysWorkspaceConnectionProperties	Category:= CustomKeys AuthType:= CustomKeys (come discriminatore di tipi) Credenziali:= {CustomKeys} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.CustomKeys Target:= {qualsiasi valore} Usa il contenitore delle proprietà Metadata per ApiVersion e altri campi di metadati
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
ManagedIdentityAuthTypeWorkspaceConnectionProperties
NoneAuthTypeWorkspaceConnectionProperties
OAuth2AuthTypeWorkspaceConnectionProperties
PATAuthTypeWorkspaceConnectionProperties
SASAuthTypeWorkspaceConnectionProperties
ServicePrincipalAuthTypeWorkspaceConnectionProperties
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.
UsernamePasswordAuthTypeWorkspaceConnectionProperties
ValueFormat	formato per il valore di connessione dell'area di lavoro
WorkspaceConnectionAccessKey
WorkspaceConnectionAccountKey
WorkspaceConnectionApiKey	Oggetto chiave API per le credenziali di connessione dell'area di lavoro.
WorkspaceConnectionManagedIdentity
WorkspaceConnectionOAuth2	ClientId e ClientSecret sono obbligatori. Altre proprietà sono facoltative a seconda dell'implementazione di ciascun provider OAuth2.
WorkspaceConnectionPersonalAccessToken
WorkspaceConnectionPropertiesV2BasicResource
WorkspaceConnectionServicePrincipal
WorkspaceConnectionSharedAccessSignature
WorkspaceConnectionUsernamePassword

AADAuthTypeWorkspaceConnectionProperties

Oggetto

Questo tipo di connessione copre l'autenticazione AAD per qualsiasi servizio di Azure applicabile

Nome	Tipo	Descrizione
authType	string: AAD	Tipo di autenticazione della destinazione della connessione
category	ConnectionCategory	Categoria della connessione
createdByWorkspaceArmId	string (arm-id)
expiryTime	string (date-time)
group	ConnectionGroup	Raggruppa in base alla categoria di connessione
isSharedToAll	boolean
metadata	object	Archiviare i metadati utente per questa connessione
sharedUserList	string[]
target	string
value	string	Dettagli valore della connessione all'area di lavoro.
valueFormat	ValueFormat	formato per il valore di connessione dell'area di lavoro

AccessKeyAuthTypeWorkspaceConnectionProperties

Oggetto

Nome	Tipo	Descrizione
authType	string: AccessKey	Tipo di autenticazione della destinazione della connessione
category	ConnectionCategory	Categoria della connessione
createdByWorkspaceArmId	string (arm-id)
credentials	WorkspaceConnectionAccessKey
expiryTime	string (date-time)
group	ConnectionGroup	Raggruppa in base alla categoria di connessione
isSharedToAll	boolean
metadata	object	Archiviare i metadati utente per questa connessione
sharedUserList	string[]
target	string
value	string	Dettagli valore della connessione all'area di lavoro.
valueFormat	ValueFormat	formato per il valore di connessione dell'area di lavoro

AccountKeyAuthTypeWorkspaceConnectionProperties

Oggetto

Questo tipo di connessione copre la connessione della chiave dell'account per l'archiviazione di Azure

Nome	Tipo	Descrizione
authType	string: AccountKey	Tipo di autenticazione della destinazione della connessione
category	ConnectionCategory	Categoria della connessione
createdByWorkspaceArmId	string (arm-id)
credentials	WorkspaceConnectionAccountKey
expiryTime	string (date-time)
group	ConnectionGroup	Raggruppa in base alla categoria di connessione
isSharedToAll	boolean
metadata	object	Archiviare i metadati utente per questa connessione
sharedUserList	string[]
target	string
value	string	Dettagli valore della connessione all'area di lavoro.
valueFormat	ValueFormat	formato per il valore di connessione dell'area di lavoro

ApiKeyAuthWorkspaceConnectionProperties

Oggetto

Questo tipo di connessione copre le categorie di connessione di autenticazione ApiKey generiche, ad esempio: AzureOpenAI: Category:= AzureOpenAI AuthType:= ApiKey (come discriminatore di tipi) Credenziali:= {ApiKey} come Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= {ApiBase}

CognitiveService: Category:= CognitiveService AuthType:= ApiKey (come discriminatore di tipi) Credenziali:= {SubscriptionKey} come Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= ServiceRegion={serviceRegion}

CognitiveSearch: Category:= CognitiveSearch AuthType:= ApiKey (come discriminatore di tipi) Credenziali:= {Key} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= {Endpoint}

Usare il contenitore delle proprietà Metadati per ApiType, ApiVersion, Kind e altri campi di metadati

Nome	Tipo	Descrizione
authType	string: ApiKey	Tipo di autenticazione della destinazione della connessione
category	ConnectionCategory	Categoria della connessione
createdByWorkspaceArmId	string (arm-id)
credentials	WorkspaceConnectionApiKey	Oggetto chiave API per le credenziali di connessione dell'area di lavoro.
expiryTime	string (date-time)
group	ConnectionGroup	Raggruppa in base alla categoria di connessione
isSharedToAll	boolean
metadata	object	Archiviare i metadati utente per questa connessione
sharedUserList	string[]
target	string
value	string	Dettagli valore della connessione all'area di lavoro.
valueFormat	ValueFormat	formato per il valore di connessione dell'area di lavoro

ConnectionAuthType

Enumerazione

Tipo di autenticazione della destinazione della connessione

Valore	Descrizione
PAT
ManagedIdentity
UsernamePassword
None
SAS
AccountKey
ServicePrincipal
AccessKey
ApiKey
CustomKeys
OAuth2
AAD

ConnectionCategory

Enumerazione

Categoria della connessione

Valore	Descrizione
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

Enumerazione

Raggruppa in base alla categoria di connessione

Valore	Descrizione
Azure
AzureAI
Database
NoSQL
File
GenericProtocol
ServicesAndApps

createdByType

Enumerazione

Tipo di identità che ha creato la risorsa.

Valore	Descrizione
User
Application
ManagedIdentity
Key

CustomKeys

Oggetto

Oggetto credenziali chiavi personalizzate

Nome	Tipo	Descrizione
keys	object

CustomKeysWorkspaceConnectionProperties

Oggetto

Category:= CustomKeys AuthType:= CustomKeys (come discriminatore di tipi) Credenziali:= {CustomKeys} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.CustomKeys Target:= {qualsiasi valore} Usa il contenitore delle proprietà Metadata per ApiVersion e altri campi di metadati

Nome	Tipo	Descrizione
authType	string: CustomKeys	Tipo di autenticazione della destinazione della connessione
category	ConnectionCategory	Categoria della connessione
createdByWorkspaceArmId	string (arm-id)
credentials	CustomKeys	Oggetto credenziali chiavi personalizzate
expiryTime	string (date-time)
group	ConnectionGroup	Raggruppa in base alla categoria di connessione
isSharedToAll	boolean
metadata	object	Archiviare i metadati utente per questa connessione
sharedUserList	string[]
target	string
value	string	Dettagli valore della connessione all'area di lavoro.
valueFormat	ValueFormat	formato per il valore di connessione dell'area di lavoro

ErrorAdditionalInfo

Oggetto

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Oggetto

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Oggetto

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

ManagedIdentityAuthTypeWorkspaceConnectionProperties

Oggetto

Nome	Tipo	Descrizione
authType	string: ManagedIdentity	Tipo di autenticazione della destinazione della connessione
category	ConnectionCategory	Categoria della connessione
createdByWorkspaceArmId	string (arm-id)
credentials	WorkspaceConnectionManagedIdentity
expiryTime	string (date-time)
group	ConnectionGroup	Raggruppa in base alla categoria di connessione
isSharedToAll	boolean
metadata	object	Archiviare i metadati utente per questa connessione
sharedUserList	string[]
target	string
value	string	Dettagli valore della connessione all'area di lavoro.
valueFormat	ValueFormat	formato per il valore di connessione dell'area di lavoro

NoneAuthTypeWorkspaceConnectionProperties

Oggetto

Nome	Tipo	Descrizione
authType	string: None	Tipo di autenticazione della destinazione della connessione
category	ConnectionCategory	Categoria della connessione
createdByWorkspaceArmId	string (arm-id)
expiryTime	string (date-time)
group	ConnectionGroup	Raggruppa in base alla categoria di connessione
isSharedToAll	boolean
metadata	object	Archiviare i metadati utente per questa connessione
sharedUserList	string[]
target	string
value	string	Dettagli valore della connessione all'area di lavoro.
valueFormat	ValueFormat	formato per il valore di connessione dell'area di lavoro

OAuth2AuthTypeWorkspaceConnectionProperties

Oggetto

Nome	Tipo	Descrizione
authType	string: OAuth2	Tipo di autenticazione della destinazione della connessione
category	ConnectionCategory	Categoria della connessione
createdByWorkspaceArmId	string (arm-id)
credentials	WorkspaceConnectionOAuth2	ClientId e ClientSecret sono obbligatori. Altre proprietà sono facoltative a seconda dell'implementazione di ciascun provider OAuth2.
expiryTime	string (date-time)
group	ConnectionGroup	Raggruppa in base alla categoria di connessione
isSharedToAll	boolean
metadata	object	Archiviare i metadati utente per questa connessione
sharedUserList	string[]
target	string
value	string	Dettagli valore della connessione all'area di lavoro.
valueFormat	ValueFormat	formato per il valore di connessione dell'area di lavoro

PATAuthTypeWorkspaceConnectionProperties

Oggetto

Nome	Tipo	Descrizione
authType	string: PAT	Tipo di autenticazione della destinazione della connessione
category	ConnectionCategory	Categoria della connessione
createdByWorkspaceArmId	string (arm-id)
credentials	WorkspaceConnectionPersonalAccessToken
expiryTime	string (date-time)
group	ConnectionGroup	Raggruppa in base alla categoria di connessione
isSharedToAll	boolean
metadata	object	Archiviare i metadati utente per questa connessione
sharedUserList	string[]
target	string
value	string	Dettagli valore della connessione all'area di lavoro.
valueFormat	ValueFormat	formato per il valore di connessione dell'area di lavoro

SASAuthTypeWorkspaceConnectionProperties

Oggetto

Nome	Tipo	Descrizione
authType	string: SAS	Tipo di autenticazione della destinazione della connessione
category	ConnectionCategory	Categoria della connessione
createdByWorkspaceArmId	string (arm-id)
credentials	WorkspaceConnectionSharedAccessSignature
expiryTime	string (date-time)
group	ConnectionGroup	Raggruppa in base alla categoria di connessione
isSharedToAll	boolean
metadata	object	Archiviare i metadati utente per questa connessione
sharedUserList	string[]
target	string
value	string	Dettagli valore della connessione all'area di lavoro.
valueFormat	ValueFormat	formato per il valore di connessione dell'area di lavoro

ServicePrincipalAuthTypeWorkspaceConnectionProperties

Oggetto

Nome	Tipo	Descrizione
authType	string: ServicePrincipal	Tipo di autenticazione della destinazione della connessione
category	ConnectionCategory	Categoria della connessione
createdByWorkspaceArmId	string (arm-id)
credentials	WorkspaceConnectionServicePrincipal
expiryTime	string (date-time)
group	ConnectionGroup	Raggruppa in base alla categoria di connessione
isSharedToAll	boolean
metadata	object	Archiviare i metadati utente per questa connessione
sharedUserList	string[]
target	string
value	string	Dettagli valore della connessione all'area di lavoro.
valueFormat	ValueFormat	formato per il valore di connessione dell'area di lavoro

systemData

Oggetto

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string (date-time)	Timestamp della creazione della risorsa (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string (date-time)	Timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy	string	Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima volta la risorsa.

UsernamePasswordAuthTypeWorkspaceConnectionProperties

Oggetto

Nome	Tipo	Descrizione
authType	string: UsernamePassword	Tipo di autenticazione della destinazione della connessione
category	ConnectionCategory	Categoria della connessione
createdByWorkspaceArmId	string (arm-id)
credentials	WorkspaceConnectionUsernamePassword
expiryTime	string (date-time)
group	ConnectionGroup	Raggruppa in base alla categoria di connessione
isSharedToAll	boolean
metadata	object	Archiviare i metadati utente per questa connessione
sharedUserList	string[]
target	string
value	string	Dettagli valore della connessione all'area di lavoro.
valueFormat	ValueFormat	formato per il valore di connessione dell'area di lavoro

ValueFormat

Enumerazione

formato per il valore di connessione dell'area di lavoro

Valore	Descrizione
JSON

WorkspaceConnectionAccessKey

Oggetto

Nome	Tipo	Descrizione
accessKeyId	string
secretAccessKey	string

WorkspaceConnectionAccountKey

Oggetto

Nome	Tipo	Descrizione
key	string

WorkspaceConnectionApiKey

Oggetto

Oggetto chiave API per le credenziali di connessione dell'area di lavoro.

Nome	Tipo	Descrizione
key	string

WorkspaceConnectionManagedIdentity

Oggetto

Nome	Tipo	Descrizione
clientId	string
resourceId	string

WorkspaceConnectionOAuth2

Oggetto

ClientId e ClientSecret sono obbligatori. Altre proprietà sono facoltative a seconda dell'implementazione di ciascun provider OAuth2.

Nome	Tipo	Descrizione
authUrl	string (url)	Richiesta dalla categoria di connessione Concur
clientId	string (uuid)	ID client nel formato UUID
clientSecret	string
developerToken	string	Obbligatorio per la categoria di connessione GoogleAdWords
password	string
refreshToken	string	Richiesto da GoogleBigQuery, GoogleAdWords, Hubspot, QuickBooks, Square, Xero, Zoho dove l'utente deve ottenere RefreshToken offline
tenantId	string	Richieste dalle categorie di connessione QuickBooks e Xero
username	string	Concur, il tipo di concessione AccessToken del server di autenticazione ServiceNow è 'Password' che richiede UsernamePassword

WorkspaceConnectionPersonalAccessToken

Oggetto

Nome	Tipo	Descrizione
pat	string

WorkspaceConnectionPropertiesV2BasicResource

Oggetto

Nome	Tipo	Descrizione
id	string	ID risorsa completo per la risorsa. Ad esempio: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nome della risorsa
properties	WorkspaceConnectionPropertiesV2: AADAuthTypeWorkspaceConnectionProperties AccessKeyAuthTypeWorkspaceConnectionProperties AccountKeyAuthTypeWorkspaceConnectionProperties ApiKeyAuthWorkspaceConnectionProperties CustomKeysWorkspaceConnectionProperties ManagedIdentityAuthTypeWorkspaceConnectionProperties NoneAuthTypeWorkspaceConnectionProperties OAuth2AuthTypeWorkspaceConnectionProperties PATAuthTypeWorkspaceConnectionProperties SASAuthTypeWorkspaceConnectionProperties ServicePrincipalAuthTypeWorkspaceConnectionProperties UsernamePasswordAuthTypeWorkspaceConnectionProperties
systemData	systemData	Metadati di Azure Resource Manager contenenti le informazioni createdBy e modifiedBy.
type	string	Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

WorkspaceConnectionServicePrincipal

Oggetto

Nome	Tipo	Descrizione
clientId	string
clientSecret	string
tenantId	string

WorkspaceConnectionSharedAccessSignature

Oggetto

Nome	Tipo	Descrizione
sas	string

WorkspaceConnectionUsernamePassword

Oggetto

Nome	Tipo	Descrizione
password	string
securityToken	string	Facoltativo, richiesto da connessioni come SalesForce per una maggiore sicurezza oltre a UsernamePassword
username	string