Workspace Connections - Create

Serviço:

Machine Learning

Versão da 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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
connectionName	path	True	string	Nome amigável da conexão do workspace Padrão Regex: ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$
resourceGroupName	path	True	string	O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string	A ID da assinatura de destino.
workspaceName	path	True	string	Nome do workspace do Azure Machine Learning. Padrão Regex: ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$
api-version	query	True	string	A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
properties	True	WorkspaceConnectionPropertiesV2: PATAuthTypeWorkspaceConnectionProperties SASAuthTypeWorkspaceConnectionProperties UsernamePasswordAuthTypeWorkspaceConnectionProperties NoneAuthTypeWorkspaceConnectionProperties ManagedIdentityAuthTypeWorkspaceConnectionProperties AADAuthTypeWorkspaceConnectionProperties AccessKeyAuthTypeWorkspaceConnectionProperties AccountKeyAuthTypeWorkspaceConnectionProperties ApiKeyAuthWorkspaceConnectionProperties CustomKeysWorkspaceConnectionProperties OAuth2AuthTypeWorkspaceConnectionProperties ServicePrincipalAuthTypeWorkspaceConnectionProperties

Respostas

Nome	Tipo	Description
200 OK	WorkspaceConnectionPropertiesV2BasicResource	A solicitação foi bem-sucedida; a solicitação foi bem formada e recebida corretamente.
Other Status Codes	ErrorResponse	Erro

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Scopes

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

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

Definições

Nome	Description
AADAuthTypeWorkspaceConnectionProperties	Esse tipo de conexão abrange a autenticação do AAD para qualquer serviço do Azure aplicável
AccessKeyAuthTypeWorkspaceConnectionProperties
AccountKeyAuthTypeWorkspaceConnectionProperties	Esse tipo de conexão abrange a conexão de chave de conta para o armazenamento do Azure
ApiKeyAuthWorkspaceConnectionProperties	Esse tipo de conexão abrange as categorias genéricas de conexão de autenticação ApiKey, por exemplo: AzureOpenAI: Category:= AzureOpenAI AuthType:= ApiKey (como discriminador de tipo) Credenciais:= {ApiKey} como Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= {ApiBase} CognitiveService: Category:= CognitiveService AuthType:= ApiKey (como discriminador de tipo) Credenciais:= {SubscriptionKey} como Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= ServiceRegion={serviceRegion} CognitiveSearch: Category:= CognitiveSearch AuthType:= ApiKey (como tipo discriminatório) Credenciais:= {Key} como Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= {Endpoint} Usar o recipiente de propriedades De metadados para ApiType, ApiVersion, Kind e outros campos de metadados
ConnectionAuthType	Tipo de autenticação do destino de conexão
ConnectionCategory	Categoria da conexão
ConnectionGroup	Agrupar com base na categoria de conexão
createdByType	O tipo de identidade que criou o recurso.
CustomKeys	Objeto de credencial de chaves personalizadas
CustomKeysWorkspaceConnectionProperties	Categoria:= CustomKeys AuthType:= CustomKeys (como discriminador de tipo)Credenciais:= {CustomKeys} como Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.CustomKeys Target:= {any value} Use o recipiente de propriedades De metadados para ApiVersion e outros campos de metadados
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
ManagedIdentityAuthTypeWorkspaceConnectionProperties
NoneAuthTypeWorkspaceConnectionProperties
OAuth2AuthTypeWorkspaceConnectionProperties
PATAuthTypeWorkspaceConnectionProperties
SASAuthTypeWorkspaceConnectionProperties
ServicePrincipalAuthTypeWorkspaceConnectionProperties
systemData	Metadados relativos à criação e à última modificação do recurso.
UsernamePasswordAuthTypeWorkspaceConnectionProperties
ValueFormat	formato para o valor de conexão do workspace
WorkspaceConnectionAccessKey
WorkspaceConnectionAccountKey
WorkspaceConnectionApiKey	Objeto de chave de API para credencial de conexão de workspace.
WorkspaceConnectionManagedIdentity
WorkspaceConnectionOAuth2	ClientId e ClientSecret são necessários. Outras propriedades são opcionais dependendo da implementação de cada provedor OAuth2.
WorkspaceConnectionPersonalAccessToken
WorkspaceConnectionPropertiesV2BasicResource
WorkspaceConnectionServicePrincipal
WorkspaceConnectionSharedAccessSignature
WorkspaceConnectionUsernamePassword

