Workspace Connections - Create

Référence

Service:: Machine Learning

Version d'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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
connectionName	path	True	string	Nom convivial de la connexion à l’espace de travail Modèle d’expression régulière: `^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$`
resourceGroupName	path	True	string	Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId	path	True	string	ID de l’abonnement cible.
workspaceName	path	True	string	Nom de l’espace de travail Azure Machine Learning. Modèle d’expression régulière: `^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$`
api-version	query	True	string	Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom	Obligatoire	Type	Description
properties	True	WorkspaceConnectionPropertiesV2: PATAuthTypeWorkspaceConnectionProperties SASAuthTypeWorkspaceConnectionProperties UsernamePasswordAuthTypeWorkspaceConnectionProperties NoneAuthTypeWorkspaceConnectionProperties ManagedIdentityAuthTypeWorkspaceConnectionProperties AADAuthTypeWorkspaceConnectionProperties AccessKeyAuthTypeWorkspaceConnectionProperties AccountKeyAuthTypeWorkspaceConnectionProperties ApiKeyAuthWorkspaceConnectionProperties CustomKeysWorkspaceConnectionProperties OAuth2AuthTypeWorkspaceConnectionProperties ServicePrincipalAuthTypeWorkspaceConnectionProperties

Réponses

Nom	Type	Description
200 OK	WorkspaceConnectionPropertiesV2BasicResource	La demande a réussi ; la demande a été bien formée et reçue correctement.
Other Status Codes	ErrorResponse	Erreur

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

CreateWorkspaceConnection

Exemple de requête

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

Exemple de réponse

Code d’état:: 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"
  }
}

Définitions

Nom	Description
AADAuthTypeWorkspaceConnectionProperties	Ce type de connexion couvre l’authentification AAD pour tout service Azure applicable
AccessKeyAuthTypeWorkspaceConnectionProperties
AccountKeyAuthTypeWorkspaceConnectionProperties	Ce type de connexion couvre la connexion de clé de compte pour le stockage Azure
ApiKeyAuthWorkspaceConnectionProperties	Ce type de connexion couvre les catégories de connexion d’authentification ApiKey génériques, par exemple : AzureOpenAI : Category := AzureOpenAI AuthType := ApiKey (en tant que discriminateur de type) Credentials := {ApiKey} en tant que Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target := {ApiBase} CognitiveService : Category := CognitiveService AuthType := ApiKey (en tant que discriminateur de type) Credentials := {SubscriptionKey} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target := ServiceRegion={serviceRegion} CognitiveSearch : Category := CognitiveSearch AuthType := ApiKey (en tant que discriminateur de type) Credentials := {Key} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target := {Endpoint} Utiliser le conteneur de propriétés de métadonnées pour ApiType, ApiVersion, Kind et d’autres champs de métadonnées
ConnectionAuthType	Type d’authentification de la cible de connexion
ConnectionCategory	Catégorie de la connexion
ConnectionGroup	Groupe basé sur la catégorie de connexion
createdByType	Type d’identité qui a créé la ressource.
CustomKeys	Objet d’informations d’identification clés personnalisées
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 et autres champs de métadonnées
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
ManagedIdentityAuthTypeWorkspaceConnectionProperties
NoneAuthTypeWorkspaceConnectionProperties
OAuth2AuthTypeWorkspaceConnectionProperties
PATAuthTypeWorkspaceConnectionProperties
SASAuthTypeWorkspaceConnectionProperties
ServicePrincipalAuthTypeWorkspaceConnectionProperties
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.
UsernamePasswordAuthTypeWorkspaceConnectionProperties
ValueFormat	format pour la valeur de connexion de l’espace de travail
WorkspaceConnectionAccessKey
WorkspaceConnectionAccountKey
WorkspaceConnectionApiKey	Objet de clé API pour les informations d’identification de connexion de l’espace de travail.
WorkspaceConnectionManagedIdentity
WorkspaceConnectionOAuth2	ClientId et ClientSecret sont requis. D’autres propriétés sont facultatives en fonction de l’implémentation de chaque fournisseur OAuth2.
WorkspaceConnectionPersonalAccessToken
WorkspaceConnectionPropertiesV2BasicResource
WorkspaceConnectionServicePrincipal
WorkspaceConnectionSharedAccessSignature
WorkspaceConnectionUsernamePassword

