Workspace Connections - Create

Reference

Služba:: Machine Learning

Verze rozhraní 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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
connectionName	path	True	string	Popisný název připojení pracovního prostoru Vzor regulárního výrazu: `^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$`
resourceGroupName	path	True	string	Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
subscriptionId	path	True	string	ID cílového předplatného.
workspaceName	path	True	string	Název pracovního prostoru Azure Machine Learning Vzor regulárního výrazu: `^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$`
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name	Vyžadováno	Typ	Description
properties	True	WorkspaceConnectionPropertiesV2: PATAuthTypeWorkspaceConnectionProperties SASAuthTypeWorkspaceConnectionProperties UsernamePasswordAuthTypeWorkspaceConnectionProperties NoneAuthTypeWorkspaceConnectionProperties ManagedIdentityAuthTypeWorkspaceConnectionProperties AADAuthTypeWorkspaceConnectionProperties AccessKeyAuthTypeWorkspaceConnectionProperties AccountKeyAuthTypeWorkspaceConnectionProperties ApiKeyAuthWorkspaceConnectionProperties CustomKeysWorkspaceConnectionProperties OAuth2AuthTypeWorkspaceConnectionProperties ServicePrincipalAuthTypeWorkspaceConnectionProperties

Odpovědi

Name	Typ	Description
200 OK	WorkspaceConnectionPropertiesV2BasicResource	Požadavek byl úspěšný; požadavek byl správně vytvořen a přijat správně.
Other Status Codes	ErrorResponse	Chyba

Zabezpečení

azure_auth

Tok OAuth2 v Azure Active Directory

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

CreateWorkspaceConnection

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 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"
  }
}

Definice

Name	Description
AADAuthTypeWorkspaceConnectionProperties	Tento typ připojení pokrývá ověřování AAD pro všechny příslušné služby Azure.
AccessKeyAuthTypeWorkspaceConnectionProperties
AccountKeyAuthTypeWorkspaceConnectionProperties	Tento typ připojení se vztahuje na připojení klíče účtu pro úložiště Azure.
ApiKeyAuthWorkspaceConnectionProperties	Tento typ připojení se zabývá obecnými kategoriemi připojení ověřování ApiKey, například AzureOpenAI: Category:= AzureOpenAI AuthType:= ApiKey (jako typ diskriminující) Přihlašovací údaje:= {ApiKey} jako Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= {ApiBase} CognitiveService: Category:= CognitiveService AuthType:= ApiKey (jako typ diskriminátoru) Přihlašovací údaje:= {SubscriptionKey} jako Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= ServiceRegion={serviceRegion} CognitiveSearch: Category:= CognitiveSearch AuthType:= ApiKey (jako typ diskriminátoru) Přihlašovací údaje:= {Key} jako Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= {Endpoint} Použití sady vlastností Metadata pro pole ApiType, ApiVersion, Kind a dalších polí metadat
ConnectionAuthType	Typ ověřování cíle připojení
ConnectionCategory	Kategorie připojení
ConnectionGroup	Seskupit podle kategorie připojení
createdByType	Typ identity, která prostředek vytvořila.
CustomKeys	Objekt přihlašovacích údajů vlastních klíčů
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	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
ManagedIdentityAuthTypeWorkspaceConnectionProperties
NoneAuthTypeWorkspaceConnectionProperties
OAuth2AuthTypeWorkspaceConnectionProperties
PATAuthTypeWorkspaceConnectionProperties
SASAuthTypeWorkspaceConnectionProperties
ServicePrincipalAuthTypeWorkspaceConnectionProperties
systemData	Metadata týkající se vytvoření a poslední změny prostředku.
UsernamePasswordAuthTypeWorkspaceConnectionProperties
ValueFormat	formát pro hodnotu připojení pracovního prostoru
WorkspaceConnectionAccessKey
WorkspaceConnectionAccountKey
WorkspaceConnectionApiKey	Objekt klíče rozhraní API pro přihlašovací údaje připojení pracovního prostoru.
WorkspaceConnectionManagedIdentity
WorkspaceConnectionOAuth2	KlientId a ClientSecret jsou povinné. Další vlastnosti jsou volitelné v závislosti na implementaci každého zprostředkovatele OAuth2.
WorkspaceConnectionPersonalAccessToken
WorkspaceConnectionPropertiesV2BasicResource
WorkspaceConnectionServicePrincipal
WorkspaceConnectionSharedAccessSignature
WorkspaceConnectionUsernamePassword

