Udostępnij za pośrednictwem


Microsoft.MachineLearningServices workspaces/connections 2023-06-01-preview

Definicja zasobu Bicep

Typ zasobu obszary robocze/połączenia można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.MachineLearningServices/workspaces/connections, dodaj następujący kod Bicep do szablonu.

resource symbolicname 'Microsoft.MachineLearningServices/workspaces/connections@2023-06-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    category: 'string'
    expiryTime: 'string'
    metadata: any()
    target: 'string'
    authType: 'string'
    // For remaining properties, see WorkspaceConnectionPropertiesV2 objects
  }
}

WorkspaceConnectionPropertiesV2 , obiekty

Ustaw właściwość authType, aby określić typ obiektu.

W przypadku AccessKeyużyj:

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

W przypadku apiKeyużyj:

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

W przypadku CustomKeysużyj:

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

W przypadku ManagedIdentityużyj:

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

W przypadku Noneużyj:

  authType: 'None'

W przypadkuPAT użyj:

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

W przypadkusygnatury dostępu współdzielonego użyj:

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

W przypadku ServicePrincipalużyj:

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

W przypadku usernamePasswordużyj:

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

Wartości właściwości

obszary robocze/połączenia

Nazwa Opis Wartość
nazwa Nazwa zasobu

Zobacz, jak ustawić nazwy i typy dla zasobów podrzędnych w Bicep.
ciąg (wymagany)
rodzic W Bicep można określić zasób nadrzędny dla zasobu podrzędnego. Tę właściwość należy dodać tylko wtedy, gdy zasób podrzędny jest zadeklarowany poza zasobem nadrzędnym.

Aby uzyskać więcej informacji, zobacz Zasób podrzędny poza zasobem nadrzędnym.
Nazwa symboliczna zasobu typu: obszarów roboczych
Właściwości WorkspaceConnectionPropertiesV2 (wymagane)

WorkspaceConnectionPropertiesV2

Nazwa Opis Wartość
kategoria Kategoria połączenia "ADLSGen2"
"ApiKey"
"AzureMySqlDb"
"AzureOpenAI"
"AzurePostgresDb"
"AzureSqlDb"
"AzureSynapseAnalytics"
"CognitiveSearch"
"CognitiveService"
"ContainerRegistry"
"CustomKeys"
"Git"
"PythonFeed"
"Redis"
"S3"
"Płatk śniegu"
expiryTime struna
metadane Dowolny obiekt W przypadku Bicep można użyć funkcji any().
cel struna
authType Ustawianie typu obiektu AccessKey
apikey
CustomKeys
ManagedIdentity
Brak
pat
sygnatury dostępu współdzielonego
ServicePrincipal
UsernamePassword (wymagane)

AccessKeyAuthTypeWorkspaceConnectionProperties

Nazwa Opis Wartość
authType Typ uwierzytelniania obiektu docelowego połączenia "AccessKey" (wymagany)
Poświadczenia WorkspaceConnectionAccessKey

WorkspaceConnectionAccessKey

Nazwa Opis Wartość
accessKeyId struna
secretAccessKey struna

ApiKeyAuthWorkspaceConnectionProperties

Nazwa Opis Wartość
authType Typ uwierzytelniania obiektu docelowego połączenia "ApiKey" (wymagane)
Poświadczenia Obiekt klucza interfejsu API dla poświadczeń połączenia obszaru roboczego. WorkspaceConnectionApiKey

WorkspaceConnectionApiKey

Nazwa Opis Wartość
klucz struna

CustomKeysWorkspaceConnectionProperties

Nazwa Opis Wartość
authType Typ uwierzytelniania obiektu docelowego połączenia "CustomKeys" (wymagane)
Poświadczenia Obiekt poświadczeń kluczy niestandardowych CustomKeys

Niestandardoweklucze

Nazwa Opis Wartość
Klucze Słownik {string} CustomKeys
{niestandardowa właściwość} struna

ManagedIdentityAuthTypeWorkspaceConnectionProperties

Nazwa Opis Wartość
authType Typ uwierzytelniania obiektu docelowego połączenia "ManagedIdentity" (wymagane)
Poświadczenia WorkspaceConnectionManagedIdentity

WorkspaceConnectionManagedIdentity

Nazwa Opis Wartość
clientId struna
resourceId struna

NoneAuthTypeWorkspaceConnectionProperties

Nazwa Opis Wartość
authType Typ uwierzytelniania obiektu docelowego połączenia "Brak" (wymagane)

PATAuthTypeWorkspaceConnectionProperties

Nazwa Opis Wartość
authType Typ uwierzytelniania obiektu docelowego połączenia "PAT" (wymagany)
Poświadczenia WorkspaceConnectionPersonalAccessToken

WorkspaceConnectionPersonalAccessToken

Nazwa Opis Wartość
klepać struna

SASAuthTypeWorkspaceConnectionProperties

Nazwa Opis Wartość
authType Typ uwierzytelniania obiektu docelowego połączenia "SAS" (wymagany)
Poświadczenia WorkspaceConnectionSharedAccessSignature

WorkspaceConnectionSharedAccessSignature

Nazwa Opis Wartość
Sas struna

ServicePrincipalAuthTypeWorkspaceConnectionPropertie...

Nazwa Opis Wartość
authType Typ uwierzytelniania obiektu docelowego połączenia "ServicePrincipal" (wymagane)
Poświadczenia WorkspaceConnectionServicePrincipal

WorkspaceConnectionServicePrincipal

Nazwa Opis Wartość
clientId struna
clientSecret struna
tenantId struna

UsernamePasswordAuthTypeWorkspaceConnectionPropertie...

Nazwa Opis Wartość
authType Typ uwierzytelniania obiektu docelowego połączenia "UsernamePassword" (wymagane)
Poświadczenia WorkspaceConnectionUsernamePassword

WorkspaceConnectionUsernamePassword

Nazwa Opis Wartość
hasło struna
nazwa użytkownika struna

Definicja zasobu szablonu usługi ARM

Typ zasobu obszary robocze/połączenia można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.MachineLearningServices/workspaces/connections, dodaj następujący kod JSON do szablonu.

{
  "type": "Microsoft.MachineLearningServices/workspaces/connections",
  "apiVersion": "2023-06-01-preview",
  "name": "string",
  "properties": {
    "category": "string",
    "expiryTime": "string",
    "metadata": {},
    "target": "string",
    "authType": "string"
    // For remaining properties, see WorkspaceConnectionPropertiesV2 objects
  }
}

WorkspaceConnectionPropertiesV2 , obiekty

Ustaw właściwość authType, aby określić typ obiektu.

W przypadku AccessKeyużyj:

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

W przypadku apiKeyużyj:

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

W przypadku CustomKeysużyj:

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

W przypadku ManagedIdentityużyj:

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

W przypadku Noneużyj:

  "authType": "None"

W przypadkuPAT użyj:

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

W przypadkusygnatury dostępu współdzielonego użyj:

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

W przypadku ServicePrincipalużyj:

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

W przypadku usernamePasswordużyj:

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

Wartości właściwości

obszary robocze/połączenia

Nazwa Opis Wartość
typ Typ zasobu "Microsoft.MachineLearningServices/workspaces/connections"
apiVersion Wersja interfejsu API zasobów "2023-06-01-preview"
nazwa Nazwa zasobu

Zobacz, jak ustawiać nazwy i typy dla zasobów podrzędnych w szablonach usługi ARM JSON.
ciąg (wymagany)
Właściwości WorkspaceConnectionPropertiesV2 (wymagane)

WorkspaceConnectionPropertiesV2

Nazwa Opis Wartość
kategoria Kategoria połączenia "ADLSGen2"
"ApiKey"
"AzureMySqlDb"
"AzureOpenAI"
"AzurePostgresDb"
"AzureSqlDb"
"AzureSynapseAnalytics"
"CognitiveSearch"
"CognitiveService"
"ContainerRegistry"
"CustomKeys"
"Git"
"PythonFeed"
"Redis"
"S3"
"Płatk śniegu"
expiryTime struna
metadane Dowolny obiekt
cel struna
authType Ustawianie typu obiektu AccessKey
apikey
CustomKeys
ManagedIdentity
Brak
pat
sygnatury dostępu współdzielonego
ServicePrincipal
UsernamePassword (wymagane)

AccessKeyAuthTypeWorkspaceConnectionProperties

Nazwa Opis Wartość
authType Typ uwierzytelniania obiektu docelowego połączenia "AccessKey" (wymagany)
Poświadczenia WorkspaceConnectionAccessKey

WorkspaceConnectionAccessKey

Nazwa Opis Wartość
accessKeyId struna
secretAccessKey struna

ApiKeyAuthWorkspaceConnectionProperties

Nazwa Opis Wartość
authType Typ uwierzytelniania obiektu docelowego połączenia "ApiKey" (wymagane)
Poświadczenia Obiekt klucza interfejsu API dla poświadczeń połączenia obszaru roboczego. WorkspaceConnectionApiKey

WorkspaceConnectionApiKey

Nazwa Opis Wartość
klucz struna

CustomKeysWorkspaceConnectionProperties

Nazwa Opis Wartość
authType Typ uwierzytelniania obiektu docelowego połączenia "CustomKeys" (wymagane)
Poświadczenia Obiekt poświadczeń kluczy niestandardowych CustomKeys

Niestandardoweklucze

Nazwa Opis Wartość
Klucze Słownik {string} CustomKeys
{niestandardowa właściwość} struna

ManagedIdentityAuthTypeWorkspaceConnectionProperties

Nazwa Opis Wartość
authType Typ uwierzytelniania obiektu docelowego połączenia "ManagedIdentity" (wymagane)
Poświadczenia WorkspaceConnectionManagedIdentity

WorkspaceConnectionManagedIdentity

Nazwa Opis Wartość
clientId struna
resourceId struna

NoneAuthTypeWorkspaceConnectionProperties

Nazwa Opis Wartość
authType Typ uwierzytelniania obiektu docelowego połączenia "Brak" (wymagane)

PATAuthTypeWorkspaceConnectionProperties

Nazwa Opis Wartość
authType Typ uwierzytelniania obiektu docelowego połączenia "PAT" (wymagany)
Poświadczenia WorkspaceConnectionPersonalAccessToken

WorkspaceConnectionPersonalAccessToken

Nazwa Opis Wartość
klepać struna

SASAuthTypeWorkspaceConnectionProperties

Nazwa Opis Wartość
authType Typ uwierzytelniania obiektu docelowego połączenia "SAS" (wymagany)
Poświadczenia WorkspaceConnectionSharedAccessSignature

WorkspaceConnectionSharedAccessSignature

Nazwa Opis Wartość
Sas struna

ServicePrincipalAuthTypeWorkspaceConnectionPropertie...

Nazwa Opis Wartość
authType Typ uwierzytelniania obiektu docelowego połączenia "ServicePrincipal" (wymagane)
Poświadczenia WorkspaceConnectionServicePrincipal

WorkspaceConnectionServicePrincipal

Nazwa Opis Wartość
clientId struna
clientSecret struna
tenantId struna

UsernamePasswordAuthTypeWorkspaceConnectionPropertie...

Nazwa Opis Wartość
authType Typ uwierzytelniania obiektu docelowego połączenia "UsernamePassword" (wymagane)
Poświadczenia WorkspaceConnectionUsernamePassword

WorkspaceConnectionUsernamePassword

Nazwa Opis Wartość
hasło struna
nazwa użytkownika struna

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu obszary robocze/połączenia można wdrożyć przy użyciu operacji docelowych:

  • grupy zasobów

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.MachineLearningServices/workspaces/connections, dodaj następujący program Terraform do szablonu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.MachineLearningServices/workspaces/connections@2023-06-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      category = "string"
      expiryTime = "string"
      target = "string"
      authType = "string"
      // For remaining properties, see WorkspaceConnectionPropertiesV2 objects
    }
  })
}

WorkspaceConnectionPropertiesV2 , obiekty

Ustaw właściwość authType, aby określić typ obiektu.

W przypadku AccessKeyużyj:

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

W przypadku apiKeyużyj:

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

W przypadku CustomKeysużyj:

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

W przypadku ManagedIdentityużyj:

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

W przypadku Noneużyj:

  authType = "None"

W przypadkuPAT użyj:

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

W przypadkusygnatury dostępu współdzielonego użyj:

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

W przypadku ServicePrincipalużyj:

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

W przypadku usernamePasswordużyj:

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

Wartości właściwości

obszary robocze/połączenia

Nazwa Opis Wartość
typ Typ zasobu "Microsoft.MachineLearningServices/workspaces/connections@2023-06-01-preview"
nazwa Nazwa zasobu ciąg (wymagany)
parent_id Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu. Identyfikator zasobu typu: obszarów roboczych
Właściwości WorkspaceConnectionPropertiesV2 (wymagane)

WorkspaceConnectionPropertiesV2

Nazwa Opis Wartość
kategoria Kategoria połączenia "ADLSGen2"
"ApiKey"
"AzureMySqlDb"
"AzureOpenAI"
"AzurePostgresDb"
"AzureSqlDb"
"AzureSynapseAnalytics"
"CognitiveSearch"
"CognitiveService"
"ContainerRegistry"
"CustomKeys"
"Git"
"PythonFeed"
"Redis"
"S3"
"Snowflake"
expiryTime struna
metadane Dowolny obiekt
cel struna
authType Ustawianie typu obiektu AccessKey
apikey
CustomKeys
ManagedIdentity
Brak
pat
sygnatury dostępu współdzielonego
ServicePrincipal
UsernamePassword (wymagane)

AccessKeyAuthTypeWorkspaceConnectionProperties

Nazwa Opis Wartość
authType Typ uwierzytelniania obiektu docelowego połączenia "AccessKey" (wymagany)
Poświadczenia WorkspaceConnectionAccessKey

WorkspaceConnectionAccessKey

Nazwa Opis Wartość
accessKeyId struna
secretAccessKey struna

ApiKeyAuthWorkspaceConnectionProperties

Nazwa Opis Wartość
authType Typ uwierzytelniania obiektu docelowego połączenia "ApiKey" (wymagane)
Poświadczenia Obiekt klucza interfejsu API dla poświadczeń połączenia obszaru roboczego. WorkspaceConnectionApiKey

WorkspaceConnectionApiKey

Nazwa Opis Wartość
klucz struna

CustomKeysWorkspaceConnectionProperties

Nazwa Opis Wartość
authType Typ uwierzytelniania obiektu docelowego połączenia "CustomKeys" (wymagane)
Poświadczenia Obiekt poświadczeń kluczy niestandardowych CustomKeys

Niestandardoweklucze

Nazwa Opis Wartość
Klucze Słownik {string} CustomKeys
{niestandardowa właściwość} struna

ManagedIdentityAuthTypeWorkspaceConnectionProperties

Nazwa Opis Wartość
authType Typ uwierzytelniania obiektu docelowego połączenia "ManagedIdentity" (wymagane)
Poświadczenia WorkspaceConnectionManagedIdentity

WorkspaceConnectionManagedIdentity

Nazwa Opis Wartość
clientId struna
resourceId struna

NoneAuthTypeWorkspaceConnectionProperties

Nazwa Opis Wartość
authType Typ uwierzytelniania obiektu docelowego połączenia "Brak" (wymagane)

PATAuthTypeWorkspaceConnectionProperties

Nazwa Opis Wartość
authType Typ uwierzytelniania obiektu docelowego połączenia "PAT" (wymagany)
Poświadczenia WorkspaceConnectionPersonalAccessToken

WorkspaceConnectionPersonalAccessToken

Nazwa Opis Wartość
klepać struna

SASAuthTypeWorkspaceConnectionProperties

Nazwa Opis Wartość
authType Typ uwierzytelniania obiektu docelowego połączenia "SAS" (wymagany)
Poświadczenia WorkspaceConnectionSharedAccessSignature

WorkspaceConnectionSharedAccessSignature

Nazwa Opis Wartość
Sas struna

ServicePrincipalAuthTypeWorkspaceConnectionPropertie...

Nazwa Opis Wartość
authType Typ uwierzytelniania obiektu docelowego połączenia "ServicePrincipal" (wymagane)
Poświadczenia WorkspaceConnectionServicePrincipal

WorkspaceConnectionServicePrincipal

Nazwa Opis Wartość
clientId struna
clientSecret struna
tenantId struna

UsernamePasswordAuthTypeWorkspaceConnectionPropertie...

Nazwa Opis Wartość
authType Typ uwierzytelniania obiektu docelowego połączenia "UsernamePassword" (wymagane)
Poświadczenia WorkspaceConnectionUsernamePassword

WorkspaceConnectionUsernamePassword

Nazwa Opis Wartość
hasło struna
nazwa użytkownika struna