Compartilhar via


Workspaces/conexões do Microsoft.MachineLearningServices 2024-07-01-preview

Definição de recurso do Bicep

O tipo de recurso workspaces/conexões pode ser implantado com operações direcionadas:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.MachineLearningServices/workspaces/connections, adicione o seguinte Bicep ao seu modelo.

resource symbolicname 'Microsoft.MachineLearningServices/workspaces/connections@2024-07-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    category: 'string'
    error: 'string'
    expiryTime: 'string'
    isSharedToAll: bool
    metadata: {
      {customized property}: 'string'
    }
    peRequirement: 'string'
    peStatus: 'string'
    sharedUserList: [
      'string'
    ]
    target: 'string'
    useWorkspaceManagedIdentity: bool
    authType: 'string'
    // For remaining properties, see WorkspaceConnectionPropertiesV2 objects
  }
}

Objetos WorkspaceConnectionPropertiesV2

Defina a propriedade authType para especificar o tipo de objeto.

Para do AAD, use:

{
  authType: 'AAD'
}

Para AccessKey, use:

{
  authType: 'AccessKey'
  credentials: {
    accessKeyId: 'string'
    secretAccessKey: 'string'
  }
}

Para AccountKey, use:

{
  authType: 'AccountKey'
  credentials: {
    key: 'string'
  }
}

Para ApiKey, use:

{
  authType: 'ApiKey'
  credentials: {
    key: 'string'
  }
}

Para CustomKeys, use:

{
  authType: 'CustomKeys'
  credentials: {
    keys: {
      {customized property}: 'string'
    }
  }
}

Para ManagedIdentity, use:

{
  authType: 'ManagedIdentity'
  credentials: {
    clientId: 'string'
    resourceId: 'string'
  }
}

Para Nenhum, use:

{
  authType: 'None'
}

Para OAuth2, use:

{
  authType: 'OAuth2'
  credentials: {
    authUrl: 'string'
    clientId: 'string'
    clientSecret: 'string'
    developerToken: 'string'
    password: 'string'
    refreshToken: 'string'
    tenantId: 'string'
    username: 'string'
  }
}

Para PAT, use:

{
  authType: 'PAT'
  credentials: {
    pat: 'string'
  }
}

Para SAS, use:

{
  authType: 'SAS'
  credentials: {
    sas: 'string'
  }
}

Para ServicePrincipal, use:

{
  authType: 'ServicePrincipal'
  credentials: {
    clientId: 'string'
    clientSecret: 'string'
    tenantId: 'string'
  }
}

Para usernamePassword, use:

{
  authType: 'UsernamePassword'
  credentials: {
    password: 'string'
    securityToken: 'string'
    username: 'string'
  }
}

Valores de propriedade

AADAuthTypeWorkspaceConnectionProperties

Nome Descrição Valor
authType Tipo de autenticação do destino de conexão 'AAD' (obrigatório)

AccessKeyAuthTypeWorkspaceConnectionProperties

Nome Descrição Valor
authType Tipo de autenticação do destino de conexão 'AccessKey' (obrigatório)
credenciais WorkspaceConnectionAccessKey

AccountKeyAuthTypeWorkspaceConnectionProperties

Nome Descrição Valor
authType Tipo de autenticação do destino de conexão 'AccountKey' (obrigatório)
credenciais Objeto de chave de conta para credencial de conexão de workspace. WorkspaceConnectionAccountKey

ApiKeyAuthWorkspaceConnectionProperties

Nome Descrição Valor
authType Tipo de autenticação do destino de conexão 'ApiKey' (obrigatório)
credenciais Objeto de chave de API para credencial de conexão de workspace. WorkspaceConnectionApiKey

CustomKeys

Nome Descrição Valor
Chaves Dicionário de <string> CustomKeys

CustomKeys

Nome Descrição Valor

CustomKeysWorkspaceConnectionProperties

Nome Descrição Valor
authType Tipo de autenticação do destino de conexão 'CustomKeys' (obrigatório)
credenciais Objeto de credencial de chaves personalizadas CustomKeys

ManagedIdentityAuthTypeWorkspaceConnectionProperties

Nome Descrição Valor
authType Tipo de autenticação do destino de conexão 'ManagedIdentity' (obrigatório)
credenciais WorkspaceConnectionManagedIdentity

Microsoft.MachineLearningServices/workspaces/connections

Nome Descrição Valor
nome O nome do recurso corda

Restrições:
Padrão = ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$ (obrigatório)
pai No Bicep, você pode especificar o recurso pai para um recurso filho. Você só precisa adicionar essa propriedade quando o recurso filho é declarado fora do recurso pai.

Para obter mais informações, consulte recurso filho fora do recurso pai.
Nome simbólico para o recurso do tipo: workspaces
Propriedades WorkspaceConnectionPropertiesV2 (obrigatório)

NoneAuthTypeWorkspaceConnectionProperties

Nome Descrição Valor
authType Tipo de autenticação do destino de conexão 'None' (obrigatório)

OAuth2AuthTypeWorkspaceConnectionProperties

Nome Descrição Valor
authType Tipo de autenticação do destino de conexão 'OAuth2' (obrigatório)
credenciais ClientId e ClientSecret são necessários. Outras propriedades são opcionais
dependendo da implementação de cada provedor OAuth2.
WorkspaceConnectionOAuth2

