Workspace Connections - Create

Tjänst:

Machine Learning

API-version:

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-parametrar

Name	I	Obligatorisk	Typ	Description
connectionName	path	True	string	Eget namn på anslutningen till arbetsytan Reguljärt uttrycksmönster: ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$
resourceGroupName	path	True	string	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
subscriptionId	path	True	string	ID för målprenumerationen.
workspaceName	path	True	string	Namnet på Azure Machine Learning-arbetsytan. Reguljärt uttrycksmönster: ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$
api-version	query	True	string	DEN API-version som ska användas för den här åtgärden.

Begärandetext

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

Svar

Name	Typ	Description
200 OK	WorkspaceConnectionPropertiesV2BasicResource	Begäran lyckades. begäran var väl utformad och mottogs korrekt.
Other Status Codes	ErrorResponse	Fel

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

CreateWorkspaceConnection

Exempelbegäran

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

Exempelsvar

Statuskod:

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

Definitioner

Name	Description
AADAuthTypeWorkspaceConnectionProperties	Den här anslutningstypen täcker AAD-autentiseringen för alla tillämpliga Azure-tjänster
AccessKeyAuthTypeWorkspaceConnectionProperties
AccountKeyAuthTypeWorkspaceConnectionProperties	Den här anslutningstypen omfattar kontonyckelanslutningen för Azure Storage
ApiKeyAuthWorkspaceConnectionProperties	Den här anslutningstypen omfattar de generiska ApiKey-autentiseringsanslutningskategorierna, till exempel: AzureOpenAI: Category:= AzureOpenAI AuthType:= ApiKey (som typdiskriminerande) Autentiseringsuppgifter:= {ApiKey} som Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= {ApiBase} CognitiveService: Category:= CognitiveService AuthType:= ApiKey (som typdiskriminerande) Autentiseringsuppgifter:= {SubscriptionKey} som Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= ServiceRegion={serviceRegion} CognitiveSearch: Category:= CognitiveSearch AuthType:= ApiKey (som typdiskriminerande) Autentiseringsuppgifter:= {Key} som Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= {Endpoint} Använda metadataegenskapspåsen för ApiType, ApiVersion, Typ och andra metadatafält
ConnectionAuthType	Autentiseringstyp för anslutningsmål
ConnectionCategory	Kategori för anslutningen
ConnectionGroup	Gruppera baserat på anslutningskategori
createdByType	Den typ av identitet som skapade resursen.
CustomKeys	Autentiseringsobjekt för anpassade nycklar
CustomKeysWorkspaceConnectionProperties	Kategori:= CustomKeys AuthType:= CustomKeys (som typdiskriminerande) Autentiseringsuppgifter:= {CustomKeys} som Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.CustomKeys Target:= {any value} Använd metadataegenskapspåse för ApiVersion och andra metadatafält
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
ManagedIdentityAuthTypeWorkspaceConnectionProperties
NoneAuthTypeWorkspaceConnectionProperties
OAuth2AuthTypeWorkspaceConnectionProperties
PATAuthTypeWorkspaceConnectionProperties
SASAuthTypeWorkspaceConnectionProperties
ServicePrincipalAuthTypeWorkspaceConnectionProperties
systemData	Metadata som rör skapande och senaste ändring av resursen.
UsernamePasswordAuthTypeWorkspaceConnectionProperties
ValueFormat	format för anslutningsvärdet för arbetsytan
WorkspaceConnectionAccessKey
WorkspaceConnectionAccountKey
WorkspaceConnectionApiKey	API-nyckelobjekt för autentiseringsuppgifter för arbetsytans anslutning.
WorkspaceConnectionManagedIdentity
WorkspaceConnectionOAuth2	ClientId och ClientSecret krävs. Andra egenskaper är valfria beroende på varje OAuth2-providers implementering.
WorkspaceConnectionPersonalAccessToken
WorkspaceConnectionPropertiesV2BasicResource
WorkspaceConnectionServicePrincipal
WorkspaceConnectionSharedAccessSignature
WorkspaceConnectionUsernamePassword

AADAuthTypeWorkspaceConnectionProperties

