Workspace Connections - Create

Başvuru

Hizmet:: Machine Learning

API Sürümü:: 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 Parametreleri

Name	İçinde	Gerekli	Tür	Description
connectionName	path	True	string	Çalışma alanı bağlantısının kolay adı Normal ifade deseni: `^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$`
resourceGroupName	path	True	string	Kaynak grubunun adı. Ad büyük/küçük harfe duyarlı değildir.
subscriptionId	path	True	string	Hedef aboneliğin kimliği.
workspaceName	path	True	string	Azure Machine Learning çalışma alanının adı. Normal ifade deseni: `^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$`
api-version	query	True	string	Bu işlem için kullanılacak API sürümü.

İstek Gövdesi

Name	Gerekli	Tür	Description
properties	True	WorkspaceConnectionPropertiesV2: PATAuthTypeWorkspaceConnectionProperties SASAuthTypeWorkspaceConnectionProperties UsernamePasswordAuthTypeWorkspaceConnectionProperties NoneAuthTypeWorkspaceConnectionProperties ManagedIdentityAuthTypeWorkspaceConnectionProperties AADAuthTypeWorkspaceConnectionProperties AccessKeyAuthTypeWorkspaceConnectionProperties AccountKeyAuthTypeWorkspaceConnectionProperties ApiKeyAuthWorkspaceConnectionProperties CustomKeysWorkspaceConnectionProperties OAuth2AuthTypeWorkspaceConnectionProperties ServicePrincipalAuthTypeWorkspaceConnectionProperties

Yanıtlar

Name	Tür	Description
200 OK	WorkspaceConnectionPropertiesV2BasicResource	İstek başarılı oldu; istek düzgün biçimlendirilmiş ve düzgün bir şekilde alınmıştı.
Other Status Codes	ErrorResponse	Hata

Güvenlik

azure_auth

Azure Active Directory OAuth2 Flow.

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

CreateWorkspaceConnection

Örnek isteği

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

Örnek yanıt

Durum kodu:: 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"
  }
}

Tanımlar

Name	Description
AADAuthTypeWorkspaceConnectionProperties	Bu bağlantı türü, geçerli herhangi bir Azure hizmeti için AAD kimlik doğrulamasını kapsar
AccessKeyAuthTypeWorkspaceConnectionProperties
AccountKeyAuthTypeWorkspaceConnectionProperties	Bu bağlantı türü, Azure depolama için hesap anahtarı bağlantısını kapsar
ApiKeyAuthWorkspaceConnectionProperties	Bu bağlantı türü, örnekler için genel ApiKey kimlik doğrulaması bağlantı kategorilerini kapsar: AzureOpenAI: Category:= AzureOpenAI AuthType:= ApiKey (tür ayrıştırıcısı olarak) Kimlik Bilgileri:= {ApiKey} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= {ApiBase} CognitiveService: Category:= CognitiveService AuthType:= ApiKey (tür ayrımcı olarak) Kimlik Bilgileri:= {SubscriptionKey} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= ServiceRegion={serviceRegion} CognitiveSearch: Category:= CognitiveSearch AuthType:= ApiKey (tür ayrımcı olarak) Kimlik Bilgileri:= {Key} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= {Endpoint} ApiType, ApiVersion, Kind ve diğer meta veri alanları için Metadata özellik çantasını kullanma
ConnectionAuthType	Bağlantı hedefinin kimlik doğrulama türü
ConnectionCategory	Bağlantı kategorisi
ConnectionGroup	Bağlantı kategorisine göre grup
createdByType	Kaynağı oluşturan kimliğin türü.
CustomKeys	Özel Anahtarlar kimlik bilgisi nesnesi
CustomKeysWorkspaceConnectionProperties	Category:= CustomKeys AuthType:= CustomKeys (tür ayrımcı olarak) Kimlik Bilgileri:= {CustomKeys} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.CustomKeys Target:= {any value} ApiVersion ve diğer meta veri alanları için Meta veri özellik çantasını kullanın
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
ErrorDetail	Hata ayrıntısı.
ErrorResponse	Hata yanıtı
ManagedIdentityAuthTypeWorkspaceConnectionProperties
NoneAuthTypeWorkspaceConnectionProperties
OAuth2AuthTypeWorkspaceConnectionProperties
PATAuthTypeWorkspaceConnectionProperties
SASAuthTypeWorkspaceConnectionProperties
ServicePrincipalAuthTypeWorkspaceConnectionProperties
systemData	Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.
UsernamePasswordAuthTypeWorkspaceConnectionProperties
ValueFormat	çalışma alanı bağlantı değeri biçimi
WorkspaceConnectionAccessKey
WorkspaceConnectionAccountKey
WorkspaceConnectionApiKey	Çalışma alanı bağlantısı kimlik bilgileri için API anahtar nesnesi.
WorkspaceConnectionManagedIdentity
WorkspaceConnectionOAuth2	ClientId ve ClientSecret gereklidir. Diğer özellikler, her OAuth2 sağlayıcısının uygulamasına bağlı olarak isteğe bağlıdır.
WorkspaceConnectionPersonalAccessToken
WorkspaceConnectionPropertiesV2BasicResource
WorkspaceConnectionServicePrincipal
WorkspaceConnectionSharedAccessSignature
WorkspaceConnectionUsernamePassword