AADAuthTypeWorkspaceConnectionProperties

Ce type de connexion couvre l’authentification AAD pour tout service Azure applicable

Nom	Type	Description
authType	string: AAD	Type d’authentification de la cible de connexion
category	ConnectionCategory	Catégorie de la connexion
createdByWorkspaceArmId	string
expiryTime	string
group	ConnectionGroup	Groupe basé sur la catégorie de connexion
isSharedToAll	boolean
metadata	object	Stocker les métadonnées utilisateur pour cette connexion
sharedUserList	string[]
target	string
value	string	Détails de valeur de la connexion de l’espace de travail.
valueFormat	ValueFormat	format pour la valeur de connexion de l’espace de travail

AccessKeyAuthTypeWorkspaceConnectionProperties

Nom	Type	Description
authType	string: AccessKey	Type d’authentification de la cible de connexion
category	ConnectionCategory	Catégorie de la connexion
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionAccessKey
expiryTime	string
group	ConnectionGroup	Groupe basé sur la catégorie de connexion
isSharedToAll	boolean
metadata	object	Stocker les métadonnées utilisateur pour cette connexion
sharedUserList	string[]
target	string
value	string	Détails de valeur de la connexion de l’espace de travail.
valueFormat	ValueFormat	format pour la valeur de connexion de l’espace de travail

AccountKeyAuthTypeWorkspaceConnectionProperties

Ce type de connexion couvre la connexion de clé de compte pour le stockage Azure

Nom	Type	Description
authType	string: AccountKey	Type d’authentification de la cible de connexion
category	ConnectionCategory	Catégorie de la connexion
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionAccountKey
expiryTime	string
group	ConnectionGroup	Groupe basé sur la catégorie de connexion
isSharedToAll	boolean
metadata	object	Stocker les métadonnées utilisateur pour cette connexion
sharedUserList	string[]
target	string
value	string	Détails de valeur de la connexion de l’espace de travail.
valueFormat	ValueFormat	format pour la valeur de connexion de l’espace de travail

ApiKeyAuthWorkspaceConnectionProperties

Ce type de connexion couvre les catégories de connexion d’authentification ApiKey génériques, par exemple : AzureOpenAI : Category := AzureOpenAI AuthType := ApiKey (en tant que discriminateur de type) Credentials := {ApiKey} en tant que Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target := {ApiBase}

CognitiveService : Category := CognitiveService AuthType := ApiKey (en tant que discriminateur de type) Credentials := {SubscriptionKey} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target := ServiceRegion={serviceRegion}

CognitiveSearch : Category := CognitiveSearch AuthType := ApiKey (en tant que discriminateur de type) Credentials := {Key} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target := {Endpoint}

Utiliser le conteneur de propriétés de métadonnées pour ApiType, ApiVersion, Kind et d’autres champs de métadonnées

Nom	Type	Description
authType	string: ApiKey	Type d’authentification de la cible de connexion
category	ConnectionCategory	Catégorie de la connexion
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionApiKey	Objet de clé API pour les informations d’identification de connexion de l’espace de travail.
expiryTime	string
group	ConnectionGroup	Groupe basé sur la catégorie de connexion
isSharedToAll	boolean
metadata	object	Stocker les métadonnées utilisateur pour cette connexion
sharedUserList	string[]
target	string
value	string	Détails de valeur de la connexion de l’espace de travail.
valueFormat	ValueFormat	format pour la valeur de connexion de l’espace de travail

ConnectionAuthType

Type d’authentification de la cible de connexion

Nom	Type	Description
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

Catégorie de la connexion

Nom	Type	Description
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

Groupe basé sur la catégorie de connexion

Nom	Type	Description
Azure	string
AzureAI	string
Database	string
File	string
GenericProtocol	string
NoSQL	string
ServicesAndApps	string

createdByType

Type d’identité qui a créé la ressource.

Nom	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

CustomKeys