Den här anslutningstypen täcker AAD-autentiseringen för alla tillämpliga Azure-tjänster

Name	Typ	Description
authType	string: AAD	Autentiseringstyp för anslutningsmål
category	ConnectionCategory	Kategori för anslutningen
createdByWorkspaceArmId	string
expiryTime	string
group	ConnectionGroup	Gruppera baserat på anslutningskategori
isSharedToAll	boolean
metadata	object	Lagra användarmetadata för den här anslutningen
sharedUserList	string[]
target	string
value	string	Värdeinformation om anslutningen till arbetsytan.
valueFormat	ValueFormat	format för anslutningsvärdet för arbetsytan

AccessKeyAuthTypeWorkspaceConnectionProperties

Name	Typ	Description
authType	string: AccessKey	Autentiseringstyp för anslutningsmål
category	ConnectionCategory	Kategori för anslutningen
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionAccessKey
expiryTime	string
group	ConnectionGroup	Gruppera baserat på anslutningskategori
isSharedToAll	boolean
metadata	object	Lagra användarmetadata för den här anslutningen
sharedUserList	string[]
target	string
value	string	Värdeinformation om anslutningen till arbetsytan.
valueFormat	ValueFormat	format för anslutningsvärdet för arbetsytan

AccountKeyAuthTypeWorkspaceConnectionProperties

Den här anslutningstypen omfattar kontonyckelanslutningen för Azure Storage

Name	Typ	Description
authType	string: AccountKey	Autentiseringstyp för anslutningsmål
category	ConnectionCategory	Kategori för anslutningen
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionAccountKey
expiryTime	string
group	ConnectionGroup	Gruppera baserat på anslutningskategori
isSharedToAll	boolean
metadata	object	Lagra användarmetadata för den här anslutningen
sharedUserList	string[]
target	string
value	string	Värdeinformation om anslutningen till arbetsytan.
valueFormat	ValueFormat	format för anslutningsvärdet för arbetsytan

ApiKeyAuthWorkspaceConnectionProperties

Den här anslutningstypen omfattar de generiska ApiKey-autentiseringsanslutningskategorierna, till exempel: AzureOpenAI: Category:= AzureOpenAI AuthType:= ApiKey (som typdiskriminerande) Autentiseringsuppgifter:= {ApiKey} som Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= {ApiBase}

CognitiveService: Category:= CognitiveService AuthType:= ApiKey (som typdiskriminerande) Autentiseringsuppgifter:= {SubscriptionKey} som Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= ServiceRegion={serviceRegion}

CognitiveSearch: Category:= CognitiveSearch AuthType:= ApiKey (som typdiskriminerande) Autentiseringsuppgifter:= {Key} som Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= {Endpoint}

Använda metadataegenskapspåsen för ApiType, ApiVersion, Typ och andra metadatafält

Name	Typ	Description
authType	string: ApiKey	Autentiseringstyp för anslutningsmål
category	ConnectionCategory	Kategori för anslutningen
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionApiKey	API-nyckelobjekt för autentiseringsuppgifter för arbetsytans anslutning.
expiryTime	string
group	ConnectionGroup	Gruppera baserat på anslutningskategori
isSharedToAll	boolean
metadata	object	Lagra användarmetadata för den här anslutningen
sharedUserList	string[]
target	string
value	string	Värdeinformation om anslutningen till arbetsytan.
valueFormat	ValueFormat	format för anslutningsvärdet för arbetsytan

ConnectionAuthType

Autentiseringstyp för anslutningsmål

Name	Typ	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

Kategori för anslutningen

Name	Typ	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

Gruppera baserat på anslutningskategori

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

createdByType

Den typ av identitet som skapade resursen.

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

CustomKeys

Autentiseringsobjekt för anpassade nycklar

Name	Typ	Description
keys	object

CustomKeysWorkspaceConnectionProperties

Kategori:= CustomKeys AuthType:= CustomKeys (som typdiskriminerande) Autentiseringsuppgifter:= {CustomKeys} som Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.CustomKeys Target:= {any value} Använd metadataegenskapspåse för ApiVersion och andra metadatafält

