Microsoft.AgFoodPlatform farmBeats/dataConnectors

Определение ресурса Bicep

Тип ресурса farmBeats/dataConnectors можно развернуть с помощью операций, предназначенных для:

Список измененных свойств в каждой версии API см. в журнале изменений.

Формат ресурсов

Чтобы создать ресурс Microsoft.AgFoodPlatform/farmBeats/dataConnectors, добавьте следующий Bicep в шаблон.

resource symbolicname 'Microsoft.AgFoodPlatform/farmBeats/dataConnectors@2023-06-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    credentials: {
      kind: 'string'
      // For remaining properties, see AuthCredentials objects
    }
  }
}

Объекты AuthCredentials

Задайте свойство kind , чтобы указать тип объекта .

Для ApiKeyAuthCredentials используйте:

  kind: 'ApiKeyAuthCredentials'
  apiKey: {
    keyName: 'string'
    keyVaultUri: 'string'
    keyVersion: 'string'
  }

Для OAuthClientCredentials используйте:

  kind: 'OAuthClientCredentials'
  clientId: 'string'
  clientSecret: {
    keyName: 'string'
    keyVaultUri: 'string'
    keyVersion: 'string'
  }

Значения свойств

farmBeats/dataConnectors

Имя Описание Значение
name имя ресурса.

Узнайте, как задать имена и типы для дочерних ресурсов в Bicep.
строка (обязательно)
родитель В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить только в том случае, если дочерний ресурс объявлен вне родительского ресурса.

Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса.
Символьное имя ресурса типа: farmBeats
properties Свойства DataConnector. DataConnectorProperties (обязательно)

DataConnectorProperties

Имя Описание Значение
credentials AuthCredentials абстрактный базовый класс для auth Purpose. AuthCredentials (обязательно)

AuthCredentials

Имя Описание Значение
kind Установка типа объекта ApiKeyAuthCredentials
OAuthClientCredentials (обязательно)

ApiKeyAuthCredentials

Имя Описание Значение
kind Перечисление для различных поддерживаемых типов AuthCredentials. ApiKeyAuthCredentials (обязательно)
apiKey Свойства хранилища ключей. KeyVaultProperties (обязательно)

KeyVaultProperties

Имя Описание Значение
keyName Имя ключа Key Vault. строка (обязательно)

Ограничения:
Минимальная длина = 1
keyVaultUri URI хранилища ключей. строка (обязательно)

Ограничения:
Минимальная длина = 1
keyVersion Версия ключа Key Vault. строка (обязательно)

Ограничения:
Минимальная длина = 1

OAuthClientCredentials

Имя Описание Значение
kind Перечисление для различных поддерживаемых типов AuthCredentials. OAuthClientCredentials (обязательно)
clientid ClientId, связанный с поставщиком. строка (обязательно)

Ограничения:
Минимальная длина = 1
clientSecret Свойства хранилища ключей. KeyVaultProperties (обязательно)

Определение ресурса шаблона ARM

Тип ресурса farmBeats/dataConnectors можно развернуть с помощью операций, предназначенных для:

Список измененных свойств в каждой версии API см. в журнале изменений.

Формат ресурсов

Чтобы создать ресурс Microsoft.AgFoodPlatform/farmBeats/dataConnectors, добавьте следующий код JSON в шаблон.

{
  "type": "Microsoft.AgFoodPlatform/farmBeats/dataConnectors",
  "apiVersion": "2023-06-01-preview",
  "name": "string",
  "properties": {
    "credentials": {
      "kind": "string"
      // For remaining properties, see AuthCredentials objects
    }
  }
}

Объекты AuthCredentials

Задайте свойство kind , чтобы указать тип объекта .

Для ApiKeyAuthCredentials используйте:

  "kind": "ApiKeyAuthCredentials",
  "apiKey": {
    "keyName": "string",
    "keyVaultUri": "string",
    "keyVersion": "string"
  }

Для OAuthClientCredentials используйте:

  "kind": "OAuthClientCredentials",
  "clientId": "string",
  "clientSecret": {
    "keyName": "string",
    "keyVaultUri": "string",
    "keyVersion": "string"
  }

Значения свойств

farmBeats/dataConnectors

Имя Описание Значение
тип Тип ресурса Microsoft.AgFoodPlatform/farmBeats/dataConnectors
версия_API Версия API ресурсов '2023-06-01-preview'
name имя ресурса.

