Workspace Connections - Create
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}?api-version=2024-04-01
Parâmetros do URI
Name | Em | Necessário | Tipo | Description |
---|---|---|---|---|
connection
|
path | True |
string |
Nome amigável da ligação da área de trabalho Padrão Regex: |
resource
|
path | True |
string |
O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas. |
subscription
|
path | True |
string |
O ID da subscrição de destino. |
workspace
|
path | True |
string |
Nome da área de trabalho do Azure Machine Learning. Padrão Regex: |
api-version
|
query | True |
string |
A versão da API a utilizar para esta operação. |
Corpo do Pedido
Respostas
Name | Tipo | Description |
---|---|---|
200 OK |
O pedido foi bem-sucedido; o pedido foi bem formado e recebido corretamente. |
|
Other Status Codes |
Erro |
Segurança
azure_auth
Fluxo OAuth2 do Azure Active Directory.
Tipo:
oauth2
Fluxo:
implicit
URL de Autorização:
https://login.microsoftonline.com/common/oauth2/authorize
Âmbitos
Name | Description |
---|---|
user_impersonation | representar a sua conta de utilizador |
Exemplos
CreateWorkspaceConnection
Pedido de amostra
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"
}
}
Resposta da amostra
{
"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
Name | Description |
---|---|
AADAuth |
Este tipo de ligação abrange a autenticação do AAD para qualquer serviço do Azure aplicável |
Access |
|
Account |
Este tipo de ligação abrange a ligação da chave de conta para o armazenamento do Azure |
Api |
Este tipo de ligação abrange as categorias genéricas de ligação de autenticação ApiKey, por exemplo: AzureOpenAI: Category:= AzureOpenAI AuthType:= ApiKey (como tipo discriminatório) Credenciais:= {ApiKey} como Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= {ApiBase} CognitiveService: Category:= CognitiveService AuthType:= ApiKey (como discriminatório do tipo) Credenciais:= {SubscriptionKey} como Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= ServiceRegion={serviceRegion} CognitiveSearch: Category:= CognitiveSearch AuthType:= ApiKey (como discriminatório do tipo) Credenciais:= {Key} como Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= {Endpoint} Utilizar o saco de propriedades metadados para campos ApiType, ApiVersion, Kind e outros metadados |
Connection |
Tipo de autenticação do destino de ligação |
Connection |
Categoria da ligação |
Connection |
Agrupar com base na categoria de ligação |
created |
O tipo de identidade que criou o recurso. |
Custom |
Objeto de credencial chaves personalizadas |
Custom |
Categoria:= CustomKeys AuthType:= CustomKeys (como discriminador de tipos) Credenciais:= {CustomKeys} como Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.CustomKeys Target:= {any value} Use Metadata property bag for ApiVersion and other metadata fields |
Error |
Informações adicionais sobre o erro de gestão de recursos. |
Error |
O detalhe do erro. |
Error |
Resposta a erros |
Managed |
|
None |
|
OAuth2Auth |
|
PATAuth |
|
SASAuth |
|
Service |
|
system |
Metadados relativos à criação e última modificação do recurso. |
Username |
|
Value |
formato para o valor de ligação da área de trabalho |
Workspace |
|
Workspace |
|
Workspace |
Objeto de chave de API para credenciais de ligação da área de trabalho. |
Workspace |
|
Workspace |
ClientId e ClientSecret são necessários. Outras propriedades são opcionais consoante a implementação de cada fornecedor OAuth2. |
Workspace |
|
Workspace |
|
Workspace |
|
Workspace |
|
Workspace |
AADAuthTypeWorkspaceConnectionProperties
Este tipo de ligação abrange a autenticação do AAD para qualquer serviço do Azure aplicável
Name | Tipo | Description |
---|---|---|
authType |
string:
AAD |
Tipo de autenticação do destino de ligação |
category |
Categoria da ligação |
|
createdByWorkspaceArmId |
string |
|
expiryTime |
string |
|
group |
Agrupar com base na categoria de ligação |
|
isSharedToAll |
boolean |
|
metadata |
object |
Armazenar metadados de utilizador para esta ligação |
sharedUserList |
string[] |
|
target |
string |
|
value |
string |
Detalhes de valor da ligação da área de trabalho. |
valueFormat |
formato para o valor de ligação da área de trabalho |
AccessKeyAuthTypeWorkspaceConnectionProperties
Name | Tipo | Description |
---|---|---|
authType |
string:
Access |
Tipo de autenticação do destino de ligação |
category |
Categoria da ligação |
|
createdByWorkspaceArmId |
string |
|
credentials | ||
expiryTime |
string |
|
group |
Agrupar com base na categoria de ligação |
|
isSharedToAll |
boolean |
|
metadata |
object |
Armazenar metadados de utilizador para esta ligação |
sharedUserList |
string[] |
|
target |
string |
|
value |
string |
Detalhes de valor da ligação da área de trabalho. |
valueFormat |
formato para o valor de ligação da área de trabalho |
AccountKeyAuthTypeWorkspaceConnectionProperties
Este tipo de ligação abrange a ligação da chave de conta para o armazenamento do Azure
Name | Tipo | Description |
---|---|---|
authType |
string:
Account |
Tipo de autenticação do destino de ligação |
category |
Categoria da ligação |
|
createdByWorkspaceArmId |
string |
|
credentials | ||
expiryTime |
string |
|
group |
Agrupar com base na categoria de ligação |
|
isSharedToAll |
boolean |
|
metadata |
object |
Armazenar metadados de utilizador para esta ligação |
sharedUserList |
string[] |
|
target |
string |
|
value |
string |
Detalhes de valor da ligação da área de trabalho. |
valueFormat |
formato para o valor de ligação da área de trabalho |
ApiKeyAuthWorkspaceConnectionProperties
Este tipo de ligação abrange as categorias genéricas de ligação de autenticação ApiKey, por exemplo: AzureOpenAI: Category:= AzureOpenAI AuthType:= ApiKey (como tipo discriminatório) Credenciais:= {ApiKey} como Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= {ApiBase}
CognitiveService: Category:= CognitiveService AuthType:= ApiKey (como discriminatório do tipo) Credenciais:= {SubscriptionKey} como Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= ServiceRegion={serviceRegion}
CognitiveSearch: Category:= CognitiveSearch AuthType:= ApiKey (como discriminatório do tipo) Credenciais:= {Key} como Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= {Endpoint}
Utilizar o saco de propriedades metadados para campos ApiType, ApiVersion, Kind e outros metadados
Name | Tipo | Description |
---|---|---|
authType |
string:
Api |
Tipo de autenticação do destino de ligação |
category |
Categoria da ligação |
|
createdByWorkspaceArmId |
string |
|
credentials |
Objeto de chave de API para credenciais de ligação da área de trabalho. |
|
expiryTime |
string |
|
group |
Agrupar com base na categoria de ligação |
|
isSharedToAll |
boolean |
|
metadata |
object |
Armazenar metadados de utilizador para esta ligação |
sharedUserList |
string[] |
|
target |
string |
|
value |
string |
Detalhes de valor da ligação da área de trabalho. |
valueFormat |
formato para o valor de ligação da área de trabalho |
ConnectionAuthType
Tipo de autenticação do destino de ligação
Name | 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 ligação
Name | 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 ligação
Name | 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.
Name | Tipo | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
CustomKeys
Objeto de credencial chaves personalizadas
Name | Tipo | Description |
---|---|---|
keys |
object |
CustomKeysWorkspaceConnectionProperties
Categoria:= CustomKeys AuthType:= CustomKeys (como discriminador de tipos) Credenciais:= {CustomKeys} como Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.CustomKeys Target:= {any value} Use Metadata property bag for ApiVersion and other metadata fields
Name | Tipo | Description |
---|---|---|
authType | string: |
Tipo de autenticação do destino de ligação |
category |
Categoria da ligação |
|
createdByWorkspaceArmId |
string |
|
credentials |
Objeto de credencial chaves personalizadas |
|
expiryTime |
string |
|
group |
Agrupar com base na categoria de ligação |
|
isSharedToAll |
boolean |
|
metadata |
object |
Armazenar metadados de utilizador para esta ligação |
sharedUserList |
string[] |
|
target |
string |
|
value |
string |
Detalhes de valor da ligação da área de trabalho. |
valueFormat |
formato para o valor de ligação da área de trabalho |
ErrorAdditionalInfo
Informações adicionais sobre o erro de gestão de recursos.
Name | Tipo | Description |
---|---|---|
info |
object |
As informações adicionais. |
type |
string |
O tipo de informação adicional. |
ErrorDetail
O detalhe do erro.
Name | Tipo | Description |
---|---|---|
additionalInfo |
As informações adicionais do erro. |
|
code |
string |
O código de erro. |
details |
Os detalhes do erro. |
|
message |
string |
A mensagem de erro. |
target |
string |
O destino do erro. |
ErrorResponse
Resposta a erros
Name | Tipo | Description |
---|---|---|
error |
O objeto de erro. |
ManagedIdentityAuthTypeWorkspaceConnectionProperties
Name | Tipo | Description |
---|---|---|
authType |
string:
Managed |
Tipo de autenticação do destino de ligação |
category |
Categoria da ligação |
|
createdByWorkspaceArmId |
string |
|
credentials | ||
expiryTime |
string |
|
group |
Agrupar com base na categoria de ligação |
|
isSharedToAll |
boolean |
|
metadata |
object |
Armazenar metadados de utilizador para esta ligação |
sharedUserList |
string[] |
|
target |
string |
|
value |
string |
Detalhes de valor da ligação da área de trabalho. |
valueFormat |
formato para o valor de ligação da área de trabalho |
NoneAuthTypeWorkspaceConnectionProperties
Name | Tipo | Description |
---|---|---|
authType |
string:
None |
Tipo de autenticação do destino de ligação |
category |
Categoria da ligação |
|
createdByWorkspaceArmId |
string |
|
expiryTime |
string |
|
group |
Agrupar com base na categoria de ligação |
|
isSharedToAll |
boolean |
|
metadata |
object |
Armazenar metadados de utilizador para esta ligação |
sharedUserList |
string[] |
|
target |
string |
|
value |
string |
Detalhes de valor da ligação da área de trabalho. |
valueFormat |
formato para o valor de ligação da área de trabalho |
OAuth2AuthTypeWorkspaceConnectionProperties
Name | Tipo | Description |
---|---|---|
authType |
string:
OAuth2 |
Tipo de autenticação do destino de ligação |
category |
Categoria da ligação |
|
createdByWorkspaceArmId |
string |
|
credentials |
ClientId e ClientSecret são necessários. Outras propriedades são opcionais consoante a implementação de cada fornecedor OAuth2. |
|
expiryTime |
string |
|
group |
Agrupar com base na categoria de ligação |
|
isSharedToAll |
boolean |
|
metadata |
object |
Armazenar metadados de utilizador para esta ligação |
sharedUserList |
string[] |
|
target |
string |
|
value |
string |
Detalhes de valor da ligação da área de trabalho. |
valueFormat |
formato para o valor de ligação da área de trabalho |
PATAuthTypeWorkspaceConnectionProperties
Name | Tipo | Description |
---|---|---|
authType |
string:
PAT |
Tipo de autenticação do destino de ligação |
category |
Categoria da ligação |
|
createdByWorkspaceArmId |
string |
|
credentials | ||
expiryTime |
string |
|
group |
Agrupar com base na categoria de ligação |
|
isSharedToAll |
boolean |
|
metadata |
object |
Armazenar metadados de utilizador para esta ligação |
sharedUserList |
string[] |
|
target |
string |
|
value |
string |
Detalhes de valor da ligação da área de trabalho. |
valueFormat |
formato para o valor de ligação da área de trabalho |
SASAuthTypeWorkspaceConnectionProperties
Name | Tipo | Description |
---|---|---|
authType |
string:
SAS |
Tipo de autenticação do destino de ligação |
category |
Categoria da ligação |
|
createdByWorkspaceArmId |
string |
|
credentials | ||
expiryTime |
string |
|
group |
Agrupar com base na categoria de ligação |
|
isSharedToAll |
boolean |
|
metadata |
object |
Armazenar metadados de utilizador para esta ligação |
sharedUserList |
string[] |
|
target |
string |
|
value |
string |
Detalhes de valor da ligação da área de trabalho. |
valueFormat |
formato para o valor de ligação da área de trabalho |
ServicePrincipalAuthTypeWorkspaceConnectionProperties
Name | Tipo | Description |
---|---|---|
authType |
string:
Service |
Tipo de autenticação do destino de ligação |
category |
Categoria da ligação |
|
createdByWorkspaceArmId |
string |
|
credentials | ||
expiryTime |
string |
|
group |
Agrupar com base na categoria de ligação |
|
isSharedToAll |
boolean |
|
metadata |
object |
Armazenar metadados de utilizador para esta ligação |
sharedUserList |
string[] |
|
target |
string |
|
value |
string |
Detalhes de valor da ligação da área de trabalho. |
valueFormat |
formato para o valor de ligação da área de trabalho |
systemData
Metadados relativos à criação e última modificação do recurso.
Name | Tipo | Description |
---|---|---|
createdAt |
string |
O carimbo de data/hora da criação de recursos (UTC). |
createdBy |
string |
A identidade que criou o recurso. |
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 |
O tipo de identidade que modificou o recurso pela última vez. |
UsernamePasswordAuthTypeWorkspaceConnectionProperties
Name | Tipo | Description |
---|---|---|
authType |
string:
Username |
Tipo de autenticação do destino de ligação |
category |
Categoria da ligação |
|
createdByWorkspaceArmId |
string |
|
credentials | ||
expiryTime |
string |
|
group |
Agrupar com base na categoria de ligação |
|
isSharedToAll |
boolean |
|
metadata |
object |
Armazenar metadados de utilizador para esta ligação |
sharedUserList |
string[] |
|
target |
string |
|
value |
string |
Detalhes de valor da ligação da área de trabalho. |
valueFormat |
formato para o valor de ligação da área de trabalho |
ValueFormat
formato para o valor de ligação da área de trabalho
Name | Tipo | Description |
---|---|---|
JSON |
string |
WorkspaceConnectionAccessKey
Name | Tipo | Description |
---|---|---|
accessKeyId |
string |
|
secretAccessKey |
string |
WorkspaceConnectionAccountKey
Name | Tipo | Description |
---|---|---|
key |
string |
WorkspaceConnectionApiKey
Objeto de chave de API para credenciais de ligação da área de trabalho.
Name | Tipo | Description |
---|---|---|
key |
string |
WorkspaceConnectionManagedIdentity
Name | Tipo | Description |
---|---|---|
clientId |
string |
|
resourceId |
string |
WorkspaceConnectionOAuth2
ClientId e ClientSecret são necessários. Outras propriedades são opcionais consoante a implementação de cada fornecedor OAuth2.
Name | Tipo | Description |
---|---|---|
authUrl |
string |
Obrigatório pela categoria de ligação Concur |
clientId |
string |
ID do cliente no formato de UUID |
clientSecret |
string |
|
developerToken |
string |
Obrigatório pela categoria de ligação GoogleAdWords |
password |
string |
|
refreshToken |
string |
Obrigatório pelo GoogleBigQuery, GoogleAdWords, Hubspot, QuickBooks, Square, Xero, Zoho, onde o utilizador precisa de colocar RefreshToken offline |
tenantId |
string |
Obrigatório pelas categorias de ligação QuickBooks e Xero |
username |
string |
Em simultâneo, o tipo de concessão AccessToken do servidor de autenticação Do ServiceNow é "Palavra-passe" que requer UsernamePassword |
WorkspaceConnectionPersonalAccessToken
Name | Tipo | Description |
---|---|---|
pat |
string |
WorkspaceConnectionPropertiesV2BasicResource
WorkspaceConnectionServicePrincipal
Name | Tipo | Description |
---|---|---|
clientId |
string |
|
clientSecret |
string |
|
tenantId |
string |
WorkspaceConnectionSharedAccessSignature
Name | Tipo | Description |
---|---|---|
sas |
string |
WorkspaceConnectionUsernamePassword
Name | Tipo | Description |
---|---|---|
password |
string |
|
securityToken |
string |
Opcional, obrigatório por ligações como o SalesForce para obter segurança adicional, além de UsernamePassword |
username |
string |