Workspace Connections - Create

Referentie

Service:: Machine Learning

API-versie:: 2024-10-01

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

URI-parameters

Name	In	Vereist	Type	Description
connectionName	path	True	string	Beschrijvende naam van de werkruimteverbinding Regex-patroon: `^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$`
resourceGroupName	path	True	string	De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
subscriptionId	path	True	string	De id van het doelabonnement.
workspaceName	path	True	string	Naam van Azure Machine Learning-werkruimte. Regex-patroon: `^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$`
api-version	query	True	string	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

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

Antwoorden

Name	Type	Description
200 OK	WorkspaceConnectionPropertiesV2BasicResource	De aanvraag is geslaagd; de aanvraag goed is gevormd en correct ontvangen.
Other Status Codes	ErrorResponse	Fout

Beveiliging

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

CreateWorkspaceConnection

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name	Description
AADAuthTypeWorkspaceConnectionProperties	Dit verbindingstype heeft betrekking op de AAD-verificatie voor elke toepasselijke Azure-service
AccessKeyAuthTypeWorkspaceConnectionProperties
AccountKeyAuthTypeWorkspaceConnectionProperties	Dit verbindingstype heeft betrekking op de accountsleutelverbinding voor Azure Storage
ApiKeyAuthWorkspaceConnectionProperties	Dit verbindingstype heeft betrekking op de algemene apiKey-verificatieverbindingscategorieën, bijvoorbeeld: AzureOpenAI: Category:= AzureOpenAI AuthType:= ApiKey (as type discriminator) Credentials:= {ApiKey} als 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} De eigenschapsverzameling Metagegevens gebruiken voor ApiType-, ApiVersion-, Soort- en andere metagegevensvelden
ConnectionAuthType	Verificatietype van het verbindingsdoel
ConnectionCategory	Categorie van de verbinding
ConnectionGroup	Groeperen op basis van verbindingscategorie
createdByType	Het type identiteit waarmee de resource is gemaakt.
CustomKeys	Referentieobject voor aangepaste sleutels
CustomKeysWorkspaceConnectionProperties	Categorie:= 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	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
ManagedIdentityAuthTypeWorkspaceConnectionProperties
NoneAuthTypeWorkspaceConnectionProperties
OAuth2AuthTypeWorkspaceConnectionProperties
PATAuthTypeWorkspaceConnectionProperties
SASAuthTypeWorkspaceConnectionProperties
ServicePrincipalAuthTypeWorkspaceConnectionProperties
systemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.
UsernamePasswordAuthTypeWorkspaceConnectionProperties
ValueFormat	indeling voor de verbindingswaarde van de werkruimte
WorkspaceConnectionAccessKey
WorkspaceConnectionAccountKey
WorkspaceConnectionApiKey	Api-sleutelobject voor werkruimteverbindingsreferenties.
WorkspaceConnectionManagedIdentity
WorkspaceConnectionOAuth2	ClientId en ClientSecret zijn vereist. Andere eigenschappen zijn optioneel, afhankelijk van de implementatie van elke OAuth2-provider.
WorkspaceConnectionPersonalAccessToken
WorkspaceConnectionPropertiesV2BasicResource
WorkspaceConnectionServicePrincipal
WorkspaceConnectionSharedAccessSignature
WorkspaceConnectionUsernamePassword

AADAuthTypeWorkspaceConnectionProperties

Dit verbindingstype heeft betrekking op de AAD-verificatie voor elke toepasselijke Azure-service

Name	Type	Description
authType	string: AAD	Verificatietype van het verbindingsdoel
category	ConnectionCategory	Categorie van de verbinding
createdByWorkspaceArmId	string
expiryTime	string
group	ConnectionGroup	Groeperen op basis van verbindingscategorie
isSharedToAll	boolean
metadata	object	Metagegevens van gebruikers opslaan voor deze verbinding
sharedUserList	string[]
target	string
value	string	Waardedetails van de werkruimteverbinding.
valueFormat	ValueFormat	indeling voor de verbindingswaarde van de werkruimte

AccessKeyAuthTypeWorkspaceConnectionProperties

Name	Type	Description
authType	string: AccessKey	Verificatietype van het verbindingsdoel
category	ConnectionCategory	Categorie van de verbinding
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionAccessKey
expiryTime	string
group	ConnectionGroup	Groeperen op basis van verbindingscategorie
isSharedToAll	boolean
metadata	object	Metagegevens van gebruikers opslaan voor deze verbinding
sharedUserList	string[]
target	string
value	string	Waardedetails van de werkruimteverbinding.
valueFormat	ValueFormat	indeling voor de verbindingswaarde van de werkruimte

AccountKeyAuthTypeWorkspaceConnectionProperties

Dit verbindingstype heeft betrekking op de accountsleutelverbinding voor Azure Storage

