Workspace Connections - Create

Referencia

Szolgáltatás:: Machine Learning

API-verzió:: 2024-04-01

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
connectionName	path	True	string	A munkaterület-kapcsolat rövid neve Reguláris kifejezési minta: `^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$`
resourceGroupName	path	True	string	Az erőforráscsoport neve. A név megkülönbözteti a kis- és nagybetűket.
subscriptionId	path	True	string	A cél-előfizetés azonosítója.
workspaceName	path	True	string	Az Azure Machine Learning-munkaterület neve. Reguláris kifejezési minta: `^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$`
api-version	query	True	string	A művelethez használandó API-verzió.

Kérelem törzse

Name	Kötelező	Típus	Description
properties	True	WorkspaceConnectionPropertiesV2: PATAuthTypeWorkspaceConnectionProperties SASAuthTypeWorkspaceConnectionProperties UsernamePasswordAuthTypeWorkspaceConnectionProperties NoneAuthTypeWorkspaceConnectionProperties ManagedIdentityAuthTypeWorkspaceConnectionProperties AADAuthTypeWorkspaceConnectionProperties AccessKeyAuthTypeWorkspaceConnectionProperties AccountKeyAuthTypeWorkspaceConnectionProperties ApiKeyAuthWorkspaceConnectionProperties CustomKeysWorkspaceConnectionProperties OAuth2AuthTypeWorkspaceConnectionProperties ServicePrincipalAuthTypeWorkspaceConnectionProperties

Válaszok

Name	Típus	Description
200 OK	WorkspaceConnectionPropertiesV2BasicResource	A kérés sikeres volt; a kérés megfelelően alakult és megfelelően érkezett.
Other Status Codes	ErrorResponse	Hiba

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	felhasználói fiók megszemélyesítése

Példák

CreateWorkspaceConnection

Mintakérelem

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-04-01

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

Mintaválasz

Állapotkó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"
  }
}

Definíciók

Name	Description
AADAuthTypeWorkspaceConnectionProperties	Ez a kapcsolattípus a vonatkozó Azure-szolgáltatások AAD-hitelesítését fedi le
AccessKeyAuthTypeWorkspaceConnectionProperties
AccountKeyAuthTypeWorkspaceConnectionProperties	Ez a kapcsolattípus az Azure Storage fiókkulcs-kapcsolatát fedi le
ApiKeyAuthWorkspaceConnectionProperties	Ez a kapcsolattípus az általános ApiKey hitelesítési kapcsolatkategóriákra vonatkozik, például: AzureOpenAI: Category:= AzureOpenAI AuthType:= ApiKey (típuskriminatívként) Hitelesítő adatok:= {ApiKey} a Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= {ApiBase} CognitiveService: Category:= CognitiveService AuthType:= ApiKey (típuskriminatívként) Hitelesítő adatok:= {SubscriptionKey} mint Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= ServiceRegion={serviceRegion} CognitiveSearch: Category:= CognitiveSearch AuthType:= ApiKey (típuskriminatívként) Hitelesítő adatok:= {Key} a Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= {Endpoint} Metaadat-tulajdonságcsomag használata Az ApiType, az ApiVersion, a Kind és más metaadatok mezőihez
ConnectionAuthType	A kapcsolati cél hitelesítési típusa
ConnectionCategory	A kapcsolat kategóriája
ConnectionGroup	Csoport kapcsolatkategória alapján
createdByType	Az erőforrást létrehozó identitás típusa.
CustomKeys	Egyéni kulcsok hitelesítőadat-objektuma
CustomKeysWorkspaceConnectionProperties	Category:= CustomKeys AuthType:= CustomKeys (típuskriminatívként) Hitelesítő adatok:= {CustomKeys} mint Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.CustomKeys Target:= {any value} Az ApiVersion és más metaadatok mezőinek metaadat-tulajdonságcsomagjának használata
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
ManagedIdentityAuthTypeWorkspaceConnectionProperties
NoneAuthTypeWorkspaceConnectionProperties
OAuth2AuthTypeWorkspaceConnectionProperties
PATAuthTypeWorkspaceConnectionProperties
SASAuthTypeWorkspaceConnectionProperties
ServicePrincipalAuthTypeWorkspaceConnectionProperties
systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.
UsernamePasswordAuthTypeWorkspaceConnectionProperties
ValueFormat	a munkaterület kapcsolati értékének formátuma
WorkspaceConnectionAccessKey
WorkspaceConnectionAccountKey
WorkspaceConnectionApiKey	Api-kulcsobjektum a munkaterület kapcsolati hitelesítő adataihoz.
WorkspaceConnectionManagedIdentity
WorkspaceConnectionOAuth2	A ClientId és a ClientSecret megadása kötelező. Más tulajdonságok nem kötelezőek az egyes OAuth2-szolgáltatók implementációjától függően.
WorkspaceConnectionPersonalAccessToken
WorkspaceConnectionPropertiesV2BasicResource
WorkspaceConnectionServicePrincipal
WorkspaceConnectionSharedAccessSignature
WorkspaceConnectionUsernamePassword