Name	Typ	Description
authType	string: CustomKeys	Autentiseringstyp för anslutningsmål
category	ConnectionCategory	Kategori för anslutningen
createdByWorkspaceArmId	string
credentials	CustomKeys	Autentiseringsobjekt för anpassade nycklar
expiryTime	string
group	ConnectionGroup	Gruppera baserat på anslutningskategori
isSharedToAll	boolean
metadata	object	Lagra användarmetadata för den här anslutningen
sharedUserList	string[]
target	string
value	string	Värdeinformation om anslutningen till arbetsytan.
valueFormat	ValueFormat	format för anslutningsvärdet för arbetsytan

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorDetail

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

ManagedIdentityAuthTypeWorkspaceConnectionProperties

Name	Typ	Description
authType	string: ManagedIdentity	Autentiseringstyp för anslutningsmål
category	ConnectionCategory	Kategori för anslutningen
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionManagedIdentity
expiryTime	string
group	ConnectionGroup	Gruppera baserat på anslutningskategori
isSharedToAll	boolean
metadata	object	Lagra användarmetadata för den här anslutningen
sharedUserList	string[]
target	string
value	string	Värdeinformation om anslutningen till arbetsytan.
valueFormat	ValueFormat	format för anslutningsvärdet för arbetsytan

NoneAuthTypeWorkspaceConnectionProperties

Name	Typ	Description
authType	string: None	Autentiseringstyp för anslutningsmål
category	ConnectionCategory	Kategori för anslutningen
createdByWorkspaceArmId	string
expiryTime	string
group	ConnectionGroup	Gruppera baserat på anslutningskategori
isSharedToAll	boolean
metadata	object	Lagra användarmetadata för den här anslutningen
sharedUserList	string[]
target	string
value	string	Värdeinformation om anslutningen till arbetsytan.
valueFormat	ValueFormat	format för anslutningsvärdet för arbetsytan

OAuth2AuthTypeWorkspaceConnectionProperties

Name	Typ	Description
authType	string: OAuth2	Autentiseringstyp för anslutningsmål
category	ConnectionCategory	Kategori för anslutningen
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionOAuth2	ClientId och ClientSecret krävs. Andra egenskaper är valfria beroende på varje OAuth2-providers implementering.
expiryTime	string
group	ConnectionGroup	Gruppera baserat på anslutningskategori
isSharedToAll	boolean
metadata	object	Lagra användarmetadata för den här anslutningen
sharedUserList	string[]
target	string
value	string	Värdeinformation om anslutningen till arbetsytan.
valueFormat	ValueFormat	format för anslutningsvärdet för arbetsytan

PATAuthTypeWorkspaceConnectionProperties

Name	Typ	Description
authType	string: PAT	Autentiseringstyp för anslutningsmål
category	ConnectionCategory	Kategori för anslutningen
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionPersonalAccessToken
expiryTime	string
group	ConnectionGroup	Gruppera baserat på anslutningskategori
isSharedToAll	boolean
metadata	object	Lagra användarmetadata för den här anslutningen
sharedUserList	string[]
target	string
value	string	Värdeinformation om anslutningen till arbetsytan.
valueFormat	ValueFormat	format för anslutningsvärdet för arbetsytan

SASAuthTypeWorkspaceConnectionProperties

Name	Typ	Description
authType	string: SAS	Autentiseringstyp för anslutningsmål
category	ConnectionCategory	Kategori för anslutningen
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionSharedAccessSignature
expiryTime	string
group	ConnectionGroup	Gruppera baserat på anslutningskategori
isSharedToAll	boolean
metadata	object	Lagra användarmetadata för den här anslutningen
sharedUserList	string[]
target	string
value	string	Värdeinformation om anslutningen till arbetsytan.
valueFormat	ValueFormat	format för anslutningsvärdet för arbetsytan

ServicePrincipalAuthTypeWorkspaceConnectionProperties