AADAuthTypeWorkspaceConnectionProperties

Tento typ připojení pokrývá ověřování AAD pro všechny příslušné služby Azure.

Name	Typ	Description
authType	string: AAD	Typ ověřování cíle připojení
category	ConnectionCategory	Kategorie připojení
createdByWorkspaceArmId	string
expiryTime	string
group	ConnectionGroup	Seskupit podle kategorie připojení
isSharedToAll	boolean
metadata	object	Ukládat metadata uživatelů pro toto připojení
sharedUserList	string[]
target	string
value	string	Podrobnosti o hodnotě připojení pracovního prostoru
valueFormat	ValueFormat	formát pro hodnotu připojení pracovního prostoru

AccessKeyAuthTypeWorkspaceConnectionProperties

Name	Typ	Description
authType	string: AccessKey	Typ ověřování cíle připojení
category	ConnectionCategory	Kategorie připojení
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionAccessKey
expiryTime	string
group	ConnectionGroup	Seskupit podle kategorie připojení
isSharedToAll	boolean
metadata	object	Ukládat metadata uživatelů pro toto připojení
sharedUserList	string[]
target	string
value	string	Podrobnosti o hodnotě připojení pracovního prostoru
valueFormat	ValueFormat	formát pro hodnotu připojení pracovního prostoru

AccountKeyAuthTypeWorkspaceConnectionProperties

Tento typ připojení se vztahuje na připojení klíče účtu pro úložiště Azure.

Name	Typ	Description
authType	string: AccountKey	Typ ověřování cíle připojení
category	ConnectionCategory	Kategorie připojení
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionAccountKey
expiryTime	string
group	ConnectionGroup	Seskupit podle kategorie připojení
isSharedToAll	boolean
metadata	object	Ukládat metadata uživatelů pro toto připojení
sharedUserList	string[]
target	string
value	string	Podrobnosti o hodnotě připojení pracovního prostoru
valueFormat	ValueFormat	formát pro hodnotu připojení pracovního prostoru

ApiKeyAuthWorkspaceConnectionProperties

Tento typ připojení se zabývá obecnými kategoriemi připojení ověřování ApiKey, například AzureOpenAI: Category:= AzureOpenAI AuthType:= ApiKey (jako typ diskriminující) Přihlašovací údaje:= {ApiKey} jako Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= {ApiBase}

CognitiveService: Category:= CognitiveService AuthType:= ApiKey (jako typ diskriminátoru) Přihlašovací údaje:= {SubscriptionKey} jako Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= ServiceRegion={serviceRegion}

CognitiveSearch: Category:= CognitiveSearch AuthType:= ApiKey (jako typ diskriminátoru) Přihlašovací údaje:= {Key} jako Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= {Endpoint}

Použití sady vlastností Metadata pro pole ApiType, ApiVersion, Kind a dalších polí metadat

Name	Typ	Description
authType	string: ApiKey	Typ ověřování cíle připojení
category	ConnectionCategory	Kategorie připojení
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionApiKey	Objekt klíče rozhraní API pro přihlašovací údaje připojení pracovního prostoru.
expiryTime	string
group	ConnectionGroup	Seskupit podle kategorie připojení
isSharedToAll	boolean
metadata	object	Ukládat metadata uživatelů pro toto připojení
sharedUserList	string[]
target	string
value	string	Podrobnosti o hodnotě připojení pracovního prostoru
valueFormat	ValueFormat	formát pro hodnotu připojení pracovního prostoru

ConnectionAuthType

Typ ověřování cíle připojení

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

Kategorie připojení

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

Seskupit podle kategorie připojení

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