AADAuthTypeWorkspaceConnectionProperties

Esse tipo de conexão abrange a autenticação do AAD para qualquer serviço do Azure aplicável

Nome	Tipo	Description
authType	string: AAD	Tipo de autenticação do destino de conexão
category	ConnectionCategory	Categoria da conexão
createdByWorkspaceArmId	string
expiryTime	string
group	ConnectionGroup	Agrupar com base na categoria de conexão
isSharedToAll	boolean
metadata	object	Armazenar metadados de usuário para essa conexão
sharedUserList	string[]
target	string
value	string	Detalhes do valor da conexão do workspace.
valueFormat	ValueFormat	formato para o valor de conexão do workspace

AccessKeyAuthTypeWorkspaceConnectionProperties

Nome	Tipo	Description
authType	string: AccessKey	Tipo de autenticação do destino de conexão
category	ConnectionCategory	Categoria da conexão
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionAccessKey
expiryTime	string
group	ConnectionGroup	Agrupar com base na categoria de conexão
isSharedToAll	boolean
metadata	object	Armazenar metadados de usuário para essa conexão
sharedUserList	string[]
target	string
value	string	Detalhes do valor da conexão do workspace.
valueFormat	ValueFormat	formato para o valor de conexão do workspace

AccountKeyAuthTypeWorkspaceConnectionProperties

Esse tipo de conexão abrange a conexão de chave de conta para o armazenamento do Azure

Nome	Tipo	Description
authType	string: AccountKey	Tipo de autenticação do destino de conexão
category	ConnectionCategory	Categoria da conexão
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionAccountKey
expiryTime	string
group	ConnectionGroup	Agrupar com base na categoria de conexão
isSharedToAll	boolean
metadata	object	Armazenar metadados de usuário para essa conexão
sharedUserList	string[]
target	string
value	string	Detalhes do valor da conexão do workspace.
valueFormat	ValueFormat	formato para o valor de conexão do workspace

ApiKeyAuthWorkspaceConnectionProperties

Esse tipo de conexão abrange as categorias genéricas de conexão de autenticação ApiKey, por exemplo: AzureOpenAI: Category:= AzureOpenAI AuthType:= ApiKey (como discriminador de tipo) Credenciais:= {ApiKey} como Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= {ApiBase}

CognitiveService: Category:= CognitiveService AuthType:= ApiKey (como discriminador de tipo) Credenciais:= {SubscriptionKey} como Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= ServiceRegion={serviceRegion}

CognitiveSearch: Category:= CognitiveSearch AuthType:= ApiKey (como tipo discriminatório) Credenciais:= {Key} como Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= {Endpoint}

Usar o recipiente de propriedades De metadados para ApiType, ApiVersion, Kind e outros campos de metadados

Nome	Tipo	Description
authType	string: ApiKey	Tipo de autenticação do destino de conexão
category	ConnectionCategory	Categoria da conexão
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionApiKey	Objeto de chave de API para credencial de conexão de workspace.
expiryTime	string
group	ConnectionGroup	Agrupar com base na categoria de conexão
isSharedToAll	boolean
metadata	object	Armazenar metadados de usuário para essa conexão
sharedUserList	string[]
target	string
value	string	Detalhes do valor da conexão do workspace.
valueFormat	ValueFormat	formato para o valor de conexão do workspace

ConnectionAuthType

Tipo de autenticação do destino de conexão

Nome	Tipo	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

Categoria da conexão

Nome	Tipo	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

Agrupar com base na categoria de conexão

Nome	Tipo	Description
Azure	string
AzureAI	string
Database	string
File	string
GenericProtocol	string
NoSQL	string
ServicesAndApps	string

createdByType

O tipo de identidade que criou o recurso.

Nome	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

CustomKeys

Objeto de credencial de chaves personalizadas

Nome	Tipo	Description
keys	object