PATAuthTypeWorkspaceConnectionProperties

Nome Descrição Valor
authType Tipo de autenticação do destino de conexão 'PAT' (obrigatório)
credenciais WorkspaceConnectionPersonalAccessToken

SASAuthTypeWorkspaceConnectionProperties

Nome Descrição Valor
authType Tipo de autenticação do destino de conexão 'SAS' (obrigatório)
credenciais WorkspaceConnectionSharedAccessSignature

ServicePrincipalAuthTypeWorkspaceConnectionProperties

Nome Descrição Valor
authType Tipo de autenticação do destino de conexão 'ServicePrincipal' (obrigatório)
credenciais WorkspaceConnectionServicePrincipal

UsernamePasswordAuthTypeWorkspaceConnectionProperties

Nome Descrição Valor
authType Tipo de autenticação do destino de conexão 'UsernamePassword' (obrigatório)
credenciais WorkspaceConnectionUsernamePassword

WorkspaceConnectionAccessKey

Nome Descrição Valor
accessKeyId corda
secretAccessKey corda

WorkspaceConnectionAccountKey

Nome Descrição Valor
chave corda

WorkspaceConnectionApiKey

Nome Descrição Valor
chave corda

WorkspaceConnectionManagedIdentity

Nome Descrição Valor
clientId corda
resourceId corda

WorkspaceConnectionOAuth2

Nome Descrição Valor
authUrl Exigido pela categoria de conexão Concur corda
clientId ID do cliente no formato UUID corda

Restrições:
Comprimento mínimo = 36
Comprimento máximo = 36
Padrão = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
clientSecret corda

Restrições:
Valor confidencial. Passe como um parâmetro seguro.
developerToken Exigido pela categoria de conexão GoogleAdWords corda

Restrições:
Valor confidencial. Passe como um parâmetro seguro.
senha corda

Restrições:
Valor confidencial. Passe como um parâmetro seguro.
refreshToken Exigido por GoogleBigQuery, GoogleAdWords, Hubspot, QuickBooks, Square, Xero, Zoho
onde o usuário precisa colocar RefreshToken offline
corda

Restrições:
Valor confidencial. Passe como um parâmetro seguro.
tenantId Exigido pelas categorias de conexão QuickBooks e Xero corda
nome de usuário Concur, o tipo de concessão accessToken do servidor de autenticação do ServiceNow é 'Password'
que requer UsernamePassword
corda

WorkspaceConnectionPersonalAccessToken

Nome Descrição Valor
tapinha corda

WorkspaceConnectionPropertiesV2

Nome Descrição Valor
authType Defina como 'AAD' para o tipo AADAuthTypeWorkspaceConnectionProperties. Defina como 'AccessKey' para o tipo AccessKeyAuthTypeWorkspaceConnectionProperties. Defina como 'AccountKey' para o tipo AccountKeyAuthTypeWorkspaceConnectionProperties. Defina como 'ApiKey' para o tipo ApiKeyAuthWorkspaceConnectionProperties. Defina como 'CustomKeys' para o tipo CustomKeysWorkspaceConnectionProperties. Defina como 'ManagedIdentity' para o tipo ManagedIdentityAuthTypeWorkspaceConnectionProperties. Defina como 'None' para o tipo NoneAuthTypeWorkspaceConnectionProperties. Defina como 'OAuth2' para o tipo OAuth2AuthTypeWorkspaceConnectionProperties. Defina como 'PAT' para o tipo PATAuthTypeWorkspaceConnectionProperties . Defina como 'SAS' para o tipo SASAuthTypeWorkspaceConnectionProperties. Defina como 'ServicePrincipal' para o tipo ServicePrincipalAuthTypeWorkspaceConnectionProperties. Defina como 'UsernamePassword' para o tipo UsernamePasswordAuthTypeWorkspaceConnectionProperties. 'AAD'
'AccessKey'
'AccountKey'
'ApiKey'
'CustomKeys'
'ManagedIdentity'
'None'
'OAuth2'
'PAT'
'SAS'
'ServicePrincipal'
'UsernamePassword' (obrigatório)
categoria Categoria da conexão 'ADLSGen2'
'AIServices'
'AmazonMws'
'AmazonRdsForOracle'
'AmazonRdsForSqlServer'
'AmazonRedshift'
'AmazonS3Compatible'
'ApiKey'
'AzureBlob'
'AzureDatabricksDeltaLake'
'AzureDataExplorer'
'AzureMariaDb'
'AzureMySqlDb'
'AzureOneLake'
'AzureOpenAI'
'AzurePostgresDb'
'AzureSqlDb'
'AzureSqlMi'
'AzureSynapseAnalytics'
'AzureTableStorage'
'BingLLMSearch'
'Cassandra'
'CognitiveSearch'
'CognitiveService'
'Concur'
'ContainerRegistry'
'CosmosDb'
'CosmosDbMongoDbApi'
'Couchbase'
'CustomKeys'
'Db2'
'Drill'
'Dynamics'
'DynamicsAx'
'DynamicsCrm'
'Eloqua'
'FileServer'
'FtpServer'
'GenericContainerRegistry'
'GenericHttp'
'GenericRest'
'Git'
'GoogleAdWords'
'GoogleBigQuery'
'GoogleCloudStorage'
'Greenplum'
'Hbase'
'Hdfs'
'Hive'
'Hubspot'
'Impala'
'Informix'
'Jira'
'Magento'
'MariaDb'
'Marketo'
'MicrosoftAccess'
'MongoDbAtlas'
'MongoDbV2'
'MySql'
'Netezza'
'ODataRest'
'Odbc'
'Office365'
'OpenAI'
'Oracle'
'OracleCloudStorage'
'OracleServiceCloud'
'PayPal'
'Phoenix'
'PostgreSql'
'Presto'
'PythonFeed'
'QuickBooks'
'Redis'
'Responsys'
'S3'
'Salesforce'
'SalesforceMarketingCloud'
'SalesforceServiceCloud'
'SapBw'
'SapCloudForCustomer'
'SapEcc'
'SapHana'
'SapOpenHub'
'SapTable'
'Serp'
'Sem servidor'
'ServiceNow'
'Sftp'
'SharePointOnlineList'
'Shopify'
'Floco de Neve'
'Spark'
'SqlServer'
'Quadrado'
'Sybase'
'Teradata'
'Vertica'
'WebTable'
'Xero'
'Zoho'
erro corda
expiryTime corda
isSharedToAll Bool
metadados Armazenar metadados de usuário para essa conexão WorkspaceConnectionPropertiesV2Metadata
peRequirement 'NotApplicable'
'NotRequired'
'Obrigatório'
peStatus 'Ativo'
'Inativo'
'NotApplicable'
sharedUserList string[]
alvo corda
useWorkspaceManagedIdentity Bool