Objet d’informations d’identification clés personnalisées

Nom	Type	Description
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 et autres champs de métadonnées

Nom	Type	Description
authType	string: CustomKeys	Type d’authentification de la cible de connexion
category	ConnectionCategory	Catégorie de la connexion
createdByWorkspaceArmId	string
credentials	CustomKeys	Objet d’informations d’identification clés personnalisées
expiryTime	string
group	ConnectionGroup	Groupe basé sur la catégorie de connexion
isSharedToAll	boolean
metadata	object	Stocker les métadonnées utilisateur pour cette connexion
sharedUserList	string[]
target	string
value	string	Détails de valeur de la connexion de l’espace de travail.
valueFormat	ValueFormat	format pour la valeur de connexion de l’espace de travail

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

ManagedIdentityAuthTypeWorkspaceConnectionProperties

Nom	Type	Description
authType	string: ManagedIdentity	Type d’authentification de la cible de connexion
category	ConnectionCategory	Catégorie de la connexion
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionManagedIdentity
expiryTime	string
group	ConnectionGroup	Groupe basé sur la catégorie de connexion
isSharedToAll	boolean
metadata	object	Stocker les métadonnées utilisateur pour cette connexion
sharedUserList	string[]
target	string
value	string	Détails de valeur de la connexion de l’espace de travail.
valueFormat	ValueFormat	format pour la valeur de connexion de l’espace de travail

NoneAuthTypeWorkspaceConnectionProperties

Nom	Type	Description
authType	string: None	Type d’authentification de la cible de connexion
category	ConnectionCategory	Catégorie de la connexion
createdByWorkspaceArmId	string
expiryTime	string
group	ConnectionGroup	Groupe basé sur la catégorie de connexion
isSharedToAll	boolean
metadata	object	Stocker les métadonnées utilisateur pour cette connexion
sharedUserList	string[]
target	string
value	string	Détails de valeur de la connexion de l’espace de travail.
valueFormat	ValueFormat	format pour la valeur de connexion de l’espace de travail

OAuth2AuthTypeWorkspaceConnectionProperties

Nom	Type	Description
authType	string: OAuth2	Type d’authentification de la cible de connexion
category	ConnectionCategory	Catégorie de la connexion
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionOAuth2	ClientId et ClientSecret sont requis. D’autres propriétés sont facultatives en fonction de l’implémentation de chaque fournisseur OAuth2.
expiryTime	string
group	ConnectionGroup	Groupe basé sur la catégorie de connexion
isSharedToAll	boolean
metadata	object	Stocker les métadonnées utilisateur pour cette connexion
sharedUserList	string[]
target	string
value	string	Détails de valeur de la connexion de l’espace de travail.
valueFormat	ValueFormat	format pour la valeur de connexion de l’espace de travail

PATAuthTypeWorkspaceConnectionProperties

Nom	Type	Description
authType	string: PAT	Type d’authentification de la cible de connexion
category	ConnectionCategory	Catégorie de la connexion
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionPersonalAccessToken
expiryTime	string
group	ConnectionGroup	Groupe basé sur la catégorie de connexion
isSharedToAll	boolean
metadata	object	Stocker les métadonnées utilisateur pour cette connexion
sharedUserList	string[]
target	string
value	string	Détails de valeur de la connexion de l’espace de travail.
valueFormat	ValueFormat	format pour la valeur de connexion de l’espace de travail

SASAuthTypeWorkspaceConnectionProperties

Nom	Type	Description
authType	string: SAS	Type d’authentification de la cible de connexion
category	ConnectionCategory	Catégorie de la connexion
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionSharedAccessSignature
expiryTime	string
group	ConnectionGroup	Groupe basé sur la catégorie de connexion
isSharedToAll	boolean
metadata	object	Stocker les métadonnées utilisateur pour cette connexion
sharedUserList	string[]
target	string
value	string	Détails de valeur de la connexion de l’espace de travail.
valueFormat	ValueFormat	format pour la valeur de connexion de l’espace de travail

ServicePrincipalAuthTypeWorkspaceConnectionProperties

