Workspace Connections - Create

Ссылка

Service:: Machine Learning

API Version:: 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

Имя	В	Обязательно	Тип	Описание
connectionName	path	True	string	Понятное имя подключения к рабочей области Regex pattern: `^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$`
resourceGroupName	path	True	string	Имя группы ресурсов. Регистр букв в имени не учитывается.
subscriptionId	path	True	string	Идентификатор целевой подписки.
workspaceName	path	True	string	Имя рабочей области Машинного обучения Azure. Regex pattern: `^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$`
api-version	query	True	string	Версия API, используемая для данной операции.

Текст запроса

Имя	Обязательно	Тип	Описание
properties	True	WorkspaceConnectionPropertiesV2: PATAuthTypeWorkspaceConnectionProperties SASAuthTypeWorkspaceConnectionProperties UsernamePasswordAuthTypeWorkspaceConnectionProperties NoneAuthTypeWorkspaceConnectionProperties ManagedIdentityAuthTypeWorkspaceConnectionProperties AADAuthTypeWorkspaceConnectionProperties AccessKeyAuthTypeWorkspaceConnectionProperties AccountKeyAuthTypeWorkspaceConnectionProperties ApiKeyAuthWorkspaceConnectionProperties CustomKeysWorkspaceConnectionProperties OAuth2AuthTypeWorkspaceConnectionProperties ServicePrincipalAuthTypeWorkspaceConnectionProperties

Ответы

Имя	Тип	Описание
200 OK	WorkspaceConnectionPropertiesV2BasicResource	Запрос выполнен успешно; запрос был правильно сформирован и получен должным образом.
Other Status Codes	ErrorResponse	Ошибка

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory.

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

Scopes

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

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

Определения

Имя	Описание
AADAuthTypeWorkspaceConnectionProperties	Этот тип подключения охватывает проверку подлинности AAD для любой применимой службы Azure.
AccessKeyAuthTypeWorkspaceConnectionProperties
AccountKeyAuthTypeWorkspaceConnectionProperties	Этот тип подключения охватывает подключение к ключу учетной записи для службы хранилища Azure.
ApiKeyAuthWorkspaceConnectionProperties	Этот тип подключения охватывает универсальные категории подключений проверки подлинности ApiKey, например AzureOpenAI: Category:= AzureOpenAI AuthType:= ApiKey (дискриминатор типа) Credentials:= {ApiKey} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= {ApiBase} CognitiveService: Category:= CognitiveService AuthType:= ApiKey (как тип дискриминатор) Учетные данные:= {SubscriptionKey} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= ServiceRegion={serviceRegion} CognitiveSearch: Category:= CognitiveSearch AuthType:= ApiKey (как дискриминатор типа) Credentials:= {Key} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= {Endpoint} Использование контейнера свойств метаданных для полей ApiType, ApiVersion, Kind и других метаданных
ConnectionAuthType	Тип проверки подлинности целевого объекта подключения
ConnectionCategory	Категория подключения
ConnectionGroup	Группа на основе категории подключения
createdByType	Тип удостоверения, создавшего ресурс.
CustomKeys	Объект учетных данных пользовательских ключей
CustomKeysWorkspaceConnectionProperties	Category:= CustomKeys AuthType:= CustomKeys (как дискриминатор типа) Credentials:= {CustomKeys} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.CustomKeys Target:= {any value} Use Metadata property bag for ApiVersion и других полей метаданных
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Сообщение об ошибке
ManagedIdentityAuthTypeWorkspaceConnectionProperties
NoneAuthTypeWorkspaceConnectionProperties
OAuth2AuthTypeWorkspaceConnectionProperties
PATAuthTypeWorkspaceConnectionProperties
SASAuthTypeWorkspaceConnectionProperties
ServicePrincipalAuthTypeWorkspaceConnectionProperties
systemData	Метаданные, относящиеся к созданию и последнему изменению ресурса.
UsernamePasswordAuthTypeWorkspaceConnectionProperties
ValueFormat	формат для значения подключения к рабочей области
WorkspaceConnectionAccessKey
WorkspaceConnectionApiKey	Объект ключа API для учетных данных подключения к рабочей области.
WorkspaceConnectionManagedIdentity
WorkspaceConnectionOAuth2	ClientId и ClientSecret являются обязательными. Другие свойства являются необязательными в зависимости от реализации каждого поставщика OAuth2.
WorkspaceConnectionPersonalAccessToken
WorkspaceConnectionPropertiesV2BasicResource
WorkspaceConnectionServicePrincipal
WorkspaceConnectionSharedAccessSignature
WorkspaceConnectionUsernamePassword