Name	Type	Description
authType	string: AccountKey	Verificatietype van het verbindingsdoel
category	ConnectionCategory	Categorie van de verbinding
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionAccountKey
expiryTime	string
group	ConnectionGroup	Groeperen op basis van verbindingscategorie
isSharedToAll	boolean
metadata	object	Metagegevens van gebruikers opslaan voor deze verbinding
sharedUserList	string[]
target	string
value	string	Waardedetails van de werkruimteverbinding.
valueFormat	ValueFormat	indeling voor de verbindingswaarde van de werkruimte

ApiKeyAuthWorkspaceConnectionProperties

Dit verbindingstype heeft betrekking op de algemene apiKey-verificatieverbindingscategorieën, bijvoorbeeld: AzureOpenAI: Category:= AzureOpenAI AuthType:= ApiKey (as type discriminator) Credentials:= {ApiKey} als 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}

De eigenschapsverzameling Metagegevens gebruiken voor ApiType-, ApiVersion-, Soort- en andere metagegevensvelden

Name	Type	Description
authType	string: ApiKey	Verificatietype van het verbindingsdoel
category	ConnectionCategory	Categorie van de verbinding
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionApiKey	Api-sleutelobject voor werkruimteverbindingsreferenties.
expiryTime	string
group	ConnectionGroup	Groeperen op basis van verbindingscategorie
isSharedToAll	boolean
metadata	object	Metagegevens van gebruikers opslaan voor deze verbinding
sharedUserList	string[]
target	string
value	string	Waardedetails van de werkruimteverbinding.
valueFormat	ValueFormat	indeling voor de verbindingswaarde van de werkruimte

ConnectionAuthType

Verificatietype van het verbindingsdoel

Name	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

Categorie van de verbinding

Name	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

Groeperen op basis van verbindingscategorie

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

createdByType

Het type identiteit waarmee de resource is gemaakt.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

CustomKeys

Referentieobject voor aangepaste sleutels

Name	Type	Description
keys	object

CustomKeysWorkspaceConnectionProperties

Categorie:= 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

Name	Type	Description
authType	string: CustomKeys	Verificatietype van het verbindingsdoel
category	ConnectionCategory	Categorie van de verbinding
createdByWorkspaceArmId	string
credentials	CustomKeys	Referentieobject voor aangepaste sleutels
expiryTime	string
group	ConnectionGroup	Groeperen op basis van verbindingscategorie
isSharedToAll	boolean
metadata	object	Metagegevens van gebruikers opslaan voor deze verbinding
sharedUserList	string[]
target	string
value	string	Waardedetails van de werkruimteverbinding.
valueFormat	ValueFormat	indeling voor de verbindingswaarde van de werkruimte

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

ManagedIdentityAuthTypeWorkspaceConnectionProperties

Name	Type	Description
authType	string: ManagedIdentity	Verificatietype van het verbindingsdoel
category	ConnectionCategory	Categorie van de verbinding
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionManagedIdentity
expiryTime	string
group	ConnectionGroup	Groeperen op basis van verbindingscategorie
isSharedToAll	boolean
metadata	object	Metagegevens van gebruikers opslaan voor deze verbinding
sharedUserList	string[]
target	string
value	string	Waardedetails van de werkruimteverbinding.
valueFormat	ValueFormat	indeling voor de verbindingswaarde van de werkruimte

NoneAuthTypeWorkspaceConnectionProperties

Name	Type	Description
authType	string: None	Verificatietype van het verbindingsdoel
category	ConnectionCategory	Categorie van de verbinding
createdByWorkspaceArmId	string
expiryTime	string
group	ConnectionGroup	Groeperen op basis van verbindingscategorie
isSharedToAll	boolean
metadata	object	Metagegevens van gebruikers opslaan voor deze verbinding
sharedUserList	string[]
target	string
value	string	Waardedetails van de werkruimteverbinding.
valueFormat	ValueFormat	indeling voor de verbindingswaarde van de werkruimte

OAuth2AuthTypeWorkspaceConnectionProperties

Name	Type	Description
authType	string: OAuth2	Verificatietype van het verbindingsdoel
category	ConnectionCategory	Categorie van de verbinding
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionOAuth2	ClientId en ClientSecret zijn vereist. Andere eigenschappen zijn optioneel, afhankelijk van de implementatie van elke OAuth2-provider.
expiryTime	string
group	ConnectionGroup	Groeperen op basis van verbindingscategorie
isSharedToAll	boolean
metadata	object	Metagegevens van gebruikers opslaan voor deze verbinding
sharedUserList	string[]
target	string
value	string	Waardedetails van de werkruimteverbinding.
valueFormat	ValueFormat	indeling voor de verbindingswaarde van de werkruimte

PATAuthTypeWorkspaceConnectionProperties

Name	Type	Description
authType	string: PAT	Verificatietype van het verbindingsdoel
category	ConnectionCategory	Categorie van de verbinding
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionPersonalAccessToken
expiryTime	string
group	ConnectionGroup	Groeperen op basis van verbindingscategorie
isSharedToAll	boolean
metadata	object	Metagegevens van gebruikers opslaan voor deze verbinding
sharedUserList	string[]
target	string
value	string	Waardedetails van de werkruimteverbinding.
valueFormat	ValueFormat	indeling voor de verbindingswaarde van de werkruimte