Nom	Type	Description
authType	string: ServicePrincipal	Type d’authentification de la cible de connexion
category	ConnectionCategory	Catégorie de la connexion
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionServicePrincipal
expiryTime	string
group	ConnectionGroup	Groupe basé sur la catégorie de connexion
isSharedToAll	boolean
metadata	object	Stocker les métadonnées utilisateur pour cette connexion
sharedUserList	string[]
target	string
value	string	Détails de valeur de la connexion de l’espace de travail.
valueFormat	ValueFormat	format pour la valeur de connexion de l’espace de travail

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string	Horodatage de la dernière modification de ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	createdByType	Type d’identité qui a modifié la ressource pour la dernière fois.

UsernamePasswordAuthTypeWorkspaceConnectionProperties

Nom	Type	Description
authType	string: UsernamePassword	Type d’authentification de la cible de connexion
category	ConnectionCategory	Catégorie de la connexion
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionUsernamePassword
expiryTime	string
group	ConnectionGroup	Groupe basé sur la catégorie de connexion
isSharedToAll	boolean
metadata	object	Stocker les métadonnées utilisateur pour cette connexion
sharedUserList	string[]
target	string
value	string	Détails de valeur de la connexion de l’espace de travail.
valueFormat	ValueFormat	format pour la valeur de connexion de l’espace de travail

ValueFormat

format pour la valeur de connexion de l’espace de travail

Nom	Type	Description
JSON	string

WorkspaceConnectionAccessKey

Nom	Type	Description
accessKeyId	string
secretAccessKey	string

WorkspaceConnectionAccountKey

Nom	Type	Description
key	string

WorkspaceConnectionApiKey

Objet de clé API pour les informations d’identification de connexion de l’espace de travail.

Nom	Type	Description
key	string

WorkspaceConnectionManagedIdentity

Nom	Type	Description
clientId	string
resourceId	string

WorkspaceConnectionOAuth2

ClientId et ClientSecret sont requis. D’autres propriétés sont facultatives en fonction de l’implémentation de chaque fournisseur OAuth2.

Nom	Type	Description
authUrl	string	Obligatoire par catégorie de connexion Concur
clientId	string	ID client au format UUID
clientSecret	string
developerToken	string	Obligatoire par la catégorie de connexion GoogleAdWords
password	string
refreshToken	string	Requis par GoogleBigQuery, GoogleAdWords, Hubspot, QuickBooks, Square, Xero, Zoho où l’utilisateur doit mettre RefreshToken hors connexion
tenantId	string	Requis par les catégories de connexion QuickBooks et Xero
username	string	Concur, Le type d’octroi AccessToken du serveur d’authentification ServiceNow est « Password » qui nécessite UsernamePassword

WorkspaceConnectionPersonalAccessToken

Nom	Type	Description
pat	string

WorkspaceConnectionPropertiesV2BasicResource

Nom	Type	Description
id	string	ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nom de la ressource
properties	WorkspaceConnectionPropertiesV2: AADAuthTypeWorkspaceConnectionProperties AccessKeyAuthTypeWorkspaceConnectionProperties AccountKeyAuthTypeWorkspaceConnectionProperties ApiKeyAuthWorkspaceConnectionProperties CustomKeysWorkspaceConnectionProperties ManagedIdentityAuthTypeWorkspaceConnectionProperties NoneAuthTypeWorkspaceConnectionProperties OAuth2AuthTypeWorkspaceConnectionProperties PATAuthTypeWorkspaceConnectionProperties SASAuthTypeWorkspaceConnectionProperties ServicePrincipalAuthTypeWorkspaceConnectionProperties UsernamePasswordAuthTypeWorkspaceConnectionProperties
systemData	systemData	Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

WorkspaceConnectionServicePrincipal

Nom	Type	Description
clientId	string
clientSecret	string
tenantId	string

WorkspaceConnectionSharedAccessSignature

Nom	Type	Description
sas	string

WorkspaceConnectionUsernamePassword

Nom	Type	Description
password	string
securityToken	string	Facultatif, requis par les connexions telles que SalesForce pour une sécurité supplémentaire en plus de UsernamePassword
username	string

Partager via