Workspace Connections - Create

Referensi

Layanan:: Machine Learning

Versi API:: 2024-04-01

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
connectionName	path	True	string	Nama koneksi ruang kerja yang mudah diingat Pola regex: `^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$`
resourceGroupName	path	True	string	Nama grup sumber daya. Nama tidak peka huruf besar/kecil.
subscriptionId	path	True	string	ID langganan target.
workspaceName	path	True	string	Nama ruang kerja Azure Machine Learning. Pola regex: `^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$`
api-version	query	True	string	Versi API yang digunakan untuk operasi ini.

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
properties	True	WorkspaceConnectionPropertiesV2: PATAuthTypeWorkspaceConnectionProperties SASAuthTypeWorkspaceConnectionProperties UsernamePasswordAuthTypeWorkspaceConnectionProperties NoneAuthTypeWorkspaceConnectionProperties ManagedIdentityAuthTypeWorkspaceConnectionProperties AADAuthTypeWorkspaceConnectionProperties AccessKeyAuthTypeWorkspaceConnectionProperties AccountKeyAuthTypeWorkspaceConnectionProperties ApiKeyAuthWorkspaceConnectionProperties CustomKeysWorkspaceConnectionProperties OAuth2AuthTypeWorkspaceConnectionProperties ServicePrincipalAuthTypeWorkspaceConnectionProperties

Respons

Nama	Jenis	Deskripsi
200 OK	WorkspaceConnectionPropertiesV2BasicResource	Permintaan berhasil; permintaan dibentuk dengan baik dan diterima dengan benar.
Other Status Codes	ErrorResponse	Kesalahan

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

Jenis: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

CreateWorkspaceConnection

Sample request

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

Sample response

Status code:: 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"
  }
}

Definisi

Nama	Deskripsi
AADAuthTypeWorkspaceConnectionProperties	Jenis koneksi ini mencakup autentikasi AAD untuk layanan Azure yang berlaku
AccessKeyAuthTypeWorkspaceConnectionProperties
AccountKeyAuthTypeWorkspaceConnectionProperties	Jenis koneksi ini mencakup koneksi kunci akun untuk penyimpanan Azure
ApiKeyAuthWorkspaceConnectionProperties	Jenis koneksi ini mencakup kategori koneksi autentikasi ApiKey generik, misalnya: AzureOpenAI: Category:= AzureOpenAI AuthType:= ApiKey (as type discriminator) Credentials:= {ApiKey} sebagai 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} Gunakan tas properti Metadata untuk Bidang ApiType, ApiVersion, Kind, dan metadata lainnya
ConnectionAuthType	Jenis autentikasi target koneksi
ConnectionCategory	Kategori koneksi
ConnectionGroup	Grup berdasarkan kategori koneksi
createdByType	Jenis identitas yang membuat sumber daya.
CustomKeys	Objek kredensial Kunci Kustom
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	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Respons kesalahan
ManagedIdentityAuthTypeWorkspaceConnectionProperties
NoneAuthTypeWorkspaceConnectionProperties
OAuth2AuthTypeWorkspaceConnectionProperties
PATAuthTypeWorkspaceConnectionProperties
SASAuthTypeWorkspaceConnectionProperties
ServicePrincipalAuthTypeWorkspaceConnectionProperties
systemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.
UsernamePasswordAuthTypeWorkspaceConnectionProperties
ValueFormat	format untuk nilai koneksi ruang kerja
WorkspaceConnectionAccessKey
WorkspaceConnectionAccountKey
WorkspaceConnectionApiKey	Objek kunci api untuk kredensial koneksi ruang kerja.
WorkspaceConnectionManagedIdentity
WorkspaceConnectionOAuth2	ClientId dan ClientSecret diperlukan. Properti lain bersifat opsional tergantung pada implementasi setiap penyedia OAuth2.
WorkspaceConnectionPersonalAccessToken
WorkspaceConnectionPropertiesV2BasicResource
WorkspaceConnectionServicePrincipal
WorkspaceConnectionSharedAccessSignature
WorkspaceConnectionUsernamePassword

AADAuthTypeWorkspaceConnectionProperties

Jenis koneksi ini mencakup autentikasi AAD untuk layanan Azure yang berlaku