CustomKeysWorkspaceConnectionProperties

Categoria:= CustomKeys AuthType:= CustomKeys (como discriminador de tipo)Credenciais:= {CustomKeys} como Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.CustomKeys Target:= {any value} Use o recipiente de propriedades De metadados para ApiVersion e outros campos de metadados

Nome	Tipo	Description
authType	string: CustomKeys	Tipo de autenticação do destino de conexão
category	ConnectionCategory	Categoria da conexão
createdByWorkspaceArmId	string
credentials	CustomKeys	Objeto de credencial de chaves personalizadas
expiryTime	string
group	ConnectionGroup	Agrupar com base na categoria de conexão
isSharedToAll	boolean
metadata	object	Armazenar metadados de usuário para essa conexão
sharedUserList	string[]
target	string
value	string	Detalhes do valor da conexão do workspace.
valueFormat	ValueFormat	formato para o valor de conexão do workspace

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

ManagedIdentityAuthTypeWorkspaceConnectionProperties

Nome	Tipo	Description
authType	string: ManagedIdentity	Tipo de autenticação do destino de conexão
category	ConnectionCategory	Categoria da conexão
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionManagedIdentity
expiryTime	string
group	ConnectionGroup	Agrupar com base na categoria de conexão
isSharedToAll	boolean
metadata	object	Armazenar metadados de usuário para essa conexão
sharedUserList	string[]
target	string
value	string	Detalhes do valor da conexão do workspace.
valueFormat	ValueFormat	formato para o valor de conexão do workspace

NoneAuthTypeWorkspaceConnectionProperties

Nome	Tipo	Description
authType	string: None	Tipo de autenticação do destino de conexão
category	ConnectionCategory	Categoria da conexão
createdByWorkspaceArmId	string
expiryTime	string
group	ConnectionGroup	Agrupar com base na categoria de conexão
isSharedToAll	boolean
metadata	object	Armazenar metadados de usuário para essa conexão
sharedUserList	string[]
target	string
value	string	Detalhes do valor da conexão do workspace.
valueFormat	ValueFormat	formato para o valor de conexão do workspace

OAuth2AuthTypeWorkspaceConnectionProperties

Nome	Tipo	Description
authType	string: OAuth2	Tipo de autenticação do destino de conexão
category	ConnectionCategory	Categoria da conexão
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionOAuth2	ClientId e ClientSecret são necessários. Outras propriedades são opcionais dependendo da implementação de cada provedor OAuth2.
expiryTime	string
group	ConnectionGroup	Agrupar com base na categoria de conexão
isSharedToAll	boolean
metadata	object	Armazenar metadados de usuário para essa conexão
sharedUserList	string[]
target	string
value	string	Detalhes do valor da conexão do workspace.
valueFormat	ValueFormat	formato para o valor de conexão do workspace

PATAuthTypeWorkspaceConnectionProperties

Nome	Tipo	Description
authType	string: PAT	Tipo de autenticação do destino de conexão
category	ConnectionCategory	Categoria da conexão
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionPersonalAccessToken
expiryTime	string
group	ConnectionGroup	Agrupar com base na categoria de conexão
isSharedToAll	boolean
metadata	object	Armazenar metadados de usuário para essa conexão
sharedUserList	string[]
target	string
value	string	Detalhes do valor da conexão do workspace.
valueFormat	ValueFormat	formato para o valor de conexão do workspace

SASAuthTypeWorkspaceConnectionProperties

Nome	Tipo	Description
authType	string: SAS	Tipo de autenticação do destino de conexão
category	ConnectionCategory	Categoria da conexão
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionSharedAccessSignature
expiryTime	string
group	ConnectionGroup	Agrupar com base na categoria de conexão
isSharedToAll	boolean
metadata	object	Armazenar metadados de usuário para essa conexão
sharedUserList	string[]
target	string
value	string	Detalhes do valor da conexão do workspace.
valueFormat	ValueFormat	formato para o valor de conexão do workspace

ServicePrincipalAuthTypeWorkspaceConnectionProperties

