Data Connectors - Create Or Update

Référence

Service:: Azure Data Manager for Agriculture

Version d'API:: 2023-06-01-preview

Créez ou mettez à jour la ressource Connecteur de données pour MADMA.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
dataConnectorName	path	True	string	Nom du connecteur.
dataManagerForAgricultureResourceName	path	True	string	Nom de la ressource DataManagerForAgriculture. Modèle d’expression régulière: `^[A-Za-z0-9]+(-[A-Za-z0-9]+)*$`
resourceGroupName	path	True	string	Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId	path	True	string uuid	ID de l’abonnement cible. La valeur doit être un UUID.
api-version	query	True	string	Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom	Obligatoire	Type	Description
properties	True	DataConnectorProperties	Propriétés de DataConnector.

Réponses

Nom	Type	Description
200 OK	DataConnector	Succès
201 Created	DataConnector	Date de création
Other Status Codes	ErrorResponse	Erreur

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

DataConnectors_CreateOrUpdate

Exemple de requête

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"
      }
    }
  }
}

Exemple de réponse

Code d’état:: 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"
      }
    }
  }
}

Code d’état:: 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"
}

Définitions

Nom	Description
ApiKeyAuthCredentials	Classe ApiKeyAuthCredentials pour l’authentification basée sur ApiKey.
createdByType	Type d’identité qui a créé la ressource.
DataConnector	Modèle DataConnector.
DataConnectorProperties	Propriétés de DataConnector.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
KeyVaultProperties	Propriétés du coffre de clés.
OAuthClientCredentials	OAuthClientCredentials pour l’authentification clientId clientSecret.
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.

ApiKeyAuthCredentials

Classe ApiKeyAuthCredentials pour l’authentification basée sur ApiKey.

Nom	Type	Description
apiKey	KeyVaultProperties	Propriétés du coffre de clés.
kind	string: ApiKeyAuthCredentials	Énumération pour les différents types d’AuthCredentials pris en charge.

createdByType

Type d’identité qui a créé la ressource.

Nom	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DataConnector

Modèle DataConnector.

Nom	Type	Description
eTag	string	Valeur ETag pour implémenter l’accès concurrentiel optimiste.
id	string	ID de ressource complet pour la ressource. Par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} »
name	string	nom de la ressource.
properties	DataConnectorProperties	Propriétés de DataConnector.
systemData	systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

DataConnectorProperties

Propriétés de DataConnector.

Nom	Type	Description
credentials	AuthCredentials: ApiKeyAuthCredentials OAuthClientCredentials	Classe de base abstraite AuthCredentials pour Auth Purpose.

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires
type	string	Type d’informations supplémentaires.

ErrorDetail

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d'erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet error.

KeyVaultProperties

Propriétés du coffre de clés.

Nom	Type	Description
keyName	string	Nom de Key Vault clé.
keyVaultUri	string	URI du coffre de clés.
keyVersion	string	Version de Key Vault clé.

OAuthClientCredentials

OAuthClientCredentials pour l’authentification clientId clientSecret.

Nom	Type	Description
clientId	string	ClientId associé au fournisseur.
clientSecret	KeyVaultProperties	Propriétés du coffre de clés.
kind	string: OAuthClientCredentials	Énumération pour les différents types d’AuthCredentials pris en charge.

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string	Horodatage de la dernière modification de la ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	createdByType	Type d’identité qui a modifié la ressource pour la dernière fois.

Partager via