Nama	Jenis	Deskripsi
authType	string: AAD	Jenis autentikasi target koneksi
category	ConnectionCategory	Kategori koneksi
createdByWorkspaceArmId	string
expiryTime	string
group	ConnectionGroup	Grup berdasarkan kategori koneksi
isSharedToAll	boolean
metadata	object	Simpan metadata pengguna untuk koneksi ini
sharedUserList	string[]
target	string
value	string	Detail nilai koneksi ruang kerja.
valueFormat	ValueFormat	format untuk nilai koneksi ruang kerja

AccessKeyAuthTypeWorkspaceConnectionProperties

Nama	Jenis	Deskripsi
authType	string: AccessKey	Jenis autentikasi target koneksi
category	ConnectionCategory	Kategori koneksi
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionAccessKey
expiryTime	string
group	ConnectionGroup	Grup berdasarkan kategori koneksi
isSharedToAll	boolean
metadata	object	Simpan metadata pengguna untuk koneksi ini
sharedUserList	string[]
target	string
value	string	Detail nilai koneksi ruang kerja.
valueFormat	ValueFormat	format untuk nilai koneksi ruang kerja

AccountKeyAuthTypeWorkspaceConnectionProperties

Jenis koneksi ini mencakup koneksi kunci akun untuk penyimpanan Azure

Nama	Jenis	Deskripsi
authType	string: AccountKey	Jenis autentikasi target koneksi
category	ConnectionCategory	Kategori koneksi
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionAccountKey
expiryTime	string
group	ConnectionGroup	Grup berdasarkan kategori koneksi
isSharedToAll	boolean
metadata	object	Simpan metadata pengguna untuk koneksi ini
sharedUserList	string[]
target	string
value	string	Detail nilai koneksi ruang kerja.
valueFormat	ValueFormat	format untuk nilai koneksi ruang kerja

ApiKeyAuthWorkspaceConnectionProperties

Jenis koneksi ini mencakup kategori koneksi autentikasi ApiKey generik, misalnya: AzureOpenAI: Category:= AzureOpenAI AuthType:= ApiKey (as type discriminator) Credentials:= {ApiKey} sebagai 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}

Gunakan tas properti Metadata untuk Bidang ApiType, ApiVersion, Kind, dan metadata lainnya

Nama	Jenis	Deskripsi
authType	string: ApiKey	Jenis autentikasi target koneksi
category	ConnectionCategory	Kategori koneksi
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionApiKey	Objek kunci api untuk kredensial koneksi ruang kerja.
expiryTime	string
group	ConnectionGroup	Grup berdasarkan kategori koneksi
isSharedToAll	boolean
metadata	object	Simpan metadata pengguna untuk koneksi ini
sharedUserList	string[]
target	string
value	string	Detail nilai koneksi ruang kerja.
valueFormat	ValueFormat	format untuk nilai koneksi ruang kerja

ConnectionAuthType

Jenis autentikasi target koneksi

Nama	Jenis	Deskripsi
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 koneksi

Nama	Jenis	Deskripsi
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

Grup berdasarkan kategori koneksi

Nama	Jenis	Deskripsi
Azure	string
AzureAI	string
Database	string
File	string
GenericProtocol	string
NoSQL	string
ServicesAndApps	string

createdByType

Jenis identitas yang membuat sumber daya.

Nama	Jenis	Deskripsi
Application	string
Key	string
ManagedIdentity	string
User	string

CustomKeys

Objek kredensial Kunci Kustom

Nama	Jenis	Deskripsi
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

Nama	Jenis	Deskripsi
authType	string: CustomKeys	Jenis autentikasi target koneksi
category	ConnectionCategory	Kategori koneksi
createdByWorkspaceArmId	string
credentials	CustomKeys	Objek kredensial Kunci Kustom
expiryTime	string
group	ConnectionGroup	Grup berdasarkan kategori koneksi
isSharedToAll	boolean
metadata	object	Simpan metadata pengguna untuk koneksi ini
sharedUserList	string[]
target	string
value	string	Detail nilai koneksi ruang kerja.
valueFormat	ValueFormat	format untuk nilai koneksi ruang kerja

ErrorAdditionalInfo

Info tambahan kesalahan manajemen sumber daya.