AADAuthTypeWorkspaceConnectionProperties

Bu bağlantı türü, geçerli herhangi bir Azure hizmeti için AAD kimlik doğrulamasını kapsar

Name	Tür	Description
authType	string: AAD	Bağlantı hedefinin kimlik doğrulama türü
category	ConnectionCategory	Bağlantı kategorisi
createdByWorkspaceArmId	string
expiryTime	string
group	ConnectionGroup	Bağlantı kategorisine göre grup
isSharedToAll	boolean
metadata	object	Bu bağlantı için kullanıcı meta verilerini depola
sharedUserList	string[]
target	string
value	string	Çalışma alanı bağlantısının değer ayrıntıları.
valueFormat	ValueFormat	çalışma alanı bağlantı değeri biçimi

AccessKeyAuthTypeWorkspaceConnectionProperties

Name	Tür	Description
authType	string: AccessKey	Bağlantı hedefinin kimlik doğrulama türü
category	ConnectionCategory	Bağlantı kategorisi
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionAccessKey
expiryTime	string
group	ConnectionGroup	Bağlantı kategorisine göre grup
isSharedToAll	boolean
metadata	object	Bu bağlantı için kullanıcı meta verilerini depola
sharedUserList	string[]
target	string
value	string	Çalışma alanı bağlantısının değer ayrıntıları.
valueFormat	ValueFormat	çalışma alanı bağlantı değeri biçimi

AccountKeyAuthTypeWorkspaceConnectionProperties

Bu bağlantı türü, Azure depolama için hesap anahtarı bağlantısını kapsar

Name	Tür	Description
authType	string: AccountKey	Bağlantı hedefinin kimlik doğrulama türü
category	ConnectionCategory	Bağlantı kategorisi
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionAccountKey
expiryTime	string
group	ConnectionGroup	Bağlantı kategorisine göre grup
isSharedToAll	boolean
metadata	object	Bu bağlantı için kullanıcı meta verilerini depola
sharedUserList	string[]
target	string
value	string	Çalışma alanı bağlantısının değer ayrıntıları.
valueFormat	ValueFormat	çalışma alanı bağlantı değeri biçimi

ApiKeyAuthWorkspaceConnectionProperties

Bu bağlantı türü, örnekler için genel ApiKey kimlik doğrulaması bağlantı kategorilerini kapsar: AzureOpenAI: Category:= AzureOpenAI AuthType:= ApiKey (tür ayrıştırıcısı olarak) Kimlik Bilgileri:= {ApiKey} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= {ApiBase}

