你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Data Connectors - Create Or Update

参考

Service:: Azure Data Manager for Agriculture

API Version:: 2023-06-01-preview

创建或更新 MADMA 资源的数据连接器。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats/{dataManagerForAgricultureResourceName}/dataConnectors/{dataConnectorName}?api-version=2023-06-01-preview

URI 参数

名称	在	必需	类型	说明
dataConnectorName	path	True	string	连接器名称。
dataManagerForAgricultureResourceName	path	True	string	DataManagerForAgriculture 资源名称。 Regex pattern: `^[A-Za-z0-9]+(-[A-Za-z0-9]+)*$`
resourceGroupName	path	True	string	资源组的名称。此名称不区分大小写。
subscriptionId	path	True	string uuid	目标订阅的 ID。该值必须是 UUID。
api-version	query	True	string	要用于此操作的 API 版本。

请求正文

名称	必需	类型	说明
properties	True	DataConnectorProperties	DataConnector 属性。

响应

名称	类型	说明
200 OK	DataConnector	成功
201 Created	DataConnector	创建
Other Status Codes	ErrorResponse	错误

安全性

azure_auth

Azure Active Directory OAuth2 流。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名称	说明
user_impersonation	模拟用户帐户

示例

DataConnectors_CreateOrUpdate

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/examples-rg/providers/Microsoft.AgFoodPlatform/farmBeats/examples-dataManagerForAgricultureResourceName/dataConnectors/WeatherIBM?api-version=2023-06-01-preview

{
  "properties": {
    "credentials": {
      "kind": "ApiKeyAuthCredentials",
      "apiKey": {
        "keyVaultUri": "https://testKeyVault.vault.azure.net/",
        "keyName": "abcApiKey",
        "keyVersion": "239c0475c7d44f20b0fc27d3fe90a41d"
      }
    }
  }
}

Sample Response

Status code:: 200

{
  "id": "/subscriptions/ff57165d-e71f-4a0e-8e9b-3cd461dc0f38/resourceGroups/bugbash-instances-westus2/providers/Microsoft.AgFoodPlatform/farmBeats/bb-df-wus2-1/dataConnectors/WeatherIBM",
  "type": "Microsoft.AgFoodPlatform/farmBeats/dataConnectors",
  "properties": {
    "credentials": {
      "kind": "OAuthClientCredentials",
      "clientId": "string",
      "clientSecret": {
        "keyVaultUri": "string",
        "keyName": "string",
        "keyVersion": "string"
      }
    }
  }
}

Status code:: 201

{
  "id": "/subscriptions/ff57165d-e71f-4a0e-8e9b-3cd461dc0f38/resourceGroups/bugbash-instances-westus2/providers/Microsoft.AgFoodPlatform/farmBeats/bb-df-wus2-1/dataConnectors/SatelliteSentinelHub",
  "type": "Microsoft.AgFoodPlatform/farmBeats/dataConnectors",
  "properties": {
    "credentials": {
      "kind": "OAuthClientCredentials",
      "clientId": "string",
      "clientSecret": {
        "keyVaultUri": "string",
        "keyName": "string",
        "keyVersion": "string"
      }
    }
  },
  "systemData": {
    "createdBy": "string",
    "createdByType": "User",
    "createdAt": "2020-02-01T01:01:01.1075056Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-02-01T01:01:02.1075056Z"
  },
  "eTag": "7200b954-0000-0700-0000-603cbbc40000",
  "name": "SatelliteSentinelHub"
}

定义

名称	说明
ApiKeyAuthCredentials	基于 ApiKey 的身份验证的 ApiKeyAuthCredentials 类。
createdByType	创建资源的标识类型。
DataConnector	DataConnector 模型。
DataConnectorProperties	DataConnector 属性。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
KeyVaultProperties	密钥保管库的属性。
OAuthClientCredentials	clientId clientSecret 身份验证的 OAuthClientCredentials。
systemData	与资源的创建和上次修改相关的元数据。

ApiKeyAuthCredentials

基于 ApiKey 的身份验证的 ApiKeyAuthCredentials 类。

名称	类型	说明
apiKey	KeyVaultProperties	密钥保管库的属性。
kind	string: ApiKeyAuthCredentials	支持的不同类型的 AuthCredentials 的枚举。

createdByType

创建资源的标识类型。

名称	类型	说明
Application	string
Key	string
ManagedIdentity	string
User	string

DataConnector

DataConnector 模型。

名称	类型	说明
eTag	string	用于实现乐观并发的 ETag 值。
id	string	资源的完全限定的资源 ID。例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
name	string	资源的名称
properties	DataConnectorProperties	DataConnector 属性。
systemData	systemData	与资源的创建和上次修改相关的元数据。
type	string	资源类型。例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

DataConnectorProperties

DataConnector 属性。

名称	类型	说明
credentials	AuthCredentials: ApiKeyAuthCredentials OAuthClientCredentials	用于身份验证目的的 AuthCredentials 抽象基类。

ErrorAdditionalInfo

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

KeyVaultProperties

密钥保管库的属性。

名称	类型	说明
keyName	string	密钥保管库项的名称。
keyVaultUri	string	密钥保管库的 URI。
keyVersion	string	密钥保管库密钥的版本。

OAuthClientCredentials

clientId clientSecret 身份验证的 OAuthClientCredentials。

名称	类型	说明
clientId	string	与提供程序关联的 ClientId。
clientSecret	KeyVaultProperties	密钥保管库的属性。
kind	string: OAuthClientCredentials	支持的不同类型的 AuthCredentials 的枚举。

systemData

与资源的创建和上次修改相关的元数据。

名称	类型	说明
createdAt	string	资源创建时间戳 (UTC) 。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识类型。
lastModifiedAt	string	资源上次修改的时间戳 (UTC)
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识类型。

通过