Nome	Tipo	Description
authType	string: ServicePrincipal	Tipo de autenticação do destino de conexão
category	ConnectionCategory	Categoria da conexão
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionServicePrincipal
expiryTime	string
group	ConnectionGroup	Agrupar com base na categoria de conexão
isSharedToAll	boolean
metadata	object	Armazenar metadados de usuário para essa conexão
sharedUserList	string[]
target	string
value	string	Detalhes do valor da conexão do workspace.
valueFormat	ValueFormat	formato para o valor de conexão do workspace

systemData

Metadados relativos à criação e à última modificação do recurso.

Nome	Tipo	Description
createdAt	string	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

UsernamePasswordAuthTypeWorkspaceConnectionProperties

Nome	Tipo	Description
authType	string: UsernamePassword	Tipo de autenticação do destino de conexão
category	ConnectionCategory	Categoria da conexão
createdByWorkspaceArmId	string
credentials	WorkspaceConnectionUsernamePassword
expiryTime	string
group	ConnectionGroup	Agrupar com base na categoria de conexão
isSharedToAll	boolean
metadata	object	Armazenar metadados de usuário para essa conexão
sharedUserList	string[]
target	string
value	string	Detalhes do valor da conexão do workspace.
valueFormat	ValueFormat	formato para o valor de conexão do workspace

ValueFormat

formato para o valor de conexão do workspace

Nome	Tipo	Description
JSON	string

WorkspaceConnectionAccessKey

Nome	Tipo	Description
accessKeyId	string
secretAccessKey	string

WorkspaceConnectionAccountKey

Nome	Tipo	Description
key	string

WorkspaceConnectionApiKey

Objeto de chave de API para credencial de conexão de workspace.

Nome	Tipo	Description
key	string

WorkspaceConnectionManagedIdentity

Nome	Tipo	Description
clientId	string
resourceId	string

WorkspaceConnectionOAuth2

ClientId e ClientSecret são necessários. Outras propriedades são opcionais dependendo da implementação de cada provedor OAuth2.

Nome	Tipo	Description
authUrl	string	Exigido pela categoria de conexão Concur
clientId	string	ID do cliente no formato UUID
clientSecret	string
developerToken	string	Exigido pela categoria de conexão GoogleAdWords
password	string
refreshToken	string	Exigido por GoogleBigQuery, GoogleAdWords, Hubspot, QuickBooks, Square, Xero, Zoho, onde o usuário precisa colocar RefreshToken offline
tenantId	string	Exigido pelas categorias de conexão QuickBooks e Xero
username	string	Concur, o tipo de concessão AccessToken do servidor de autenticação do ServiceNow é 'Password', que requer UsernamePassword

WorkspaceConnectionPersonalAccessToken

Nome	Tipo	Description
pat	string

WorkspaceConnectionPropertiesV2BasicResource

Nome	Tipo	Description
id	string	ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	O nome do recurso
properties	WorkspaceConnectionPropertiesV2: AADAuthTypeWorkspaceConnectionProperties AccessKeyAuthTypeWorkspaceConnectionProperties AccountKeyAuthTypeWorkspaceConnectionProperties ApiKeyAuthWorkspaceConnectionProperties CustomKeysWorkspaceConnectionProperties ManagedIdentityAuthTypeWorkspaceConnectionProperties NoneAuthTypeWorkspaceConnectionProperties OAuth2AuthTypeWorkspaceConnectionProperties PATAuthTypeWorkspaceConnectionProperties SASAuthTypeWorkspaceConnectionProperties ServicePrincipalAuthTypeWorkspaceConnectionProperties UsernamePasswordAuthTypeWorkspaceConnectionProperties
systemData	systemData	Os metadados do Azure Resource Manager que contêm as informações createdBy e modifiedBy.
type	string	Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

WorkspaceConnectionServicePrincipal

Nome	Tipo	Description
clientId	string
clientSecret	string
tenantId	string

WorkspaceConnectionSharedAccessSignature

Nome	Tipo	Description
sas	string

WorkspaceConnectionUsernamePassword

Nome	Tipo	Description
password	string
securityToken	string	Opcional, exigido por conexões como SalesForce para segurança extra, além de UsernamePassword
username	string