createdByType

Typ identity, která prostředek vytvořila.

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

CustomKeys

Objekt přihlašovacích údajů vlastních klíčů

Name	Typ	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 and other metadata fields

Name	Typ	Description
authType	string: CustomKeys	Typ ověřování cíle připojení
category	ConnectionCategory	Kategorie připojení
createdByWorkspaceArmId	string
credentials	CustomKeys	Objekt přihlašovacích údajů vlastních klíčů
expiryTime	string
group	ConnectionGroup	Seskupit podle kategorie připojení
isSharedToAll	boolean
metadata	object	Ukládat metadata uživatelů pro toto připojení
sharedUserList	string[]
target	string
value	string	Podrobnosti o hodnotě připojení pracovního prostoru
valueFormat	ValueFormat	formát pro hodnotu připojení pracovního prostoru

ErrorAdditionalInfo

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

ManagedIdentityAuthTypeWorkspaceConnectionProperties

Name	Typ	Description
authType	string: ManagedIdentity	Typ ověřování cíle připojení
category	ConnectionCategory	Kategorie připojení
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionManagedIdentity
expiryTime	string
group	ConnectionGroup	Seskupit podle kategorie připojení
isSharedToAll	boolean
metadata	object	Ukládat metadata uživatelů pro toto připojení
sharedUserList	string[]
target	string
value	string	Podrobnosti o hodnotě připojení pracovního prostoru
valueFormat	ValueFormat	formát pro hodnotu připojení pracovního prostoru

NoneAuthTypeWorkspaceConnectionProperties

Name	Typ	Description
authType	string: None	Typ ověřování cíle připojení
category	ConnectionCategory	Kategorie připojení
createdByWorkspaceArmId	string
expiryTime	string
group	ConnectionGroup	Seskupit podle kategorie připojení
isSharedToAll	boolean
metadata	object	Ukládat metadata uživatelů pro toto připojení
sharedUserList	string[]
target	string
value	string	Podrobnosti o hodnotě připojení pracovního prostoru
valueFormat	ValueFormat	formát pro hodnotu připojení pracovního prostoru

OAuth2AuthTypeWorkspaceConnectionProperties

Name	Typ	Description
authType	string: OAuth2	Typ ověřování cíle připojení
category	ConnectionCategory	Kategorie připojení
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionOAuth2	KlientId a ClientSecret jsou povinné. Další vlastnosti jsou volitelné v závislosti na implementaci každého zprostředkovatele OAuth2.
expiryTime	string
group	ConnectionGroup	Seskupit podle kategorie připojení
isSharedToAll	boolean
metadata	object	Ukládat metadata uživatelů pro toto připojení
sharedUserList	string[]
target	string
value	string	Podrobnosti o hodnotě připojení pracovního prostoru
valueFormat	ValueFormat	formát pro hodnotu připojení pracovního prostoru

PATAuthTypeWorkspaceConnectionProperties

Name	Typ	Description
authType	string: PAT	Typ ověřování cíle připojení
category	ConnectionCategory	Kategorie připojení
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionPersonalAccessToken
expiryTime	string
group	ConnectionGroup	Seskupit podle kategorie připojení
isSharedToAll	boolean
metadata	object	Ukládat metadata uživatelů pro toto připojení
sharedUserList	string[]
target	string
value	string	Podrobnosti o hodnotě připojení pracovního prostoru
valueFormat	ValueFormat	formát pro hodnotu připojení pracovního prostoru

SASAuthTypeWorkspaceConnectionProperties

Name	Typ	Description
authType	string: SAS	Typ ověřování cíle připojení
category	ConnectionCategory	Kategorie připojení
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionSharedAccessSignature
expiryTime	string
group	ConnectionGroup	Seskupit podle kategorie připojení
isSharedToAll	boolean
metadata	object	Ukládat metadata uživatelů pro toto připojení
sharedUserList	string[]
target	string
value	string	Podrobnosti o hodnotě připojení pracovního prostoru
valueFormat	ValueFormat	formát pro hodnotu připojení pracovního prostoru