AADAuthTypeWorkspaceConnectionProperties

Этот тип подключения охватывает проверку подлинности AAD для любой применимой службы Azure.

Имя	Тип	Описание
authType	string: AAD	Тип проверки подлинности целевого объекта подключения
category	ConnectionCategory	Категория подключения
createdByWorkspaceArmId	string
expiryTime	string
group	ConnectionGroup	Группа на основе категории подключения
isSharedToAll	boolean
metadata	object	Сохранение метаданных пользователя для этого подключения
sharedUserList	string[]
target	string
value	string	Сведения о значении подключения к рабочей области.
valueFormat	ValueFormat	формат для значения подключения к рабочей области

AccessKeyAuthTypeWorkspaceConnectionProperties

Имя	Тип	Описание
authType	string: AccessKey	Тип проверки подлинности целевого объекта подключения
category	ConnectionCategory	Категория подключения
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionAccessKey
expiryTime	string
group	ConnectionGroup	Группа на основе категории подключения
isSharedToAll	boolean
metadata	object	Сохранение метаданных пользователя для этого подключения
sharedUserList	string[]
target	string
value	string	Сведения о значении подключения к рабочей области.
valueFormat	ValueFormat	формат для значения подключения к рабочей области

AccountKeyAuthTypeWorkspaceConnectionProperties

Этот тип подключения охватывает подключение к ключу учетной записи для службы хранилища Azure.

Имя	Тип	Описание
authType	string: AccountKey	Тип проверки подлинности целевого объекта подключения
category	ConnectionCategory	Категория подключения
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionSharedAccessSignature
expiryTime	string
group	ConnectionGroup	Группа на основе категории подключения
isSharedToAll	boolean
metadata	object	Сохранение метаданных пользователя для этого подключения
sharedUserList	string[]
target	string
value	string	Сведения о значении подключения к рабочей области.
valueFormat	ValueFormat	формат для значения подключения к рабочей области

ApiKeyAuthWorkspaceConnectionProperties

Этот тип подключения охватывает универсальные категории подключений проверки подлинности ApiKey, например AzureOpenAI: Category:= AzureOpenAI AuthType:= ApiKey (дискриминатор типа) Credentials:= {ApiKey} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= {ApiBase}

CognitiveService: Category:= CognitiveService AuthType:= ApiKey (как тип дискриминатор) Учетные данные:= {SubscriptionKey} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= ServiceRegion={serviceRegion}

CognitiveSearch: Category:= CognitiveSearch AuthType:= ApiKey (как дискриминатор типа) Credentials:= {Key} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= {Endpoint}

Использование контейнера свойств метаданных для полей ApiType, ApiVersion, Kind и других метаданных

Имя	Тип	Описание
authType	string: ApiKey	Тип проверки подлинности целевого объекта подключения
category	ConnectionCategory	Категория подключения
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionApiKey	Объект ключа API для учетных данных подключения к рабочей области.
expiryTime	string
group	ConnectionGroup	Группа на основе категории подключения
isSharedToAll	boolean
metadata	object	Сохранение метаданных пользователя для этого подключения
sharedUserList	string[]
target	string
value	string	Сведения о значении подключения к рабочей области.
valueFormat	ValueFormat	формат для значения подключения к рабочей области

ConnectionAuthType

Тип проверки подлинности целевого объекта подключения

Имя	Тип	Описание
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

Категория подключения

Имя	Тип	Описание
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

Группа на основе категории подключения

Имя	Тип	Описание
Azure	string
AzureAI	string
Database	string
File	string
GenericProtocol	string
NoSQL	string
ServicesAndApps	string

createdByType

Тип удостоверения, создавшего ресурс.

Имя	Тип	Описание
Application	string
Key	string
ManagedIdentity	string
User	string

CustomKeys

Объект учетных данных пользовательских ключей

Имя	Тип	Описание
keys	object