CognitiveService: Category:= CognitiveService AuthType:= ApiKey (tür ayrımcı olarak) Kimlik Bilgileri:= {SubscriptionKey} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= ServiceRegion={serviceRegion}

CognitiveSearch: Category:= CognitiveSearch AuthType:= ApiKey (tür ayrımcı olarak) Kimlik Bilgileri:= {Key} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= {Endpoint}

ApiType, ApiVersion, Kind ve diğer meta veri alanları için Metadata özellik çantasını kullanma

Name	Tür	Description
authType	string: ApiKey	Bağlantı hedefinin kimlik doğrulama türü
category	ConnectionCategory	Bağlantı kategorisi
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionApiKey	Çalışma alanı bağlantı kimlik bilgileri için API anahtar nesnesi.
expiryTime	string
group	ConnectionGroup	Bağlantı kategorisine göre grup
isSharedToAll	boolean
metadata	object	Bu bağlantı için kullanıcı meta verilerini depola
sharedUserList	string[]
target	string
value	string	Çalışma alanı bağlantısının değer ayrıntıları.
valueFormat	ValueFormat	çalışma alanı bağlantı değeri biçimi

ConnectionAuthType

Bağlantı hedefinin kimlik doğrulama türü

Name	Tür	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

Bağlantı kategorisi

Name	Tür	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

Bağlantı kategorisine göre grup

Name	Tür	Description
Azure	string
AzureAI	string
Database	string
File	string
GenericProtocol	string
NoSQL	string
ServicesAndApps	string

createdByType

Kaynağı oluşturan kimliğin türü.

Name	Tür	Description
Application	string
Key	string
ManagedIdentity	string
User	string

CustomKeys

Özel Anahtarlar kimlik bilgisi nesnesi

Name	Tür	Description
keys	object

CustomKeysWorkspaceConnectionProperties

Category:= CustomKeys AuthType:= CustomKeys (tür ayrımcı olarak) Kimlik Bilgileri:= {CustomKeys} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.CustomKeys Target:= {any value} ApiVersion ve diğer meta veri alanları için Meta veri özellik çantasını kullanın

Name	Tür	Description
authType	string: CustomKeys	Bağlantı hedefinin kimlik doğrulama türü
category	ConnectionCategory	Bağlantı kategorisi
createdByWorkspaceArmId	string
credentials	CustomKeys	Özel Anahtarlar kimlik bilgisi nesnesi
expiryTime	string
group	ConnectionGroup	Bağlantı kategorisine göre grup
isSharedToAll	boolean
metadata	object	Bu bağlantı için kullanıcı meta verilerini depola
sharedUserList	string[]
target	string
value	string	Çalışma alanı bağlantısının değer ayrıntıları.
valueFormat	ValueFormat	çalışma alanı bağlantı değeri biçimi

ErrorAdditionalInfo

Kaynak yönetimi hatası ek bilgileri.

Name	Tür	Description
info	object	Ek bilgiler.
type	string	Ek bilgi türü.

ErrorDetail

Hata ayrıntısı.

Name	Tür	Description
additionalInfo	ErrorAdditionalInfo[]	Hata ek bilgileri.
code	string	Hata kodu.
details	ErrorDetail[]	Hata ayrıntıları.
message	string	Hata iletisi.
target	string	Hata hedefi.

ErrorResponse

Hata yanıtı

Name	Tür	Description
error	ErrorDetail	Hata nesnesi.

ManagedIdentityAuthTypeWorkspaceConnectionProperties

Name	Tür	Description
authType	string: ManagedIdentity	Bağlantı hedefinin kimlik doğrulama türü
category	ConnectionCategory	Bağlantı kategorisi
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionManagedIdentity
expiryTime	string
group	ConnectionGroup	Bağlantı kategorisine göre grup
isSharedToAll	boolean
metadata	object	Bu bağlantı için kullanıcı meta verilerini depola
sharedUserList	string[]
target	string
value	string	Çalışma alanı bağlantısının değer ayrıntıları.
valueFormat	ValueFormat	çalışma alanı bağlantı değeri biçimi