Nama	Jenis	Deskripsi
info	object	Info tambahan.
type	string	Jenis info tambahan.

ErrorDetail

Detail kesalahan.

Nama	Jenis	Deskripsi
additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	ErrorDetail[]	Detail kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

ErrorResponse

Respons kesalahan

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.

ManagedIdentityAuthTypeWorkspaceConnectionProperties

Nama	Jenis	Deskripsi
authType	string: ManagedIdentity	Jenis autentikasi target koneksi
category	ConnectionCategory	Kategori koneksi
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionManagedIdentity
expiryTime	string
group	ConnectionGroup	Grup berdasarkan kategori koneksi
isSharedToAll	boolean
metadata	object	Simpan metadata pengguna untuk koneksi ini
sharedUserList	string[]
target	string
value	string	Detail nilai koneksi ruang kerja.
valueFormat	ValueFormat	format untuk nilai koneksi ruang kerja

NoneAuthTypeWorkspaceConnectionProperties

Nama	Jenis	Deskripsi
authType	string: None	Jenis autentikasi target koneksi
category	ConnectionCategory	Kategori koneksi
createdByWorkspaceArmId	string
expiryTime	string
group	ConnectionGroup	Grup berdasarkan kategori koneksi
isSharedToAll	boolean
metadata	object	Simpan metadata pengguna untuk koneksi ini
sharedUserList	string[]
target	string
value	string	Detail nilai koneksi ruang kerja.
valueFormat	ValueFormat	format untuk nilai koneksi ruang kerja

OAuth2AuthTypeWorkspaceConnectionProperties

Nama	Jenis	Deskripsi
authType	string: OAuth2	Jenis autentikasi target koneksi
category	ConnectionCategory	Kategori koneksi
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionOAuth2	ClientId dan ClientSecret diperlukan. Properti lain bersifat opsional tergantung pada implementasi setiap penyedia OAuth2.
expiryTime	string
group	ConnectionGroup	Grup berdasarkan kategori koneksi
isSharedToAll	boolean
metadata	object	Simpan metadata pengguna untuk koneksi ini
sharedUserList	string[]
target	string
value	string	Detail nilai koneksi ruang kerja.
valueFormat	ValueFormat	format untuk nilai koneksi ruang kerja

PATAuthTypeWorkspaceConnectionProperties

Nama	Jenis	Deskripsi
authType	string: PAT	Jenis autentikasi target koneksi
category	ConnectionCategory	Kategori koneksi
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionPersonalAccessToken
expiryTime	string
group	ConnectionGroup	Grup berdasarkan kategori koneksi
isSharedToAll	boolean
metadata	object	Simpan metadata pengguna untuk koneksi ini
sharedUserList	string[]
target	string
value	string	Detail nilai koneksi ruang kerja.
valueFormat	ValueFormat	format untuk nilai koneksi ruang kerja

SASAuthTypeWorkspaceConnectionProperties

Nama	Jenis	Deskripsi
authType	string: SAS	Jenis autentikasi target koneksi
category	ConnectionCategory	Kategori koneksi
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionSharedAccessSignature
expiryTime	string
group	ConnectionGroup	Grup berdasarkan kategori koneksi
isSharedToAll	boolean
metadata	object	Simpan metadata pengguna untuk koneksi ini
sharedUserList	string[]
target	string
value	string	Detail nilai koneksi ruang kerja.
valueFormat	ValueFormat	format untuk nilai koneksi ruang kerja

ServicePrincipalAuthTypeWorkspaceConnectionProperties

Nama	Jenis	Deskripsi
authType	string: ServicePrincipal	Jenis autentikasi target koneksi
category	ConnectionCategory	Kategori koneksi
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionServicePrincipal
expiryTime	string
group	ConnectionGroup	Grup berdasarkan kategori koneksi
isSharedToAll	boolean
metadata	object	Simpan metadata pengguna untuk koneksi ini
sharedUserList	string[]
target	string
value	string	Detail nilai koneksi ruang kerja.
valueFormat	ValueFormat	format untuk nilai koneksi ruang kerja