AADAuthTypeWorkspaceConnectionProperties

Ez a kapcsolattípus a vonatkozó Azure-szolgáltatások AAD-hitelesítését fedi le

Name	Típus	Description
authType	string: AAD	A kapcsolati cél hitelesítési típusa
category	ConnectionCategory	A kapcsolat kategóriája
createdByWorkspaceArmId	string
expiryTime	string
group	ConnectionGroup	Csoport kapcsolatkategória alapján
isSharedToAll	boolean
metadata	object	A kapcsolat felhasználói metaadatainak tárolása
sharedUserList	string[]
target	string
value	string	A munkaterület kapcsolatának értékadatai.
valueFormat	ValueFormat	a munkaterület kapcsolati értékének formátuma

AccessKeyAuthTypeWorkspaceConnectionProperties

Name	Típus	Description
authType	string: AccessKey	A kapcsolati cél hitelesítési típusa
category	ConnectionCategory	A kapcsolat kategóriája
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionAccessKey
expiryTime	string
group	ConnectionGroup	Csoport kapcsolatkategória alapján
isSharedToAll	boolean
metadata	object	A kapcsolat felhasználói metaadatainak tárolása
sharedUserList	string[]
target	string
value	string	A munkaterület kapcsolatának értékadatai.
valueFormat	ValueFormat	a munkaterület kapcsolati értékének formátuma

AccountKeyAuthTypeWorkspaceConnectionProperties

Ez a kapcsolattípus az Azure Storage fiókkulcs-kapcsolatát fedi le

Name	Típus	Description
authType	string: AccountKey	A kapcsolati cél hitelesítési típusa
category	ConnectionCategory	A kapcsolat kategóriája
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionAccountKey
expiryTime	string
group	ConnectionGroup	Csoport kapcsolatkategória alapján
isSharedToAll	boolean
metadata	object	A kapcsolat felhasználói metaadatainak tárolása
sharedUserList	string[]
target	string
value	string	A munkaterület kapcsolatának értékadatai.
valueFormat	ValueFormat	a munkaterület kapcsolati értékének formátuma

ApiKeyAuthWorkspaceConnectionProperties

Ez a kapcsolattípus az általános ApiKey hitelesítési kapcsolatkategóriákra vonatkozik, például: AzureOpenAI: Category:= AzureOpenAI AuthType:= ApiKey (típuskriminatívként) Hitelesítő adatok:= {ApiKey} a Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= {ApiBase}

CognitiveService: Category:= CognitiveService AuthType:= ApiKey (típuskriminatívként) Hitelesítő adatok:= {SubscriptionKey} mint Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= ServiceRegion={serviceRegion}

CognitiveSearch: Category:= CognitiveSearch AuthType:= ApiKey (típuskriminatívként) Hitelesítő adatok:= {Key} a Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= {Endpoint}

Metaadat-tulajdonságcsomag használata Az ApiType, az ApiVersion, a Kind és más metaadatok mezőihez

Name	Típus	Description
authType	string: ApiKey	A kapcsolati cél hitelesítési típusa
category	ConnectionCategory	A kapcsolat kategóriája
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionApiKey	Api-kulcsobjektum a munkaterület kapcsolati hitelesítő adataihoz.
expiryTime	string
group	ConnectionGroup	Csoport kapcsolatkategória alapján
isSharedToAll	boolean
metadata	object	A kapcsolat felhasználói metaadatainak tárolása
sharedUserList	string[]
target	string
value	string	A munkaterület kapcsolatának értékadatai.
valueFormat	ValueFormat	a munkaterület kapcsolati értékének formátuma

ConnectionAuthType

A kapcsolati cél hitelesítési típusa

Name	Típus	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

A kapcsolat kategóriája

Name	Típus	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
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
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
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

Csoport kapcsolatkategória alapján

Name	Típus	Description
Azure	string
AzureAI	string
Database	string
File	string
GenericProtocol	string
NoSQL	string
ServicesAndApps	string

createdByType

Az erőforrást létrehozó identitás típusa.

Name	Típus	Description
Application	string
Key	string
ManagedIdentity	string
User	string

CustomKeys

Egyéni kulcsok hitelesítőadat-objektuma

Name	Típus	Description
keys	object

CustomKeysWorkspaceConnectionProperties