SASAuthTypeWorkspaceConnectionProperties

Name	Type	Description
authType	string: SAS	Verificatietype van het verbindingsdoel
category	ConnectionCategory	Categorie van de verbinding
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionSharedAccessSignature
expiryTime	string
group	ConnectionGroup	Groeperen op basis van verbindingscategorie
isSharedToAll	boolean
metadata	object	Metagegevens van gebruikers opslaan voor deze verbinding
sharedUserList	string[]
target	string
value	string	Waardedetails van de werkruimteverbinding.
valueFormat	ValueFormat	indeling voor de verbindingswaarde van de werkruimte

ServicePrincipalAuthTypeWorkspaceConnectionProperties

Name	Type	Description
authType	string: ServicePrincipal	Verificatietype van het verbindingsdoel
category	ConnectionCategory	Categorie van de verbinding
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionServicePrincipal
expiryTime	string
group	ConnectionGroup	Groeperen op basis van verbindingscategorie
isSharedToAll	boolean
metadata	object	Metagegevens van gebruikers opslaan voor deze verbinding
sharedUserList	string[]
target	string
value	string	Waardedetails van de werkruimteverbinding.
valueFormat	ValueFormat	indeling voor de verbindingswaarde van de werkruimte

systemData

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

Name	Type	Description
createdAt	string	De tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit waarmee de resource is gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string	De tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy	string	De identiteit die de resource voor het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource voor het laatst heeft gewijzigd.

UsernamePasswordAuthTypeWorkspaceConnectionProperties

Name	Type	Description
authType	string: UsernamePassword	Verificatietype van het verbindingsdoel
category	ConnectionCategory	Categorie van de verbinding
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionUsernamePassword
expiryTime	string
group	ConnectionGroup	Groeperen op basis van verbindingscategorie
isSharedToAll	boolean
metadata	object	Metagegevens van gebruikers opslaan voor deze verbinding
sharedUserList	string[]
target	string
value	string	Waardedetails van de werkruimteverbinding.
valueFormat	ValueFormat	indeling voor de verbindingswaarde van de werkruimte

ValueFormat

indeling voor de verbindingswaarde van de werkruimte

Name	Type	Description
JSON	string

WorkspaceConnectionAccessKey

Name	Type	Description
accessKeyId	string
secretAccessKey	string

WorkspaceConnectionAccountKey

Name	Type	Description
key	string

WorkspaceConnectionApiKey

Api-sleutelobject voor werkruimteverbindingsreferenties.

Name	Type	Description
key	string

WorkspaceConnectionManagedIdentity

Name	Type	Description
clientId	string
resourceId	string

WorkspaceConnectionOAuth2

ClientId en ClientSecret zijn vereist. Andere eigenschappen zijn optioneel, afhankelijk van de implementatie van elke OAuth2-provider.

Name	Type	Description
authUrl	string	Vereist voor concur-verbindingscategorie
clientId	string	Client-id in de indeling van UUID
clientSecret	string
developerToken	string	Vereist voor GoogleAdWords-verbindingscategorie
password	string
refreshToken	string	Vereist door GoogleBigQuery, GoogleAdWords, Hubspot, QuickBooks, Square, Xero, Zoho waar de gebruiker RefreshToken offline moet ophalen
tenantId	string	Vereist voor QuickBooks- en Xero-verbindingscategorieën
username	string	Concur, ServiceNow auth server AccessToken grant type is 'Password' waarvoor UsernamePassword is vereist

WorkspaceConnectionPersonalAccessToken

Name	Type	Description
pat	string

WorkspaceConnectionPropertiesV2BasicResource

Name	Type	Description
id	string	Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	De naam van de resource
properties	WorkspaceConnectionPropertiesV2: AADAuthTypeWorkspaceConnectionProperties AccessKeyAuthTypeWorkspaceConnectionProperties AccountKeyAuthTypeWorkspaceConnectionProperties ApiKeyAuthWorkspaceConnectionProperties CustomKeysWorkspaceConnectionProperties ManagedIdentityAuthTypeWorkspaceConnectionProperties NoneAuthTypeWorkspaceConnectionProperties OAuth2AuthTypeWorkspaceConnectionProperties PATAuthTypeWorkspaceConnectionProperties SASAuthTypeWorkspaceConnectionProperties ServicePrincipalAuthTypeWorkspaceConnectionProperties UsernamePasswordAuthTypeWorkspaceConnectionProperties
systemData	systemData	Azure Resource Manager-metagegevens met createdBy- en modifiedBy-gegevens.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

WorkspaceConnectionServicePrincipal

Name	Type	Description
clientId	string
clientSecret	string
tenantId	string

WorkspaceConnectionSharedAccessSignature

Name	Type	Description
sas	string

WorkspaceConnectionUsernamePassword

Name	Type	Description
password	string
securityToken	string	Optioneel, vereist voor verbindingen zoals SalesForce voor extra beveiliging naast UsernamePassword
username	string

Delen via