WorkspaceConnectionPropertiesV2Metadata

Nome Descrição Valor

WorkspaceConnectionServicePrincipal

Nome Descrição Valor
clientId corda
clientSecret corda

Restrições:
Valor confidencial. Passe como um parâmetro seguro.
tenantId corda

WorkspaceConnectionSharedAccessSignature

Nome Descrição Valor
Sas corda

WorkspaceConnectionUsernamePassword

Nome Descrição Valor
senha corda
securityToken Opcional, exigido por conexões como SalesForce para segurança extra, além de UsernamePassword corda

Restrições:
Valor confidencial. Passe como um parâmetro seguro.
nome de usuário corda

Exemplos de início rápido

Os exemplos de início rápido a seguir implantam esse tipo de recurso.

Arquivo Bicep Descrição
configuração básica do Azure AI Studio Esse conjunto de modelos demonstra como configurar o Azure AI Studio com a configuração básica, ou seja, com acesso à Internet público habilitado, chaves gerenciadas pela Microsoft para criptografia e configuração de identidade gerenciada pela Microsoft para o recurso de IA.
configuração básica do Azure AI Studio Esse conjunto de modelos demonstra como configurar o Azure AI Studio com a configuração básica, ou seja, com acesso à Internet público habilitado, chaves gerenciadas pela Microsoft para criptografia e configuração de identidade gerenciada pela Microsoft para o recurso de IA.
configuração básica do Azure AI Studio Esse conjunto de modelos demonstra como configurar o Azure AI Studio com a configuração básica, ou seja, com acesso à Internet público habilitado, chaves gerenciadas pela Microsoft para criptografia e configuração de identidade gerenciada pela Microsoft para o recurso de IA.
restrito de rede do Azure AI Studio Esse conjunto de modelos demonstra como configurar o Azure AI Studio com o link privado e a saída desabilitados, usando chaves gerenciadas pela Microsoft para criptografia e configuração de identidade gerenciada pela Microsoft para o recurso de IA.
restrito de rede do Azure AI Studio Esse conjunto de modelos demonstra como configurar o Azure AI Studio com o link privado e a saída desabilitados, usando chaves gerenciadas pela Microsoft para criptografia e configuração de identidade gerenciada pela Microsoft para o recurso de IA.
Azure AI Studio com o Microsoft Entra ID Authentication Esse conjunto de modelos demonstra como configurar o Azure AI Studio com a autenticação de ID do Microsoft Entra para recursos dependentes, como os Serviços de IA do Azure e o Armazenamento do Azure.
implantar o Azure AI Studio seguro com uma rede virtual gerenciada Esse modelo cria um ambiente seguro do Azure AI Studio com restrições robustas de segurança de identidade e de rede.

Definição de recurso de modelo do ARM

O tipo de recurso workspaces/conexões pode ser implantado com operações direcionadas:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.MachineLearningServices/workspaces/connections, adicione o JSON a seguir ao modelo.

{
  "type": "Microsoft.MachineLearningServices/workspaces/connections",
  "apiVersion": "2024-07-01-preview",
  "name": "string",
  "properties": {
    "category": "string",
    "error": "string",
    "expiryTime": "string",
    "isSharedToAll": "bool",
    "metadata": {
      "{customized property}": "string"
    },
    "peRequirement": "string",
    "peStatus": "string",
    "sharedUserList": [ "string" ],
    "target": "string",
    "useWorkspaceManagedIdentity": "bool",
    "authType": "string"
    // For remaining properties, see WorkspaceConnectionPropertiesV2 objects
  }
}

Objetos WorkspaceConnectionPropertiesV2

Defina a propriedade authType para especificar o tipo de objeto.

Para do AAD, use:

{
  "authType": "AAD"
}

Para AccessKey, use:

{
  "authType": "AccessKey",
  "credentials": {
    "accessKeyId": "string",
    "secretAccessKey": "string"
  }
}

Para AccountKey, use:

{
  "authType": "AccountKey",
  "credentials": {
    "key": "string"
  }
}

Para ApiKey, use:

{
  "authType": "ApiKey",
  "credentials": {
    "key": "string"
  }
}

Para CustomKeys, use:

{
  "authType": "CustomKeys",
  "credentials": {
    "keys": {
      "{customized property}": "string"
    }
  }
}

Para ManagedIdentity, use:

{
  "authType": "ManagedIdentity",
  "credentials": {
    "clientId": "string",
    "resourceId": "string"
  }
}

Para Nenhum, use:

{
  "authType": "None"
}

Para OAuth2, use:

{
  "authType": "OAuth2",
  "credentials": {
    "authUrl": "string",
    "clientId": "string",
    "clientSecret": "string",
    "developerToken": "string",
    "password": "string",
    "refreshToken": "string",
    "tenantId": "string",
    "username": "string"
  }
}

Para PAT, use:

{
  "authType": "PAT",
  "credentials": {
    "pat": "string"
  }
}

Para SAS, use:

{
  "authType": "SAS",
  "credentials": {
    "sas": "string"
  }
}

Para ServicePrincipal, use:

{
  "authType": "ServicePrincipal",
  "credentials": {
    "clientId": "string",
    "clientSecret": "string",
    "tenantId": "string"
  }
}

Para usernamePassword, use:

{
  "authType": "UsernamePassword",
  "credentials": {
    "password": "string",
    "securityToken": "string",
    "username": "string"
  }
}

Valores de propriedade

AADAuthTypeWorkspaceConnectionProperties

Nome Descrição Valor
authType Tipo de autenticação do destino de conexão 'AAD' (obrigatório)

AccessKeyAuthTypeWorkspaceConnectionProperties

Nome Descrição Valor
authType Tipo de autenticação do destino de conexão 'AccessKey' (obrigatório)
credenciais WorkspaceConnectionAccessKey

AccountKeyAuthTypeWorkspaceConnectionProperties

Nome Descrição Valor
authType Tipo de autenticação do destino de conexão 'AccountKey' (obrigatório)
credenciais Objeto de chave de conta para credencial de conexão de workspace. WorkspaceConnectionAccountKey

ApiKeyAuthWorkspaceConnectionProperties

Nome Descrição Valor
authType Tipo de autenticação do destino de conexão 'ApiKey' (obrigatório)
credenciais Objeto de chave de API para credencial de conexão de workspace. WorkspaceConnectionApiKey

CustomKeys

Nome Descrição Valor
Chaves Dicionário de <string> CustomKeys

CustomKeys

Nome Descrição Valor

CustomKeysWorkspaceConnectionProperties

Nome Descrição Valor
authType Tipo de autenticação do destino de conexão 'CustomKeys' (obrigatório)
credenciais Objeto de credencial de chaves personalizadas CustomKeys

ManagedIdentityAuthTypeWorkspaceConnectionProperties

Nome Descrição Valor
authType Tipo de autenticação do destino de conexão 'ManagedIdentity' (obrigatório)
credenciais WorkspaceConnectionManagedIdentity

Microsoft.MachineLearningServices/workspaces/connections

Nome Descrição Valor
apiVersion A versão da API '2024-07-01-preview'
nome O nome do recurso corda

Restrições:
Padrão = ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$ (obrigatório)
Propriedades WorkspaceConnectionPropertiesV2 (obrigatório)
tipo O tipo de recurso 'Microsoft.MachineLearningServices/workspaces/connections'

NoneAuthTypeWorkspaceConnectionProperties

Nome Descrição Valor
authType Tipo de autenticação do destino de conexão 'None' (obrigatório)

OAuth2AuthTypeWorkspaceConnectionProperties

Nome Descrição Valor
authType Tipo de autenticação do destino de conexão 'OAuth2' (obrigatório)
credenciais ClientId e ClientSecret são necessários. Outras propriedades são opcionais
dependendo da implementação de cada provedor OAuth2.
WorkspaceConnectionOAuth2

PATAuthTypeWorkspaceConnectionProperties

Nome Descrição Valor
authType Tipo de autenticação do destino de conexão 'PAT' (obrigatório)
credenciais WorkspaceConnectionPersonalAccessToken

SASAuthTypeWorkspaceConnectionProperties

Nome Descrição Valor
authType Tipo de autenticação do destino de conexão 'SAS' (obrigatório)
credenciais WorkspaceConnectionSharedAccessSignature

ServicePrincipalAuthTypeWorkspaceConnectionProperties

Nome Descrição Valor
authType Tipo de autenticação do destino de conexão 'ServicePrincipal' (obrigatório)
credenciais WorkspaceConnectionServicePrincipal

UsernamePasswordAuthTypeWorkspaceConnectionProperties

Nome Descrição Valor
authType Tipo de autenticação do destino de conexão 'UsernamePassword' (obrigatório)
credenciais WorkspaceConnectionUsernamePassword

WorkspaceConnectionAccessKey

Nome Descrição Valor
accessKeyId corda
secretAccessKey corda

WorkspaceConnectionAccountKey

