Workspace Connections - Create

Riferimento

Servizio:: Machine Learning

Versione API:: 2024-10-01

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
connectionName	path	True	string	Nome descrittivo della connessione all'area di lavoro Criterio di espressione regolare: `^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$`
resourceGroupName	path	True	string	Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.
subscriptionId	path	True	string	ID della sottoscrizione di destinazione.
workspaceName	path	True	string	Nome dell'area di lavoro di Azure Machine Learning. Criterio di espressione regolare: `^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$`
api-version	query	True	string	Versione dell'API da usare per questa operazione.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
properties	True	WorkspaceConnectionPropertiesV2: PATAuthTypeWorkspaceConnectionProperties SASAuthTypeWorkspaceConnectionProperties UsernamePasswordAuthTypeWorkspaceConnectionProperties NoneAuthTypeWorkspaceConnectionProperties ManagedIdentityAuthTypeWorkspaceConnectionProperties AADAuthTypeWorkspaceConnectionProperties AccessKeyAuthTypeWorkspaceConnectionProperties AccountKeyAuthTypeWorkspaceConnectionProperties ApiKeyAuthWorkspaceConnectionProperties CustomKeysWorkspaceConnectionProperties OAuth2AuthTypeWorkspaceConnectionProperties ServicePrincipalAuthTypeWorkspaceConnectionProperties

Risposte

Nome	Tipo	Descrizione
200 OK	WorkspaceConnectionPropertiesV2BasicResource	La richiesta ha avuto esito positivo; la richiesta è stata 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

CreateWorkspaceConnection

Esempio di richiesta

HTTP

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

{
  "properties": {
    "category": "ContainerRegistry",
    "target": "www.facebook.com",
    "authType": "None"
  }
}

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 apiKey auth generiche, ad esempio: AzureOpenAI: Category:= AzureOpenAI AuthType:= ApiKey (as type discriminator) Credentials:= {ApiKey} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= {ApiBase} CognitiveService: Category:= CognitiveService AuthType:= ApiKey (as type discriminator) Credentials:= {SubscriptionKey} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= ServiceRegion={serviceRegion} CognitiveSearch: Category:= CognitiveSearch AuthType:= ApiKey (as type discriminator) Credentials:= {Key} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= {Endpoint} Usare il contenitore delle proprietà Metadata per i campi ApiType, ApiVersion, Kind e altri 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 (as type discriminator) Credentials:= {CustomKeys} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.CustomKeys Target:= {any value} Use Metadata property bag for ApiVersion and other metadata fields
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 ogni provider OAuth2.
WorkspaceConnectionPersonalAccessToken
WorkspaceConnectionPropertiesV2BasicResource
WorkspaceConnectionServicePrincipal
WorkspaceConnectionSharedAccessSignature
WorkspaceConnectionUsernamePassword

AADAuthTypeWorkspaceConnectionProperties

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
expiryTime	string
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

Nome	Tipo	Descrizione
authType	string: AccessKey	Tipo di autenticazione della destinazione della connessione
category	ConnectionCategory	Categoria della connessione
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionAccessKey
expiryTime	string
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

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
credentials	WorkspaceConnectionAccountKey
expiryTime	string
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

Questo tipo di connessione copre le categorie di connessione apiKey auth generiche, ad esempio: AzureOpenAI: Category:= AzureOpenAI AuthType:= ApiKey (as type discriminator) Credentials:= {ApiKey} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= {ApiBase}

CognitiveService: Category:= CognitiveService AuthType:= ApiKey (as type discriminator) Credentials:= {SubscriptionKey} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= ServiceRegion={serviceRegion}

CognitiveSearch: Category:= CognitiveSearch AuthType:= ApiKey (as type discriminator) Credentials:= {Key} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= {Endpoint}

Usare il contenitore delle proprietà Metadata per i campi ApiType, ApiVersion, Kind e altri metadati

Nome	Tipo	Descrizione
authType	string: ApiKey	Tipo di autenticazione della destinazione della connessione
category	ConnectionCategory	Categoria della connessione
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionApiKey	Oggetto chiave API per le credenziali di connessione dell'area di lavoro.
expiryTime	string
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

Tipo di autenticazione della destinazione della connessione

Nome	Tipo	Descrizione
AAD	string
AccessKey	string
AccountKey	string
ApiKey	string
CustomKeys	string
ManagedIdentity	string
None	string
OAuth2	string
PAT	string
SAS	string
ServicePrincipal	string
UsernamePassword	string

ConnectionCategory

Categoria della connessione