Узнайте, как задать имена и типы для дочерних ресурсов в шаблонах JSON ARM.
string (обязательно)
properties Свойства DataConnector. DataConnectorProperties (обязательно)

DataConnectorProperties

Имя Описание Значение
credentials AuthCredentials абстрактный базовый класс для auth Purpose. AuthCredentials (обязательно)

AuthCredentials

Имя Описание Значение
kind Установка типа объекта ApiKeyAuthCredentials
OAuthClientCredentials (обязательно)

ApiKeyAuthCredentials

Имя Описание Значение
kind Перечисление для различных поддерживаемых типов AuthCredentials. ApiKeyAuthCredentials (обязательно)
apiKey Свойства хранилища ключей. KeyVaultProperties (обязательно)

KeyVaultProperties

Имя Описание Значение
keyName Имя ключа Key Vault. string (обязательно)

Ограничения:
Минимальная длина = 1
keyVaultUri URI хранилища ключей. string (обязательно)

Ограничения:
Минимальная длина = 1
keyVersion Версия ключа Key Vault. string (обязательно)

Ограничения:
Минимальная длина = 1

OAuthClientCredentials

Имя Описание Значение
kind Перечисление для различных поддерживаемых типов AuthCredentials. OAuthClientCredentials (обязательно)
clientid ClientId, связанный с поставщиком. string (обязательно)

Ограничения:
Минимальная длина = 1
clientSecret Свойства хранилища ключей. KeyVaultProperties (обязательно)

Определение ресурса Terraform (поставщик AzAPI)

Тип ресурса farmBeats/dataConnectors можно развернуть с помощью операций, предназначенных для:

  • Группы ресурсов

Список измененных свойств в каждой версии API см. в журнале изменений.

Формат ресурсов

Чтобы создать ресурс Microsoft.AgFoodPlatform/farmBeats/dataConnectors, добавьте следующую terraform в шаблон.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.AgFoodPlatform/farmBeats/dataConnectors@2023-06-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      credentials = {
        kind = "string"
        // For remaining properties, see AuthCredentials objects
      }
    }
  })
}

Объекты AuthCredentials

Задайте свойство kind , чтобы указать тип объекта .

Для ApiKeyAuthCredentials используйте:

  kind = "ApiKeyAuthCredentials"
  apiKey = {
    keyName = "string"
    keyVaultUri = "string"
    keyVersion = "string"
  }

Для OAuthClientCredentials используйте:

  kind = "OAuthClientCredentials"
  clientId = "string"
  clientSecret = {
    keyName = "string"
    keyVaultUri = "string"
    keyVersion = "string"
  }

Значения свойств

farmBeats/dataConnectors

Имя Описание Значение
тип Тип ресурса "Microsoft.AgFoodPlatform/farmBeats/dataConnectors@2023-06-01-preview"
name имя ресурса. string (обязательно)
parent_id Идентификатор ресурса, который является родительским для этого ресурса. Идентификатор ресурса типа: farmBeats
properties Свойства DataConnector. DataConnectorProperties (обязательно)

DataConnectorProperties

Имя Описание Значение
credentials AuthCredentials абстрактный базовый класс для auth Purpose. AuthCredentials (обязательно)

AuthCredentials

Имя Описание Значение
kind Установка типа объекта ApiKeyAuthCredentials
OAuthClientCredentials (обязательно)

ApiKeyAuthCredentials

Имя Описание Значение
kind Перечисление для различных поддерживаемых типов AuthCredentials. ApiKeyAuthCredentials (обязательно)
apiKey Свойства хранилища ключей. KeyVaultProperties (обязательно)

KeyVaultProperties

Имя Описание Значение
keyName Имя ключа Key Vault. string (обязательно)

Ограничения:
Минимальная длина = 1
keyVaultUri URI хранилища ключей. string (обязательно)

Ограничения:
Минимальная длина = 1
keyVersion Версия ключа Key Vault. string (обязательно)

Ограничения:
Минимальная длина = 1

OAuthClientCredentials

Имя Описание Значение
kind Перечисление для различных поддерживаемых типов AuthCredentials. OAuthClientCredentials (обязательно)
clientid ClientId, связанный с поставщиком. string (обязательно)

Ограничения:
Минимальная длина = 1
clientSecret Свойства хранилища ключей. KeyVaultProperties (обязательно)