NoneAuthTypeWorkspaceConnectionProperties

Name	Tür	Description
authType	string: None	Bağlantı hedefinin kimlik doğrulama türü
category	ConnectionCategory	Bağlantı kategorisi
createdByWorkspaceArmId	string
expiryTime	string
group	ConnectionGroup	Bağlantı kategorisine göre grup
isSharedToAll	boolean
metadata	object	Bu bağlantı için kullanıcı meta verilerini depola
sharedUserList	string[]
target	string
value	string	Çalışma alanı bağlantısının değer ayrıntıları.
valueFormat	ValueFormat	çalışma alanı bağlantı değeri biçimi

OAuth2AuthTypeWorkspaceConnectionProperties

Name	Tür	Description
authType	string: OAuth2	Bağlantı hedefinin kimlik doğrulama türü
category	ConnectionCategory	Bağlantı kategorisi
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionOAuth2	ClientId ve ClientSecret gereklidir. Diğer özellikler, her OAuth2 sağlayıcısının uygulamasına bağlı olarak isteğe bağlıdır.
expiryTime	string
group	ConnectionGroup	Bağlantı kategorisine göre grup
isSharedToAll	boolean
metadata	object	Bu bağlantı için kullanıcı meta verilerini depola
sharedUserList	string[]
target	string
value	string	Çalışma alanı bağlantısının değer ayrıntıları.
valueFormat	ValueFormat	çalışma alanı bağlantı değeri biçimi

PATAuthTypeWorkspaceConnectionProperties

Name	Tür	Description
authType	string: PAT	Bağlantı hedefinin kimlik doğrulama türü
category	ConnectionCategory	Bağlantı kategorisi
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionPersonalAccessToken
expiryTime	string
group	ConnectionGroup	Bağlantı kategorisine göre grup
isSharedToAll	boolean
metadata	object	Bu bağlantı için kullanıcı meta verilerini depola
sharedUserList	string[]
target	string
value	string	Çalışma alanı bağlantısının değer ayrıntıları.
valueFormat	ValueFormat	çalışma alanı bağlantı değeri biçimi

SASAuthTypeWorkspaceConnectionProperties

Name	Tür	Description
authType	string: SAS	Bağlantı hedefinin kimlik doğrulama türü
category	ConnectionCategory	Bağlantı kategorisi
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionSharedAccessSignature
expiryTime	string
group	ConnectionGroup	Bağlantı kategorisine göre grup
isSharedToAll	boolean
metadata	object	Bu bağlantı için kullanıcı meta verilerini depola
sharedUserList	string[]
target	string
value	string	Çalışma alanı bağlantısının değer ayrıntıları.
valueFormat	ValueFormat	çalışma alanı bağlantı değeri biçimi

ServicePrincipalAuthTypeWorkspaceConnectionProperties

Name	Tür	Description
authType	string: ServicePrincipal	Bağlantı hedefinin kimlik doğrulama türü
category	ConnectionCategory	Bağlantı kategorisi
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionServicePrincipal
expiryTime	string
group	ConnectionGroup	Bağlantı kategorisine göre grup
isSharedToAll	boolean
metadata	object	Bu bağlantı için kullanıcı meta verilerini depola
sharedUserList	string[]
target	string
value	string	Çalışma alanı bağlantısının değer ayrıntıları.
valueFormat	ValueFormat	çalışma alanı bağlantı değeri biçimi

systemData

Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

Name	Tür	Description
createdAt	string	Kaynak oluşturma (UTC) zaman damgası.
createdBy	string	Kaynağı oluşturan kimlik.
createdByType	createdByType	Kaynağı oluşturan kimliğin türü.
lastModifiedAt	string	Kaynağın son değişikliğinin zaman damgası (UTC)
lastModifiedBy	string	Kaynağı en son değiştiren kimlik.
lastModifiedByType	createdByType	Kaynağı en son değiştiren kimliğin türü.