Nome	Tipo	Descrizione
ADLSGen2	string
AIServices	string
AmazonMws	string
AmazonRdsForOracle	string
AmazonRdsForSqlServer	string
AmazonRedshift	string
AmazonS3Compatible	string
ApiKey	string
AzureBlob	string
AzureDataExplorer	string
AzureDatabricksDeltaLake	string
AzureMariaDb	string
AzureMySqlDb	string
AzureOneLake	string
AzureOpenAI	string
AzurePostgresDb	string
AzureSqlDb	string
AzureSqlMi	string
AzureSynapseAnalytics	string
AzureTableStorage	string
BingLLMSearch	string
Cassandra	string
CognitiveSearch	string
CognitiveService	string
Concur	string
ContainerRegistry	string
CosmosDb	string
CosmosDbMongoDbApi	string
Couchbase	string
CustomKeys	string
Db2	string
Drill	string
Dynamics	string
DynamicsAx	string
DynamicsCrm	string
Elasticsearch	string
Eloqua	string
FileServer	string
FtpServer	string
GenericContainerRegistry	string
GenericHttp	string
GenericRest	string
Git	string
GoogleAdWords	string
GoogleBigQuery	string
GoogleCloudStorage	string
Greenplum	string
Hbase	string
Hdfs	string
Hive	string
Hubspot	string
Impala	string
Informix	string
Jira	string
Magento	string
ManagedOnlineEndpoint	string
MariaDb	string
Marketo	string
MicrosoftAccess	string
MongoDbAtlas	string
MongoDbV2	string
MySql	string
Netezza	string
ODataRest	string
Odbc	string
Office365	string
OpenAI	string
Oracle	string
OracleCloudStorage	string
OracleServiceCloud	string
PayPal	string
Phoenix	string
Pinecone	string
PostgreSql	string
Presto	string
PythonFeed	string
QuickBooks	string
Redis	string
Responsys	string
S3	string
Salesforce	string
SalesforceMarketingCloud	string
SalesforceServiceCloud	string
SapBw	string
SapCloudForCustomer	string
SapEcc	string
SapHana	string
SapOpenHub	string
SapTable	string
Serp	string
Serverless	string
ServiceNow	string
Sftp	string
SharePointOnlineList	string
Shopify	string
Snowflake	string
Spark	string
SqlServer	string
Square	string
Sybase	string
Teradata	string
Vertica	string
WebTable	string
Xero	string
Zoho	string

ConnectionGroup

Raggruppa in base alla categoria di connessione

Nome	Tipo	Descrizione
Azure	string
AzureAI	string
Database	string
File	string
GenericProtocol	string
NoSQL	string
ServicesAndApps	string

createdByType

Tipo di identità che ha creato la risorsa.

Nome	Tipo	Descrizione
Application	string
Key	string
ManagedIdentity	string
User	string

CustomKeys

Oggetto credenziali chiavi personalizzate

Nome	Tipo	Descrizione
keys	object

CustomKeysWorkspaceConnectionProperties

Category:= CustomKeys AuthType:= CustomKeys (as type discriminator) Credentials:= {CustomKeys} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.CustomKeys Target:= {any value} Use Metadata property bag for ApiVersion and other metadata fields

Nome	Tipo	Descrizione
authType	string: CustomKeys	Tipo di autenticazione della destinazione della connessione
category	ConnectionCategory	Categoria della connessione
createdByWorkspaceArmId	string
credentials	CustomKeys	Oggetto credenziali chiavi personalizzate
expiryTime	string
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

Informazioni aggiuntive sull'errore di gestione delle risorse.

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

ErrorDetail

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

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

ManagedIdentityAuthTypeWorkspaceConnectionProperties

Nome	Tipo	Descrizione
authType	string: ManagedIdentity	Tipo di autenticazione della destinazione della connessione
category	ConnectionCategory	Categoria della connessione
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionManagedIdentity
expiryTime	string
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

Nome	Tipo	Descrizione
authType	string: None	Tipo di autenticazione della destinazione della connessione
category	ConnectionCategory	Categoria della connessione
createdByWorkspaceArmId	string
expiryTime	string
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

Nome	Tipo	Descrizione
authType	string: OAuth2	Tipo di autenticazione della destinazione della connessione
category	ConnectionCategory	Categoria della connessione
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionOAuth2	ClientId e ClientSecret sono obbligatori. Altre proprietà sono facoltative a seconda dell'implementazione di ogni provider OAuth2.
expiryTime	string
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

Nome	Tipo	Descrizione
authType	string: PAT	Tipo di autenticazione della destinazione della connessione
category	ConnectionCategory	Categoria della connessione
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionPersonalAccessToken
expiryTime	string
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

Nome	Tipo	Descrizione
authType	string: SAS	Tipo di autenticazione della destinazione della connessione
category	ConnectionCategory	Categoria della connessione
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionSharedAccessSignature
expiryTime	string
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

Nome	Tipo	Descrizione
authType	string: ServicePrincipal	Tipo di autenticazione della destinazione della connessione
category	ConnectionCategory	Categoria della connessione
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionServicePrincipal
expiryTime	string
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

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

Nome	Tipo	Descrizione
createdAt	string	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	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

Nome	Tipo	Descrizione
authType	string: UsernamePassword	Tipo di autenticazione della destinazione della connessione
category	ConnectionCategory	Categoria della connessione
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionUsernamePassword
expiryTime	string
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

formato per il valore di connessione dell'area di lavoro

Nome	Tipo	Descrizione
JSON	string

WorkspaceConnectionAccessKey

Nome	Tipo	Descrizione
accessKeyId	string
secretAccessKey	string

WorkspaceConnectionAccountKey

Nome	Tipo	Descrizione
key	string

WorkspaceConnectionApiKey

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

Nome	Tipo	Descrizione
key	string

WorkspaceConnectionManagedIdentity

Nome	Tipo	Descrizione
clientId	string
resourceId	string

WorkspaceConnectionOAuth2

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

Nome	Tipo	Descrizione
authUrl	string	Richiesta dalla categoria di connessione Concur
clientId	string	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 portare RefreshToken offline
tenantId	string	Richieste dalle categorie di connessione QuickBooks e Xero
username	string	Concur, il tipo di concessione AccessToken del server di autenticazione di ServiceNow è 'Password' che richiede UsernamePassword

WorkspaceConnectionPersonalAccessToken

Nome	Tipo	Descrizione
pat	string

WorkspaceConnectionPropertiesV2BasicResource

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 della risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

WorkspaceConnectionServicePrincipal

Nome	Tipo	Descrizione
clientId	string
clientSecret	string
tenantId	string

WorkspaceConnectionSharedAccessSignature

Nome	Tipo	Descrizione
sas	string

WorkspaceConnectionUsernamePassword

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

Condividi tramite