Category:= CustomKeys AuthType:= CustomKeys (típuskriminatívként) Hitelesítő adatok:= {CustomKeys} mint Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.CustomKeys Target:= {any value} Az ApiVersion és más metaadatok mezőinek metaadat-tulajdonságcsomagjának használata

Name	Típus	Description
authType	string: CustomKeys	A kapcsolati cél hitelesítési típusa
category	ConnectionCategory	A kapcsolat kategóriája
createdByWorkspaceArmId	string
credentials	CustomKeys	Egyéni kulcsok hitelesítőadat-objektuma
expiryTime	string
group	ConnectionGroup	Csoport kapcsolatkategória alapján
isSharedToAll	boolean
metadata	object	A kapcsolat felhasználói metaadatainak tárolása
sharedUserList	string[]
target	string
value	string	A munkaterület kapcsolatának értékadatai.
valueFormat	ValueFormat	a munkaterület kapcsolati értékének formátuma

ErrorAdditionalInfo

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

ErrorDetail

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hibacél.

ErrorResponse

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

ManagedIdentityAuthTypeWorkspaceConnectionProperties

Name	Típus	Description
authType	string: ManagedIdentity	A kapcsolati cél hitelesítési típusa
category	ConnectionCategory	A kapcsolat kategóriája
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionManagedIdentity
expiryTime	string
group	ConnectionGroup	Csoport kapcsolatkategória alapján
isSharedToAll	boolean
metadata	object	A kapcsolat felhasználói metaadatainak tárolása
sharedUserList	string[]
target	string
value	string	A munkaterület kapcsolatának értékadatai.
valueFormat	ValueFormat	a munkaterület kapcsolati értékének formátuma

NoneAuthTypeWorkspaceConnectionProperties

Name	Típus	Description
authType	string: None	A kapcsolati cél hitelesítési típusa
category	ConnectionCategory	A kapcsolat kategóriája
createdByWorkspaceArmId	string
expiryTime	string
group	ConnectionGroup	Csoport kapcsolatkategória alapján
isSharedToAll	boolean
metadata	object	A kapcsolat felhasználói metaadatainak tárolása
sharedUserList	string[]
target	string
value	string	A munkaterület kapcsolatának értékadatai.
valueFormat	ValueFormat	a munkaterület kapcsolati értékének formátuma

OAuth2AuthTypeWorkspaceConnectionProperties

Name	Típus	Description
authType	string: OAuth2	A kapcsolati cél hitelesítési típusa
category	ConnectionCategory	A kapcsolat kategóriája
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionOAuth2	A ClientId és a ClientSecret megadása kötelező. Más tulajdonságok nem kötelezőek az egyes OAuth2-szolgáltatók implementációjától függően.
expiryTime	string
group	ConnectionGroup	Csoport kapcsolatkategória alapján
isSharedToAll	boolean
metadata	object	A kapcsolat felhasználói metaadatainak tárolása
sharedUserList	string[]
target	string
value	string	A munkaterület kapcsolatának értékadatai.
valueFormat	ValueFormat	a munkaterület kapcsolati értékének formátuma

PATAuthTypeWorkspaceConnectionProperties

Name	Típus	Description
authType	string: PAT	A kapcsolati cél hitelesítési típusa
category	ConnectionCategory	A kapcsolat kategóriája
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionPersonalAccessToken
expiryTime	string
group	ConnectionGroup	Csoport kapcsolatkategória alapján
isSharedToAll	boolean
metadata	object	A kapcsolat felhasználói metaadatainak tárolása
sharedUserList	string[]
target	string
value	string	A munkaterület kapcsolatának értékadatai.
valueFormat	ValueFormat	a munkaterület kapcsolati értékének formátuma

SASAuthTypeWorkspaceConnectionProperties

Name	Típus	Description
authType	string: SAS	A kapcsolati cél hitelesítési típusa
category	ConnectionCategory	A kapcsolat kategóriája
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionSharedAccessSignature
expiryTime	string
group	ConnectionGroup	Csoport kapcsolatkategória alapján
isSharedToAll	boolean
metadata	object	A kapcsolat felhasználói metaadatainak tárolása
sharedUserList	string[]
target	string
value	string	A munkaterület kapcsolatának értékadatai.
valueFormat	ValueFormat	a munkaterület kapcsolati értékének formátuma

ServicePrincipalAuthTypeWorkspaceConnectionProperties

Name	Típus	Description
authType	string: ServicePrincipal	A kapcsolati cél hitelesítési típusa
category	ConnectionCategory	A kapcsolat kategóriája
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionServicePrincipal
expiryTime	string
group	ConnectionGroup	Csoport kapcsolatkategória alapján
isSharedToAll	boolean
metadata	object	A kapcsolat felhasználói metaadatainak tárolása
sharedUserList	string[]
target	string
value	string	A munkaterület kapcsolatának értékadatai.
valueFormat	ValueFormat	a munkaterület kapcsolati értékének formátuma