Nome Descrição Valor
chave corda

WorkspaceConnectionApiKey

Nome Descrição Valor
chave corda

WorkspaceConnectionManagedIdentity

Nome Descrição Valor
clientId corda
resourceId corda

WorkspaceConnectionOAuth2

Nome Descrição Valor
authUrl Exigido pela categoria de conexão Concur corda
clientId ID do cliente no formato UUID corda

Restrições:
Comprimento mínimo = 36
Comprimento máximo = 36
Padrão = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
clientSecret corda

Restrições:
Valor confidencial. Passe como um parâmetro seguro.
developerToken Exigido pela categoria de conexão GoogleAdWords corda

Restrições:
Valor confidencial. Passe como um parâmetro seguro.
senha corda

Restrições:
Valor confidencial. Passe como um parâmetro seguro.
refreshToken Exigido por GoogleBigQuery, GoogleAdWords, Hubspot, QuickBooks, Square, Xero, Zoho
onde o usuário precisa colocar RefreshToken offline
corda

Restrições:
Valor confidencial. Passe como um parâmetro seguro.
tenantId Exigido pelas categorias de conexão QuickBooks e Xero corda
nome de usuário Concur, o tipo de concessão accessToken do servidor de autenticação do ServiceNow é 'Password'
que requer UsernamePassword
corda

WorkspaceConnectionPersonalAccessToken

Nome Descrição Valor
tapinha corda

WorkspaceConnectionPropertiesV2

Nome Descrição Valor
authType Defina como 'AAD' para o tipo AADAuthTypeWorkspaceConnectionProperties. Defina como 'AccessKey' para o tipo AccessKeyAuthTypeWorkspaceConnectionProperties. Defina como 'AccountKey' para o tipo AccountKeyAuthTypeWorkspaceConnectionProperties. Defina como 'ApiKey' para o tipo ApiKeyAuthWorkspaceConnectionProperties. Defina como 'CustomKeys' para o tipo CustomKeysWorkspaceConnectionProperties. Defina como 'ManagedIdentity' para o tipo ManagedIdentityAuthTypeWorkspaceConnectionProperties. Defina como 'None' para o tipo NoneAuthTypeWorkspaceConnectionProperties. Defina como 'OAuth2' para o tipo OAuth2AuthTypeWorkspaceConnectionProperties. Defina como 'PAT' para o tipo PATAuthTypeWorkspaceConnectionProperties . Defina como 'SAS' para o tipo SASAuthTypeWorkspaceConnectionProperties. Defina como 'ServicePrincipal' para o tipo ServicePrincipalAuthTypeWorkspaceConnectionProperties. Defina como 'UsernamePassword' para o tipo UsernamePasswordAuthTypeWorkspaceConnectionProperties. 'AAD'
'AccessKey'
'AccountKey'
'ApiKey'
'CustomKeys'
'ManagedIdentity'
'None'
'OAuth2'
'PAT'
'SAS'
'ServicePrincipal'
'UsernamePassword' (obrigatório)
categoria Categoria da conexão 'ADLSGen2'
'AIServices'
'AmazonMws'
'AmazonRdsForOracle'
'AmazonRdsForSqlServer'
'AmazonRedshift'
'AmazonS3Compatible'
'ApiKey'
'AzureBlob'
'AzureDatabricksDeltaLake'
'AzureDataExplorer'
'AzureMariaDb'
'AzureMySqlDb'
'AzureOneLake'
'AzureOpenAI'
'AzurePostgresDb'
'AzureSqlDb'
'AzureSqlMi'
'AzureSynapseAnalytics'
'AzureTableStorage'
'BingLLMSearch'
'Cassandra'
'CognitiveSearch'
'CognitiveService'
'Concur'
'ContainerRegistry'
'CosmosDb'
'CosmosDbMongoDbApi'
'Couchbase'
'CustomKeys'
'Db2'
'Drill'
'Dynamics'
'DynamicsAx'
'DynamicsCrm'
'Eloqua'
'FileServer'
'FtpServer'
'GenericContainerRegistry'
'GenericHttp'
'GenericRest'
'Git'
'GoogleAdWords'
'GoogleBigQuery'
'GoogleCloudStorage'
'Greenplum'
'Hbase'
'Hdfs'
'Hive'
'Hubspot'
'Impala'
'Informix'
'Jira'
'Magento'
'MariaDb'
'Marketo'
'MicrosoftAccess'
'MongoDbAtlas'
'MongoDbV2'
'MySql'
'Netezza'
'ODataRest'
'Odbc'
'Office365'
'OpenAI'
'Oracle'
'OracleCloudStorage'
'OracleServiceCloud'
'PayPal'
'Phoenix'
'PostgreSql'
'Presto'
'PythonFeed'
'QuickBooks'
'Redis'
'Responsys'
'S3'
'Salesforce'
'SalesforceMarketingCloud'
'SalesforceServiceCloud'
'SapBw'
'SapCloudForCustomer'
'SapEcc'
'SapHana'
'SapOpenHub'
'SapTable'
'Serp'
'Sem servidor'
'ServiceNow'
'Sftp'
'SharePointOnlineList'
'Shopify'
'Floco de Neve'
'Spark'
'SqlServer'
'Quadrado'
'Sybase'
'Teradata'
'Vertica'
'WebTable'
'Xero'
'Zoho'
erro corda
expiryTime corda
isSharedToAll Bool
metadados Armazenar metadados de usuário para essa conexão WorkspaceConnectionPropertiesV2Metadata
peRequirement 'NotApplicable'
'NotRequired'
'Obrigatório'
peStatus 'Ativo'
'Inativo'
'NotApplicable'
sharedUserList string[]
alvo corda
useWorkspaceManagedIdentity Bool

WorkspaceConnectionPropertiesV2Metadata

Nome Descrição Valor

WorkspaceConnectionServicePrincipal

Nome Descrição Valor
clientId corda
clientSecret corda

Restrições:
Valor confidencial. Passe como um parâmetro seguro.
tenantId corda

WorkspaceConnectionSharedAccessSignature

Nome Descrição Valor
Sas corda

WorkspaceConnectionUsernamePassword

Nome Descrição Valor
senha corda
securityToken Opcional, exigido por conexões como SalesForce para segurança extra, além de UsernamePassword corda

Restrições:
Valor confidencial. Passe como um parâmetro seguro.
nome de usuário corda

Modelos de início rápido

Os modelos de início rápido a seguir implantam esse tipo de recurso.

Modelo Descrição
configuração básica do Azure AI Studio

Implantar no Azure
Esse conjunto de modelos demonstra como configurar o Azure AI Studio com a configuração básica, ou seja, com acesso à Internet público habilitado, chaves gerenciadas pela Microsoft para criptografia e configuração de identidade gerenciada pela Microsoft para o recurso de IA.
configuração básica do Azure AI Studio

Implantar no Azure
Esse conjunto de modelos demonstra como configurar o Azure AI Studio com a configuração básica, ou seja, com acesso à Internet público habilitado, chaves gerenciadas pela Microsoft para criptografia e configuração de identidade gerenciada pela Microsoft para o recurso de IA.
configuração básica do Azure AI Studio

Implantar no Azure
Esse conjunto de modelos demonstra como configurar o Azure AI Studio com a configuração básica, ou seja, com acesso à Internet público habilitado, chaves gerenciadas pela Microsoft para criptografia e configuração de identidade gerenciada pela Microsoft para o recurso de IA.
restrito de rede do Azure AI Studio

Implantar no Azure
Esse conjunto de modelos demonstra como configurar o Azure AI Studio com o link privado e a saída desabilitados, usando chaves gerenciadas pela Microsoft para criptografia e configuração de identidade gerenciada pela Microsoft para o recurso de IA.
restrito de rede do Azure AI Studio

Implantar no Azure
Esse conjunto de modelos demonstra como configurar o Azure AI Studio com o link privado e a saída desabilitados, usando chaves gerenciadas pela Microsoft para criptografia e configuração de identidade gerenciada pela Microsoft para o recurso de IA.
Azure AI Studio com o Microsoft Entra ID Authentication

Implantar no Azure
Esse conjunto de modelos demonstra como configurar o Azure AI Studio com a autenticação de ID do Microsoft Entra para recursos dependentes, como os Serviços de IA do Azure e o Armazenamento do Azure.
implantar o Azure AI Studio seguro com uma rede virtual gerenciada

Implantar no Azure
Esse modelo cria um ambiente seguro do Azure AI Studio com restrições robustas de segurança de identidade e de rede.

Definição de recurso do Terraform (provedor de AzAPI)

O tipo de recurso workspaces/conexões pode ser implantado com operações direcionadas:

  • grupos de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.MachineLearningServices/workspaces/connections, adicione o Terraform a seguir ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.MachineLearningServices/workspaces/connections@2024-07-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      category = "string"
      error = "string"
      expiryTime = "string"
      isSharedToAll = bool
      metadata = {
        {customized property} = "string"
      }
      peRequirement = "string"
      peStatus = "string"
      sharedUserList = [
        "string"
      ]
      target = "string"
      useWorkspaceManagedIdentity = bool
      authType = "string"
      // For remaining properties, see WorkspaceConnectionPropertiesV2 objects
    }
  })
}

Objetos WorkspaceConnectionPropertiesV2

Defina a propriedade authType para especificar o tipo de objeto.

Para do AAD, use:

{
  authType = "AAD"
}

Para AccessKey, use:

{
  authType = "AccessKey"
  credentials = {
    accessKeyId = "string"
    secretAccessKey = "string"
  }
}

Para AccountKey, use:

{
  authType = "AccountKey"
  credentials = {
    key = "string"
  }
}

Para ApiKey, use:

{
  authType = "ApiKey"
  credentials = {
    key = "string"
  }
}

Para CustomKeys, use:

{
  authType = "CustomKeys"
  credentials = {
    keys = {
      {customized property} = "string"
    }
  }
}

Para ManagedIdentity, use:

{
  authType = "ManagedIdentity"
  credentials = {
    clientId = "string"
    resourceId = "string"
  }
}

Para Nenhum, use:

{
  authType = "None"
}

Para OAuth2, use:

{
  authType = "OAuth2"
  credentials = {
    authUrl = "string"
    clientId = "string"
    clientSecret = "string"
    developerToken = "string"
    password = "string"
    refreshToken = "string"
    tenantId = "string"
    username = "string"
  }
}

Para PAT, use:

{
  authType = "PAT"
  credentials = {
    pat = "string"
  }
}

Para SAS, use:

{
  authType = "SAS"
  credentials = {
    sas = "string"
  }
}

Para ServicePrincipal, use:

{
  authType = "ServicePrincipal"
  credentials = {
    clientId = "string"
    clientSecret = "string"
    tenantId = "string"
  }
}

Para usernamePassword, use:

{
  authType = "UsernamePassword"
  credentials = {
    password = "string"
    securityToken = "string"
    username = "string"
  }
}

Valores de propriedade

AADAuthTypeWorkspaceConnectionProperties

Nome Descrição Valor
authType Tipo de autenticação do destino de conexão 'AAD' (obrigatório)

AccessKeyAuthTypeWorkspaceConnectionProperties

Nome Descrição Valor
authType Tipo de autenticação do destino de conexão 'AccessKey' (obrigatório)
credenciais WorkspaceConnectionAccessKey

AccountKeyAuthTypeWorkspaceConnectionProperties

Nome Descrição Valor
authType Tipo de autenticação do destino de conexão 'AccountKey' (obrigatório)
credenciais Objeto de chave de conta para credencial de conexão de workspace. WorkspaceConnectionAccountKey

ApiKeyAuthWorkspaceConnectionProperties

Nome Descrição Valor
authType Tipo de autenticação do destino de conexão 'ApiKey' (obrigatório)
credenciais Objeto de chave de API para credencial de conexão de workspace. WorkspaceConnectionApiKey

CustomKeys

Nome Descrição Valor
Chaves Dicionário de <string> CustomKeys

CustomKeys

Nome Descrição Valor

CustomKeysWorkspaceConnectionProperties

Nome Descrição Valor
authType Tipo de autenticação do destino de conexão 'CustomKeys' (obrigatório)
credenciais Objeto de credencial de chaves personalizadas CustomKeys

ManagedIdentityAuthTypeWorkspaceConnectionProperties

Nome Descrição Valor
authType Tipo de autenticação do destino de conexão 'ManagedIdentity' (obrigatório)
credenciais WorkspaceConnectionManagedIdentity

Microsoft.MachineLearningServices/workspaces/connections

Nome Descrição Valor
nome O nome do recurso corda

Restrições:
Padrão = ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$ (obrigatório)
parent_id A ID do recurso que é o pai desse recurso. ID do recurso do tipo: workspaces
Propriedades WorkspaceConnectionPropertiesV2 (obrigatório)
tipo O tipo de recurso "Microsoft.MachineLearningServices/workspaces/connections@2024-07-01-preview"

NoneAuthTypeWorkspaceConnectionProperties

Nome Descrição Valor
authType Tipo de autenticação do destino de conexão 'None' (obrigatório)

OAuth2AuthTypeWorkspaceConnectionProperties

Nome Descrição Valor
authType Tipo de autenticação do destino de conexão 'OAuth2' (obrigatório)
credenciais ClientId e ClientSecret são necessários. Outras propriedades são opcionais
dependendo da implementação de cada provedor OAuth2.
WorkspaceConnectionOAuth2

PATAuthTypeWorkspaceConnectionProperties

Nome Descrição Valor
authType Tipo de autenticação do destino de conexão 'PAT' (obrigatório)
credenciais WorkspaceConnectionPersonalAccessToken

SASAuthTypeWorkspaceConnectionProperties

Nome Descrição Valor
authType Tipo de autenticação do destino de conexão 'SAS' (obrigatório)
credenciais WorkspaceConnectionSharedAccessSignature

ServicePrincipalAuthTypeWorkspaceConnectionProperties

Nome Descrição Valor
authType Tipo de autenticação do destino de conexão 'ServicePrincipal' (obrigatório)
credenciais WorkspaceConnectionServicePrincipal

UsernamePasswordAuthTypeWorkspaceConnectionProperties

Nome Descrição Valor
authType Tipo de autenticação do destino de conexão 'UsernamePassword' (obrigatório)
credenciais WorkspaceConnectionUsernamePassword

WorkspaceConnectionAccessKey

Nome Descrição Valor
accessKeyId corda
secretAccessKey corda

WorkspaceConnectionAccountKey

Nome Descrição Valor
chave corda

WorkspaceConnectionApiKey

Nome Descrição Valor
chave corda

WorkspaceConnectionManagedIdentity

Nome Descrição Valor
clientId corda
resourceId corda

WorkspaceConnectionOAuth2

Nome Descrição Valor
authUrl Exigido pela categoria de conexão Concur corda
clientId ID do cliente no formato UUID corda

Restrições:
Comprimento mínimo = 36
Comprimento máximo = 36
Padrão = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
clientSecret corda

Restrições:
Valor confidencial. Passe como um parâmetro seguro.
developerToken Exigido pela categoria de conexão GoogleAdWords corda

Restrições:
Valor confidencial. Passe como um parâmetro seguro.
senha corda

Restrições:
Valor confidencial. Passe como um parâmetro seguro.
refreshToken Exigido por GoogleBigQuery, GoogleAdWords, Hubspot, QuickBooks, Square, Xero, Zoho
onde o usuário precisa colocar RefreshToken offline
corda

Restrições:
Valor confidencial. Passe como um parâmetro seguro.
tenantId Exigido pelas categorias de conexão QuickBooks e Xero corda
nome de usuário Concur, o tipo de concessão accessToken do servidor de autenticação do ServiceNow é 'Password'
que requer UsernamePassword
corda

WorkspaceConnectionPersonalAccessToken

Nome Descrição Valor
tapinha corda

WorkspaceConnectionPropertiesV2

Nome Descrição Valor
authType Defina como 'AAD' para o tipo AADAuthTypeWorkspaceConnectionProperties. Defina como 'AccessKey' para o tipo AccessKeyAuthTypeWorkspaceConnectionProperties. Defina como 'AccountKey' para o tipo AccountKeyAuthTypeWorkspaceConnectionProperties. Defina como 'ApiKey' para o tipo ApiKeyAuthWorkspaceConnectionProperties. Defina como 'CustomKeys' para o tipo CustomKeysWorkspaceConnectionProperties. Defina como 'ManagedIdentity' para o tipo ManagedIdentityAuthTypeWorkspaceConnectionProperties. Defina como 'None' para o tipo NoneAuthTypeWorkspaceConnectionProperties. Defina como 'OAuth2' para o tipo OAuth2AuthTypeWorkspaceConnectionProperties. Defina como 'PAT' para o tipo PATAuthTypeWorkspaceConnectionProperties . Defina como 'SAS' para o tipo SASAuthTypeWorkspaceConnectionProperties. Defina como 'ServicePrincipal' para o tipo ServicePrincipalAuthTypeWorkspaceConnectionProperties. Defina como 'UsernamePassword' para o tipo UsernamePasswordAuthTypeWorkspaceConnectionProperties. 'AAD'
'AccessKey'
'AccountKey'
'ApiKey'
'CustomKeys'
'ManagedIdentity'
'None'
'OAuth2'
'PAT'
'SAS'
'ServicePrincipal'
'UsernamePassword' (obrigatório)
categoria Categoria da conexão 'ADLSGen2'
'AIServices'
'AmazonMws'
'AmazonRdsForOracle'
'AmazonRdsForSqlServer'
'AmazonRedshift'
'AmazonS3Compatible'
'ApiKey'
'AzureBlob'
'AzureDatabricksDeltaLake'
'AzureDataExplorer'
'AzureMariaDb'
'AzureMySqlDb'
'AzureOneLake'
'AzureOpenAI'
'AzurePostgresDb'
'AzureSqlDb'
'AzureSqlMi'
'AzureSynapseAnalytics'
'AzureTableStorage'
'BingLLMSearch'
'Cassandra'
'CognitiveSearch'
'CognitiveService'
'Concur'
'ContainerRegistry'
'CosmosDb'
'CosmosDbMongoDbApi'
'Couchbase'
'CustomKeys'
'Db2'
'Drill'
'Dynamics'
'DynamicsAx'
'DynamicsCrm'
'Eloqua'
'FileServer'
'FtpServer'
'GenericContainerRegistry'
'GenericHttp'
'GenericRest'
'Git'
'GoogleAdWords'
'GoogleBigQuery'
'GoogleCloudStorage'
'Greenplum'
'Hbase'
'Hdfs'
'Hive'
'Hubspot'
'Impala'
'Informix'
'Jira'
'Magento'
'MariaDb'
'Marketo'
'MicrosoftAccess'
'MongoDbAtlas'
'MongoDbV2'
'MySql'
'Netezza'
'ODataRest'
'Odbc'
'Office365'
'OpenAI'
'Oracle'
'OracleCloudStorage'
'OracleServiceCloud'
'PayPal'
'Phoenix'
'PostgreSql'
'Presto'
'PythonFeed'
'QuickBooks'
'Redis'
'Responsys'
'S3'
'Salesforce'
'SalesforceMarketingCloud'
'SalesforceServiceCloud'
'SapBw'
'SapCloudForCustomer'
'SapEcc'
'SapHana'
'SapOpenHub'
'SapTable'
'Serp'
'Sem servidor'
'ServiceNow'
'Sftp'
'SharePointOnlineList'
'Shopify'
'Floco de Neve'
'Spark'
'SqlServer'
'Quadrado'
'Sybase'
'Teradata'
'Vertica'
'WebTable'
'Xero'
'Zoho'
erro corda
expiryTime corda
isSharedToAll Bool
metadados Armazenar metadados de usuário para essa conexão WorkspaceConnectionPropertiesV2Metadata
peRequirement 'NotApplicable'
'NotRequired'
'Obrigatório'
peStatus 'Ativo'
'Inativo'
'NotApplicable'
sharedUserList string[]
alvo corda
useWorkspaceManagedIdentity Bool

WorkspaceConnectionPropertiesV2Metadata

Nome Descrição Valor

WorkspaceConnectionServicePrincipal

Nome Descrição Valor
clientId corda
clientSecret corda

Restrições:
Valor confidencial. Passe como um parâmetro seguro.
tenantId corda

WorkspaceConnectionSharedAccessSignature

Nome Descrição Valor
Sas corda

WorkspaceConnectionUsernamePassword

Nome Descrição Valor
senha corda
securityToken Opcional, exigido por conexões como SalesForce para segurança extra, além de UsernamePassword corda

Restrições:
Valor confidencial. Passe como um parâmetro seguro.
nome de usuário corda