UsernamePasswordAuthTypeWorkspaceConnectionProperties

Name	Tür	Description
authType	string: UsernamePassword	Bağlantı hedefinin kimlik doğrulama türü
category	ConnectionCategory	Bağlantı kategorisi
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionUsernamePassword
expiryTime	string
group	ConnectionGroup	Bağlantı kategorisine göre grup
isSharedToAll	boolean
metadata	object	Bu bağlantı için kullanıcı meta verilerini depola
sharedUserList	string[]
target	string
value	string	Çalışma alanı bağlantısının değer ayrıntıları.
valueFormat	ValueFormat	çalışma alanı bağlantı değeri biçimi

ValueFormat

çalışma alanı bağlantı değeri biçimi

Name	Tür	Description
JSON	string

WorkspaceConnectionAccessKey

Name	Tür	Description
accessKeyId	string
secretAccessKey	string

WorkspaceConnectionAccountKey

Name	Tür	Description
key	string

WorkspaceConnectionApiKey

Çalışma alanı bağlantısı kimlik bilgileri için API anahtar nesnesi.

Name	Tür	Description
key	string

WorkspaceConnectionManagedIdentity

Name	Tür	Description
clientId	string
resourceId	string

WorkspaceConnectionOAuth2

ClientId ve ClientSecret gereklidir. Diğer özellikler, her OAuth2 sağlayıcısının uygulamasına bağlı olarak isteğe bağlıdır.

Name	Tür	Description
authUrl	string	Concur bağlantı kategorisi için gereklidir
clientId	string	UUID biçiminde istemci kimliği
clientSecret	string
developerToken	string	GoogleAdWords bağlantı kategorisi için gereklidir
password	string
refreshToken	string	Kullanıcının RefreshToken'ı çevrimdışına alması gereken GoogleBigQuery, GoogleAdWords, Hubspot, QuickBooks, Square, Xero, Zoho için gereklidir
tenantId	string	QuickBooks ve Xero bağlantı kategorileri için gereklidir
username	string	Concur, ServiceNow kimlik doğrulama sunucusu AccessToken verme türü, UsernamePassword gerektiren 'Password' değeridir

WorkspaceConnectionPersonalAccessToken

Name	Tür	Description
pat	string

WorkspaceConnectionPropertiesV2BasicResource

Name	Tür	Description
id	string	Kaynağın tam kaynak kimliği. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Kaynağın adı
properties	WorkspaceConnectionPropertiesV2: AADAuthTypeWorkspaceConnectionProperties AccessKeyAuthTypeWorkspaceConnectionProperties AccountKeyAuthTypeWorkspaceConnectionProperties ApiKeyAuthWorkspaceConnectionProperties CustomKeysWorkspaceConnectionProperties ManagedIdentityAuthTypeWorkspaceConnectionProperties NoneAuthTypeWorkspaceConnectionProperties OAuth2AuthTypeWorkspaceConnectionProperties PATAuthTypeWorkspaceConnectionProperties SASAuthTypeWorkspaceConnectionProperties ServicePrincipalAuthTypeWorkspaceConnectionProperties UsernamePasswordAuthTypeWorkspaceConnectionProperties
systemData	systemData	Azure Resource Manager createdBy ve modifiedBy bilgilerini içeren meta veriler.
type	string	Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts"

WorkspaceConnectionServicePrincipal

Name	Tür	Description
clientId	string
clientSecret	string
tenantId	string

WorkspaceConnectionSharedAccessSignature

Name	Tür	Description
sas	string

WorkspaceConnectionUsernamePassword

Name	Tür	Description
password	string
securityToken	string	İsteğe bağlı, UsernamePassword'e ek güvenlik için SalesForce gibi bağlantılar için gereklidir
username	string

Aracılığıyla paylaş