systemData

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Nama	Jenis	Deskripsi
createdAt	string	Tanda waktu pembuatan sumber daya (UTC).
createdBy	string	Identitas yang membuat sumber daya.
createdByType	createdByType	Jenis identitas yang membuat sumber daya.
lastModifiedAt	string	Tanda waktu modifikasi terakhir sumber daya (UTC)
lastModifiedBy	string	Identitas yang terakhir memodifikasi sumber daya.
lastModifiedByType	createdByType	Jenis identitas yang terakhir mengubah sumber daya.

UsernamePasswordAuthTypeWorkspaceConnectionProperties

Nama	Jenis	Deskripsi
authType	string: UsernamePassword	Jenis autentikasi target koneksi
category	ConnectionCategory	Kategori koneksi
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionUsernamePassword
expiryTime	string
group	ConnectionGroup	Grup berdasarkan kategori koneksi
isSharedToAll	boolean
metadata	object	Simpan metadata pengguna untuk koneksi ini
sharedUserList	string[]
target	string
value	string	Detail nilai koneksi ruang kerja.
valueFormat	ValueFormat	format untuk nilai koneksi ruang kerja

ValueFormat

format untuk nilai koneksi ruang kerja

Nama	Jenis	Deskripsi
JSON	string

WorkspaceConnectionAccessKey

Nama	Jenis	Deskripsi
accessKeyId	string
secretAccessKey	string

WorkspaceConnectionAccountKey

Nama	Jenis	Deskripsi
key	string

WorkspaceConnectionApiKey

Objek kunci api untuk kredensial koneksi ruang kerja.

Nama	Jenis	Deskripsi
key	string

WorkspaceConnectionManagedIdentity

Nama	Jenis	Deskripsi
clientId	string
resourceId	string

WorkspaceConnectionOAuth2

ClientId dan ClientSecret diperlukan. Properti lain bersifat opsional tergantung pada implementasi setiap penyedia OAuth2.

Nama	Jenis	Deskripsi
authUrl	string	Diperlukan oleh kategori koneksi Concur
clientId	string	Id klien dalam format UUID
clientSecret	string
developerToken	string	Diperlukan oleh kategori koneksi GoogleAdWords
password	string
refreshToken	string	Diperlukan oleh GoogleBigQuery, GoogleAdWords, Hubspot, QuickBooks, Square, Xero, Zoho di mana pengguna perlu mendapatkan RefreshToken offline
tenantId	string	Diperlukan oleh kategori koneksi QuickBooks dan Xero
username	string	Concur, jenis pemberian AccessToken server auth ServiceNow adalah 'Kata Sandi' yang memerlukan UsernamePassword

WorkspaceConnectionPersonalAccessToken

Nama	Jenis	Deskripsi
pat	string

WorkspaceConnectionPropertiesV2BasicResource

Nama	Jenis	Deskripsi
id	string	ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nama sumber daya.
properties	WorkspaceConnectionPropertiesV2: AADAuthTypeWorkspaceConnectionProperties AccessKeyAuthTypeWorkspaceConnectionProperties AccountKeyAuthTypeWorkspaceConnectionProperties ApiKeyAuthWorkspaceConnectionProperties CustomKeysWorkspaceConnectionProperties ManagedIdentityAuthTypeWorkspaceConnectionProperties NoneAuthTypeWorkspaceConnectionProperties OAuth2AuthTypeWorkspaceConnectionProperties PATAuthTypeWorkspaceConnectionProperties SASAuthTypeWorkspaceConnectionProperties ServicePrincipalAuthTypeWorkspaceConnectionProperties UsernamePasswordAuthTypeWorkspaceConnectionProperties
systemData	systemData	Metadata Azure Resource Manager yang berisi informasi createdBy dan modifiedBy.
type	string	Jenis sumber daya. Misalnya, "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts"

WorkspaceConnectionServicePrincipal

Nama	Jenis	Deskripsi
clientId	string
clientSecret	string
tenantId	string

WorkspaceConnectionSharedAccessSignature

Nama	Jenis	Deskripsi
sas	string

WorkspaceConnectionUsernamePassword

Nama	Jenis	Deskripsi
password	string
securityToken	string	Opsional, diperlukan oleh koneksi seperti SalesForce untuk keamanan tambahan selain UsernamePassword
username	string

Bagikan melalui