Name	Typ	Description
authType	string: ServicePrincipal	Autentiseringstyp för anslutningsmål
category	ConnectionCategory	Kategori för anslutningen
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionServicePrincipal
expiryTime	string
group	ConnectionGroup	Gruppera baserat på anslutningskategori
isSharedToAll	boolean
metadata	object	Lagra användarmetadata för den här anslutningen
sharedUserList	string[]
target	string
value	string	Värdeinformation om anslutningen till arbetsytan.
valueFormat	ValueFormat	format för anslutningsvärdet för arbetsytan

systemData

Metadata som rör skapande och senaste ändring av resursen.

Name	Typ	Description
createdAt	string	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string	Tidsstämpeln för resursens senaste ändring (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.

UsernamePasswordAuthTypeWorkspaceConnectionProperties

Name	Typ	Description
authType	string: UsernamePassword	Autentiseringstyp för anslutningsmål
category	ConnectionCategory	Kategori för anslutningen
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionUsernamePassword
expiryTime	string
group	ConnectionGroup	Gruppera baserat på anslutningskategori
isSharedToAll	boolean
metadata	object	Lagra användarmetadata för den här anslutningen
sharedUserList	string[]
target	string
value	string	Värdeinformation om anslutningen till arbetsytan.
valueFormat	ValueFormat	format för anslutningsvärdet för arbetsytan

ValueFormat

format för anslutningsvärdet för arbetsytan

Name	Typ	Description
JSON	string

WorkspaceConnectionAccessKey

Name	Typ	Description
accessKeyId	string
secretAccessKey	string

WorkspaceConnectionAccountKey

Name	Typ	Description
key	string

WorkspaceConnectionApiKey

API-nyckelobjekt för autentiseringsuppgifter för arbetsytans anslutning.

Name	Typ	Description
key	string

WorkspaceConnectionManagedIdentity

Name	Typ	Description
clientId	string
resourceId	string

WorkspaceConnectionOAuth2

ClientId och ClientSecret krävs. Andra egenskaper är valfria beroende på varje OAuth2-providers implementering.

Name	Typ	Description
authUrl	string	Krävs av concur-anslutningskategori
clientId	string	Klient-ID i formatet UUID
clientSecret	string
developerToken	string	Krävs av GoogleAdWords-anslutningskategori
password	string
refreshToken	string	Krävs av GoogleBigQuery, GoogleAdWords, Hubspot, QuickBooks, Square, Xero, Zoho där användaren måste få RefreshToken offline
tenantId	string	Krävs av Anslutningskategorier för QuickBooks och Xero
username	string	Concur, ServiceNow auth server AccessToken grant type is 'Password' which requires UsernamePassword

WorkspaceConnectionPersonalAccessToken

Name	Typ	Description
pat	string

WorkspaceConnectionPropertiesV2BasicResource

Name	Typ	Description
id	string	Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Namnet på resursen
properties	WorkspaceConnectionPropertiesV2: AADAuthTypeWorkspaceConnectionProperties AccessKeyAuthTypeWorkspaceConnectionProperties AccountKeyAuthTypeWorkspaceConnectionProperties ApiKeyAuthWorkspaceConnectionProperties CustomKeysWorkspaceConnectionProperties ManagedIdentityAuthTypeWorkspaceConnectionProperties NoneAuthTypeWorkspaceConnectionProperties OAuth2AuthTypeWorkspaceConnectionProperties PATAuthTypeWorkspaceConnectionProperties SASAuthTypeWorkspaceConnectionProperties ServicePrincipalAuthTypeWorkspaceConnectionProperties UsernamePasswordAuthTypeWorkspaceConnectionProperties
systemData	systemData	Azure Resource Manager-metadata som innehåller createdBy och modifiedBy information.
type	string	Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

WorkspaceConnectionServicePrincipal

Name	Typ	Description
clientId	string
clientSecret	string
tenantId	string

WorkspaceConnectionSharedAccessSignature

Name	Typ	Description
sas	string

WorkspaceConnectionUsernamePassword

Name	Typ	Description
password	string
securityToken	string	Valfritt, krävs av anslutningar som SalesForce för extra säkerhet utöver UsernamePassword
username	string