ServicePrincipalAuthTypeWorkspaceConnectionProperties

Name	Typ	Description
authType	string: ServicePrincipal	Typ ověřování cíle připojení
category	ConnectionCategory	Kategorie připojení
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionServicePrincipal
expiryTime	string
group	ConnectionGroup	Seskupit podle kategorie připojení
isSharedToAll	boolean
metadata	object	Ukládat metadata uživatelů pro toto připojení
sharedUserList	string[]
target	string
value	string	Podrobnosti o hodnotě připojení pracovního prostoru
valueFormat	ValueFormat	formát pro hodnotu připojení pracovního prostoru

systemData

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string	Časové razítko vytvoření prostředku (UTC).
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string	Časové razítko poslední změny zdroje (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.

UsernamePasswordAuthTypeWorkspaceConnectionProperties

Name	Typ	Description
authType	string: UsernamePassword	Typ ověřování cíle připojení
category	ConnectionCategory	Kategorie připojení
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionUsernamePassword
expiryTime	string
group	ConnectionGroup	Seskupit podle kategorie připojení
isSharedToAll	boolean
metadata	object	Ukládat metadata uživatelů pro toto připojení
sharedUserList	string[]
target	string
value	string	Podrobnosti o hodnotě připojení pracovního prostoru
valueFormat	ValueFormat	formát pro hodnotu připojení pracovního prostoru

ValueFormat

formát pro hodnotu připojení pracovního prostoru

Name	Typ	Description
JSON	string

WorkspaceConnectionAccessKey

Name	Typ	Description
accessKeyId	string
secretAccessKey	string

WorkspaceConnectionAccountKey

Name	Typ	Description
key	string

WorkspaceConnectionApiKey

Objekt klíče rozhraní API pro přihlašovací údaje připojení pracovního prostoru.

Name	Typ	Description
key	string

WorkspaceConnectionManagedIdentity

Name	Typ	Description
clientId	string
resourceId	string

WorkspaceConnectionOAuth2

KlientId a ClientSecret jsou povinné. Další vlastnosti jsou volitelné v závislosti na implementaci každého zprostředkovatele OAuth2.

Name	Typ	Description
authUrl	string	Požadováno kategorií připojení Concur
clientId	string	ID klienta ve formátu UUID
clientSecret	string
developerToken	string	Požadováno kategorií připojení GoogleAdWords
password	string
refreshToken	string	Vyžaduje GoogleBigQuery, GoogleAdWords, Hubspot, QuickBooks, Square, Xero, Zoho, kde uživatel potřebuje získat RefreshToken offline
tenantId	string	Požadováno kategoriemi připojení QuickBooks a Xero
username	string	Concur, ServiceNow auth server AccessToken grant type is 'Password' to requires UsernamePassword

WorkspaceConnectionPersonalAccessToken

Name	Typ	Description
pat	string

WorkspaceConnectionPropertiesV2BasicResource

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku pro prostředek. Příklad : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Název prostředku
properties	WorkspaceConnectionPropertiesV2: AADAuthTypeWorkspaceConnectionProperties AccessKeyAuthTypeWorkspaceConnectionProperties AccountKeyAuthTypeWorkspaceConnectionProperties ApiKeyAuthWorkspaceConnectionProperties CustomKeysWorkspaceConnectionProperties ManagedIdentityAuthTypeWorkspaceConnectionProperties NoneAuthTypeWorkspaceConnectionProperties OAuth2AuthTypeWorkspaceConnectionProperties PATAuthTypeWorkspaceConnectionProperties SASAuthTypeWorkspaceConnectionProperties ServicePrincipalAuthTypeWorkspaceConnectionProperties UsernamePasswordAuthTypeWorkspaceConnectionProperties
systemData	systemData	Metadata Azure Resource Manageru obsahující informace createdBy a modifiedBy
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo 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	Volitelné, vyžadované připojeními, jako je SalesForce, pro dodatečné zabezpečení kromě UsernamePassword
username	string

Sdílet prostřednictvím