CustomKeysWorkspaceConnectionProperties

Category:= CustomKeys AuthType:= CustomKeys (как дискриминатор типа) Credentials:= {CustomKeys} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.CustomKeys Target:= {any value} Use Metadata property bag for ApiVersion и других полей метаданных

Имя	Тип	Описание
authType	string: CustomKeys	Тип проверки подлинности целевого объекта подключения
category	ConnectionCategory	Категория подключения
createdByWorkspaceArmId	string
credentials	CustomKeys	Объект учетных данных пользовательских ключей
expiryTime	string
group	ConnectionGroup	Группа на основе категории подключения
isSharedToAll	boolean
metadata	object	Сохранение метаданных пользователя для этого подключения
sharedUserList	string[]
target	string
value	string	Сведения о значении подключения к рабочей области.
valueFormat	ValueFormat	формат для значения подключения к рабочей области

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Тип дополнительных сведений.

ErrorDetail

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Сообщение об ошибке

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

ManagedIdentityAuthTypeWorkspaceConnectionProperties

Имя	Тип	Описание
authType	string: ManagedIdentity	Тип проверки подлинности целевого объекта подключения
category	ConnectionCategory	Категория подключения
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionManagedIdentity
expiryTime	string
group	ConnectionGroup	Группа на основе категории подключения
isSharedToAll	boolean
metadata	object	Сохранение метаданных пользователя для этого подключения
sharedUserList	string[]
target	string
value	string	Сведения о значении подключения к рабочей области.
valueFormat	ValueFormat	формат для значения подключения к рабочей области

NoneAuthTypeWorkspaceConnectionProperties

Имя	Тип	Описание
authType	string: None	Тип проверки подлинности целевого объекта подключения
category	ConnectionCategory	Категория подключения
createdByWorkspaceArmId	string
expiryTime	string
group	ConnectionGroup	Группа на основе категории подключения
isSharedToAll	boolean
metadata	object	Сохранение метаданных пользователя для этого подключения
sharedUserList	string[]
target	string
value	string	Сведения о значении подключения к рабочей области.
valueFormat	ValueFormat	формат для значения подключения к рабочей области

OAuth2AuthTypeWorkspaceConnectionProperties

Имя	Тип	Описание
authType	string: OAuth2	Тип проверки подлинности целевого объекта подключения
category	ConnectionCategory	Категория подключения
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionOAuth2	ClientId и ClientSecret являются обязательными. Другие свойства являются необязательными в зависимости от реализации каждого поставщика OAuth2.
expiryTime	string
group	ConnectionGroup	Группа на основе категории подключения
isSharedToAll	boolean
metadata	object	Сохранение метаданных пользователя для этого подключения
sharedUserList	string[]
target	string
value	string	Сведения о значении подключения к рабочей области.
valueFormat	ValueFormat	формат для значения подключения к рабочей области

PATAuthTypeWorkspaceConnectionProperties

Имя	Тип	Описание
authType	string: PAT	Тип проверки подлинности целевого объекта подключения
category	ConnectionCategory	Категория подключения
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionPersonalAccessToken
expiryTime	string
group	ConnectionGroup	Группа на основе категории подключения
isSharedToAll	boolean
metadata	object	Сохранение метаданных пользователя для этого подключения
sharedUserList	string[]
target	string
value	string	Сведения о значении подключения к рабочей области.
valueFormat	ValueFormat	формат для значения подключения к рабочей области

SASAuthTypeWorkspaceConnectionProperties

Имя	Тип	Описание
authType	string: SAS	Тип проверки подлинности целевого объекта подключения
category	ConnectionCategory	Категория подключения
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionSharedAccessSignature
expiryTime	string
group	ConnectionGroup	Группа на основе категории подключения
isSharedToAll	boolean
metadata	object	Сохранение метаданных пользователя для этого подключения
sharedUserList	string[]
target	string
value	string	Сведения о значении подключения к рабочей области.
valueFormat	ValueFormat	формат для значения подключения к рабочей области

ServicePrincipalAuthTypeWorkspaceConnectionProperties