systemData

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name	Típus	Description
createdAt	string	Az erőforrás-létrehozás időbélyege (UTC).
createdBy	string	Az erőforrást létrehozó identitás.
createdByType	createdByType	Az erőforrást létrehozó identitás típusa.
lastModifiedAt	string	Az erőforrás utolsó módosításának időbélyege (UTC)
lastModifiedBy	string	Az az identitás, amely legutóbb módosította az erőforrást.
lastModifiedByType	createdByType	Az erőforrást legutóbb módosító identitás típusa.

UsernamePasswordAuthTypeWorkspaceConnectionProperties

Name	Típus	Description
authType	string: UsernamePassword	A kapcsolati cél hitelesítési típusa
category	ConnectionCategory	A kapcsolat kategóriája
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionUsernamePassword
expiryTime	string
group	ConnectionGroup	Csoport kapcsolatkategória alapján
isSharedToAll	boolean
metadata	object	A kapcsolat felhasználói metaadatainak tárolása
sharedUserList	string[]
target	string
value	string	A munkaterület kapcsolatának értékadatai.
valueFormat	ValueFormat	a munkaterület kapcsolati értékének formátuma

ValueFormat

a munkaterület kapcsolati értékének formátuma

Name	Típus	Description
JSON	string

WorkspaceConnectionAccessKey

Name	Típus	Description
accessKeyId	string
secretAccessKey	string

WorkspaceConnectionAccountKey

Name	Típus	Description
key	string

WorkspaceConnectionApiKey

Api-kulcsobjektum a munkaterület kapcsolati hitelesítő adataihoz.

Name	Típus	Description
key	string

WorkspaceConnectionManagedIdentity

Name	Típus	Description
clientId	string
resourceId	string

WorkspaceConnectionOAuth2

A ClientId és a ClientSecret megadása kötelező. Más tulajdonságok nem kötelezőek az egyes OAuth2-szolgáltatók implementációjától függően.

Name	Típus	Description
authUrl	string	A Concur-kapcsolat kategóriája kötelező
clientId	string	Ügyfélazonosító UUID formátumban
clientSecret	string
developerToken	string	A GoogleAdWords kapcsolatkategória által megkövetelt
password	string
refreshToken	string	A GoogleBigQuery, a GoogleAdWords, a Hubspot, a QuickBooks, a Square, a Xero, a Zoho által megkövetelt, ahol a felhasználónak offline állapotba kell tennie a RefreshToken szolgáltatást
tenantId	string	A QuickBooks és a Xero kapcsolatkategóriák megkövetelik
username	string	Concur, ServiceNow auth kiszolgáló AccessToken engedélyezési típusa "Jelszó", amelyhez UsernamePassword szükséges

WorkspaceConnectionPersonalAccessToken

Name	Típus	Description
pat	string

WorkspaceConnectionPropertiesV2BasicResource

Name	Típus	Description
id	string	Az erőforrás teljes erőforrás-azonosítója. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Az erőforrás neve
properties	WorkspaceConnectionPropertiesV2: AADAuthTypeWorkspaceConnectionProperties AccessKeyAuthTypeWorkspaceConnectionProperties AccountKeyAuthTypeWorkspaceConnectionProperties ApiKeyAuthWorkspaceConnectionProperties CustomKeysWorkspaceConnectionProperties ManagedIdentityAuthTypeWorkspaceConnectionProperties NoneAuthTypeWorkspaceConnectionProperties OAuth2AuthTypeWorkspaceConnectionProperties PATAuthTypeWorkspaceConnectionProperties SASAuthTypeWorkspaceConnectionProperties ServicePrincipalAuthTypeWorkspaceConnectionProperties UsernamePasswordAuthTypeWorkspaceConnectionProperties
systemData	systemData	Az Azure Resource Manager createdBy és modifiedBy adatokat tartalmazó metaadatok.
type	string	Az erőforrás típusa. Például "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

WorkspaceConnectionServicePrincipal

Name	Típus	Description
clientId	string
clientSecret	string
tenantId	string

WorkspaceConnectionSharedAccessSignature

Name	Típus	Description
sas	string

WorkspaceConnectionUsernamePassword

Name	Típus	Description
password	string
securityToken	string	Nem kötelező, amelyet az olyan kapcsolatok igényelnek, mint a SalesForce a UsernamePassword mellett az extra biztonság érdekében
username	string

Megosztás a következőn keresztül: