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

Definicja zasobu Bicep

Typ zasobu obszary robocze/połączenia można wdrożyć z operacjami docelowymi:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik 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-08-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    category: 'string'
    expiryTime: 'string'
    isSharedToAll: bool
    metadata: any()
    target: 'string'
    authType: 'string'
    // For remaining properties, see WorkspaceConnectionPropertiesV2 objects
  }
}

WorkspaceConnectionPropertiesV2, obiekty

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

Dla klucza AccessKey użyj:

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

W przypadku elementu ApiKey użyj:

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

W przypadku kluczy niestandardowych użyj:

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

W przypadku elementu ManagedIdentity użyj:

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

W przypadku opcji Brak użyj polecenia:

  authType: 'None'

W przypadku tokenu pat użyj:

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

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

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

W przypadku parametru ServicePrincipal użyj:

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

W polu UsernamePassword użyj:

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

Wartości właściwości

obszary robocze/połączenia

Nazwa Opis Wartość
name Nazwa zasobu

Zobacz, jak ustawić nazwy i typy dla zasobów podrzędnych w aplikacji Bicep.
ciąg (wymagany)
Nadrzędny 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: obszary robocze
properties WorkspaceConnectionPropertiesV2 (wymagane)

WorkspaceConnectionPropertiesV2

Nazwa Opis Wartość
category Kategoria połączenia "ADLSGen2"
"ApiKey"
"AzureMySqlDb"
"AzureOpenAI"
"AzurePostgresDb"
"AzureSqlDb"
"AzureSynapseAnalytics"
"CognitiveSearch"
"CognitiveService"
"ContainerRegistry"
"CustomKeys"
"Git"
"PythonFeed"
"Redis"
"S3"
"Snowflake"
expiryTime ciąg
isSharedToAll czy to połączenie zostanie udostępnione wszystkim obszarom roboczym projektu w centrum bool
metadane Dowolny obiekt W przypadku funkcji Bicep można użyć funkcji any().
Docelowego ciąg
Authtype Ustawianie typu obiektu Accesskey
ApiKey
Niestandardoweklucze
ManagedIdentity
Brak
Osobisty token dostępu
SAS
ServicePrincipal
UsernamePassword (wymagane)

AccessKeyAuthTypeWorkspaceConnectionProperties

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

WorkspaceConnectionAccessKey

Nazwa Opis Wartość
accessKeyId ciąg
secretAccessKey ciąg

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ść
key ciąg

CustomKeysWorkspaceConnectionProperties

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

Niestandardoweklucze

Nazwa Opis Wartość
keys Słownik {string} Niestandardoweklucze
{niestandardowa właściwość} ciąg

ManagedIdentityAuthTypeWorkspaceConnectionProperties

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

WorkspaceConnectionManagedIdentity

Nazwa Opis Wartość
clientId ciąg
resourceId ciąg

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ść
Pat ciąg

SASAuthTypeWorkspaceConnectionProperties

Nazwa Opis Wartość
Authtype Typ uwierzytelniania obiektu docelowego połączenia "SAS" (wymagane)
poświadczenia WorkspaceConnectionSharedAccessSignature

WorkspaceConnectionSharedAccessSignature

Nazwa Opis Wartość
Sas ciąg

ServicePrincipalAuthTypeWorkspaceConnectionPropertie...

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

WorkspaceConnectionServicePrincipal

Nazwa Opis Wartość
clientId ciąg
clientSecret ciąg
tenantId ciąg

UsernamePasswordAuthTypeWorkspaceConnectionPropertie...

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

WorkspaceConnectionUsernamePassword

Nazwa Opis Wartość
hasło ciąg
nazwa użytkownika ciąg

Definicja zasobu szablonu usługi ARM

Typ zasobu obszary robocze/połączenia można wdrożyć z operacjami docelowymi:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik 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-08-01-preview",
  "name": "string",
  "properties": {
    "category": "string",
    "expiryTime": "string",
    "isSharedToAll": "bool",
    "metadata": {},
    "target": "string",
    "authType": "string"
    // For remaining properties, see WorkspaceConnectionPropertiesV2 objects
  }
}

WorkspaceConnectionPropertiesV2, obiekty

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

Dla klucza AccessKey użyj:

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

W przypadku elementu ApiKey użyj:

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

W przypadku kluczy niestandardowych użyj:

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

W przypadku elementu ManagedIdentity użyj:

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

W przypadku opcji Brak użyj polecenia:

  "authType": "None"

W przypadku tokenu pat użyj:

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

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

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

W przypadku parametru ServicePrincipal użyj:

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

W polu UsernamePassword uż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-08-01-preview"
name Nazwa zasobu

Zobacz, jak ustawić nazwy i typy dla zasobów podrzędnych w szablonach usługi ARM w formacie JSON.
ciąg (wymagany)
properties WorkspaceConnectionPropertiesV2 (wymagane)

WorkspaceConnectionPropertiesV2

Nazwa Opis Wartość
category Kategoria połączenia "ADLSGen2"
"ApiKey"
"AzureMySqlDb"
"AzureOpenAI"
"AzurePostgresDb"
"AzureSqlDb"
"AzureSynapseAnalytics"
"CognitiveSearch"
"CognitiveService"
"ContainerRegistry"
"CustomKeys"
"Git"
"PythonFeed"
"Redis"
"S3"
"Snowflake"
expiryTime ciąg
isSharedToAll czy to połączenie zostanie udostępnione wszystkim obszarowi roboczemu projektu w centrum bool
metadane Dowolny obiekt
Docelowego ciąg
Authtype Ustawianie typu obiektu Accesskey
ApiKey
Niestandardoweklucze
ManagedIdentity
Brak
Osobisty token dostępu
SAS
ServicePrincipal
UsernamePassword (wymagane)

AccessKeyAuthTypeWorkspaceConnectionProperties

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

WorkspaceConnectionAccessKey

Nazwa Opis Wartość
accessKeyId ciąg
secretAccessKey ciąg

ApiKeyAuthWorkspaceConnectionProperties

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

WorkspaceConnectionApiKey

Nazwa Opis Wartość
key ciąg

CustomKeysWorkspaceConnectionProperties

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

Niestandardoweklucze

Nazwa Opis Wartość
keys Słownik {string} Niestandardoweklucze
{niestandardowa właściwość} ciąg

ManagedIdentityAuthTypeWorkspaceConnectionProperties

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

WorkspaceConnectionManagedIdentity

Nazwa Opis Wartość
clientId ciąg
resourceId ciąg

NoneAuthTypeWorkspaceConnectionProperties

Nazwa Opis Wartość
Authtype Typ uwierzytelniania docelowego połączenia "None" (wymagane)

PATAuthTypeWorkspaceConnectionProperties

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

WorkspaceConnectionPersonalAccessToken

Nazwa Opis Wartość
Pat ciąg

SASAuthTypeWorkspaceConnectionProperties

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

WorkspaceConnectionSharedAccessSignature

Nazwa Opis Wartość
Sas ciąg

ServicePrincipalAuthTypeWorkspaceConnectionPropertie...

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

WorkspaceConnectionServicePrincipal

Nazwa Opis Wartość
clientId ciąg
clientSecret ciąg
tenantId ciąg

UsernamePasswordAuthTypeWorkspaceConnectionPropertie...

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

WorkspaceConnectionUsernamePassword

Nazwa Opis Wartość
hasło ciąg
nazwa użytkownika ciąg

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu obszarów roboczych/połączeń można wdrożyć z operacjami docelowymi:

  • Grupy zasobów

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik 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-08-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      category = "string"
      expiryTime = "string"
      isSharedToAll = bool
      target = "string"
      authType = "string"
      // For remaining properties, see WorkspaceConnectionPropertiesV2 objects
    }
  })
}

Obiekty WorkspaceConnectionPropertiesV2

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

W polu AccessKey użyj:

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

W przypadku klucza ApiKey użyj:

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

W przypadku klawiszy CustomKeys użyj:

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

W przypadku funkcji ManagedIdentity użyj:

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

W przypadku opcji None użyj polecenia:

  authType = "None"

W przypadku pat użyj:

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

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

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

W przypadku elementu ServicePrincipal użyj:

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

W polu UsernamePassword uż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-08-01-preview"
name Nazwa zasobu ciąg (wymagany)
parent_id Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu. Identyfikator zasobu typu: obszary robocze
properties WorkspaceConnectionPropertiesV2 (wymagane)

WorkspaceConnectionPropertiesV2

Nazwa Opis Wartość
category Kategoria połączenia "ADLSGen2"
"ApiKey"
"AzureMySqlDb"
"AzureOpenAI"
"AzurePostgresDb"
"AzureSqlDb"
"AzureSynapseAnalytics"
"CognitiveSearch"
"CognitiveService"
"ContainerRegistry"
"CustomKeys"
"Git"
"PythonFeed"
"Redis"
"S3"
"Snowflake"
expiryTime ciąg
isSharedToAll czy to połączenie zostanie udostępnione wszystkim obszarom roboczym projektu w centrum bool
metadane Dowolny obiekt
Docelowego ciąg
Authtype Ustawianie typu obiektu Accesskey
ApiKey
Niestandardoweklucze
ManagedIdentity
Brak
Osobisty token dostępu
SAS
ServicePrincipal
UsernamePassword (wymagane)

AccessKeyAuthTypeWorkspaceConnectionProperties

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

WorkspaceConnectionAccessKey

Nazwa Opis Wartość
accessKeyId ciąg
secretAccessKey ciąg

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ść
key ciąg

CustomKeysWorkspaceConnectionProperties

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

Niestandardoweklucze

Nazwa Opis Wartość
keys Słownik {string} Niestandardoweklucze
{niestandardowa właściwość} ciąg

ManagedIdentityAuthTypeWorkspaceConnectionProperties

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

WorkspaceConnectionManagedIdentity

Nazwa Opis Wartość
clientId ciąg
resourceId ciąg

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ść
Pat ciąg

SASAuthTypeWorkspaceConnectionProperties

Nazwa Opis Wartość
Authtype Typ uwierzytelniania obiektu docelowego połączenia "SAS" (wymagane)
poświadczenia WorkspaceConnectionSharedAccessSignature

WorkspaceConnectionSharedAccessSignature

Nazwa Opis Wartość
Sas ciąg

ServicePrincipalAuthTypeWorkspaceConnectionPropertie...

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

WorkspaceConnectionServicePrincipal

Nazwa Opis Wartość
clientId ciąg
clientSecret ciąg
tenantId ciąg

UsernamePasswordAuthTypeWorkspaceConnectionPropertie...

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

WorkspaceConnectionUsernamePassword

Nazwa Opis Wartość
hasło ciąg
nazwa użytkownika ciąg