Имя	Тип	Описание
authType	string: ServicePrincipal	Тип проверки подлинности целевого объекта подключения
category	ConnectionCategory	Категория подключения
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionServicePrincipal
expiryTime	string
group	ConnectionGroup	Группа на основе категории подключения
isSharedToAll	boolean
metadata	object	Сохранение метаданных пользователя для этого подключения
sharedUserList	string[]
target	string
value	string	Сведения о значении подключения к рабочей области.
valueFormat	ValueFormat	формат для значения подключения к рабочей области

systemData

Метаданные, относящиеся к созданию и последнему изменению ресурса.

Имя	Тип	Описание
createdAt	string	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string	Метка времени последнего изменения ресурса (UTC)
lastModifiedBy	string	Удостоверение, которое в последний раз изменял ресурс.
lastModifiedByType	createdByType	Тип удостоверения, изменяющего ресурс в последний раз.

UsernamePasswordAuthTypeWorkspaceConnectionProperties

Имя	Тип	Описание
authType	string: UsernamePassword	Тип проверки подлинности целевого объекта подключения
category	ConnectionCategory	Категория подключения
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionUsernamePassword
expiryTime	string
group	ConnectionGroup	Группа на основе категории подключения
isSharedToAll	boolean
metadata	object	Сохранение метаданных пользователя для этого подключения
sharedUserList	string[]
target	string
value	string	Сведения о значении подключения к рабочей области.
valueFormat	ValueFormat	формат для значения подключения к рабочей области

ValueFormat

формат для значения подключения к рабочей области

Имя	Тип	Описание
JSON	string

WorkspaceConnectionAccessKey

Имя	Тип	Описание
accessKeyId	string
secretAccessKey	string

WorkspaceConnectionApiKey

Объект ключа API для учетных данных подключения к рабочей области.

Имя	Тип	Описание
key	string

WorkspaceConnectionManagedIdentity

Имя	Тип	Описание
clientId	string
resourceId	string

WorkspaceConnectionOAuth2

ClientId и ClientSecret являются обязательными. Другие свойства являются необязательными в зависимости от реализации каждого поставщика OAuth2.

Имя	Тип	Описание
authUrl	string	Требуется для категории подключения Concur
clientId	string	Идентификатор клиента в формате UUID
clientSecret	string
developerToken	string	Требуется для категории подключения GoogleAdWords
password	string
refreshToken	string	Требуется для GoogleBigQuery, GoogleAdWords, Hubspot, QuickBooks, Square, Xero, Zoho, где пользователю необходимо получить RefreshToken в автономном режиме
tenantId	string	Требуется для категорий подключений QuickBooks и Xero
username	string	Concur, Тип предоставления доступа AccessToken для сервера проверки подлинности ServiceNow — "Пароль", для которого требуется UsernamePassword

WorkspaceConnectionPersonalAccessToken

Имя	Тип	Описание
pat	string

WorkspaceConnectionPropertiesV2BasicResource

Имя	Тип	Описание
id	string	Полный идентификатор ресурса. Пример : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Имя ресурса.
properties	WorkspaceConnectionPropertiesV2: AADAuthTypeWorkspaceConnectionProperties AccessKeyAuthTypeWorkspaceConnectionProperties AccountKeyAuthTypeWorkspaceConnectionProperties ApiKeyAuthWorkspaceConnectionProperties CustomKeysWorkspaceConnectionProperties ManagedIdentityAuthTypeWorkspaceConnectionProperties NoneAuthTypeWorkspaceConnectionProperties OAuth2AuthTypeWorkspaceConnectionProperties PATAuthTypeWorkspaceConnectionProperties SASAuthTypeWorkspaceConnectionProperties ServicePrincipalAuthTypeWorkspaceConnectionProperties UsernamePasswordAuthTypeWorkspaceConnectionProperties
systemData	systemData	Azure Resource Manager метаданные, содержащие сведения о createdBy и modifiedBy.
type	string	Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

WorkspaceConnectionServicePrincipal

Имя	Тип	Описание
clientId	string
clientSecret	string
tenantId	string

WorkspaceConnectionSharedAccessSignature

Имя	Тип	Описание
sas	string

WorkspaceConnectionUsernamePassword

Имя	Тип	Описание
password	string
securityToken	string	Необязательно, требуется для таких подключений, как SalesForce, для дополнительной безопасности в дополнение к UsernamePassword
username	string

Share via