Data Connectors - Get
Get specific Data Connector resource by DataConnectorName.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats/{dataManagerForAgricultureResourceName}/dataConnectors/{dataConnectorName}?api-version=2023-06-01-preview
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
data
|
path | True |
string |
Connector name. |
data
|
path | True |
string |
DataManagerForAgriculture resource name. Regex pattern: |
resource
|
path | True |
string |
The name of the resource group. The name is case insensitive. |
subscription
|
path | True |
string uuid |
The ID of the target subscription. The value must be an UUID. |
api-version
|
query | True |
string |
The API version to use for this operation. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
Success |
|
Other Status Codes |
Error |
Security
azure_auth
Azure Active Directory OAuth2 Flow.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | impersonate your user account |
Examples
DataConnectors_Get
Sample request
GET https://management.azure.com/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/examples-rg/providers/Microsoft.AgFoodPlatform/farmBeats/examples-dataManagerForAgricultureResourceName/dataConnectors/SatelliteSentinelHub?api-version=2023-06-01-preview
Sample response
{
"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"
}
Definitions
Name | Description |
---|---|
Api |
ApiKeyAuthCredentials class for ApiKey based Auth. |
created |
The type of identity that created the resource. |
Data |
DataConnector Model. |
Data |
DataConnector Properties. |
Error |
The resource management error additional info. |
Error |
The error detail. |
Error |
Error response |
Key |
Properties of the key vault. |
OAuth |
OAuthClientCredentials for clientId clientSecret auth. |
system |
Metadata pertaining to creation and last modification of the resource. |
ApiKeyAuthCredentials
ApiKeyAuthCredentials class for ApiKey based Auth.
Name | Type | Description |
---|---|---|
apiKey |
Properties of the key vault. |
|
kind | string: |
Enum for different types of AuthCredentials supported. |
createdByType
The type of identity that created the resource.
Name | Type | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
DataConnector
DataConnector Model.
Name | Type | Description |
---|---|---|
eTag |
string |
The ETag value to implement optimistic concurrency. |
id |
string |
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" |
name |
string |
The name of the resource |
properties |
DataConnector Properties. |
|
systemData |
Metadata pertaining to creation and last modification of the resource. |
|
type |
string |
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
DataConnectorProperties
DataConnector Properties.
Name | Type | Description |
---|---|---|
credentials | AuthCredentials: |
AuthCredentials abstract base class for Auth Purpose. |
ErrorAdditionalInfo
The resource management error additional info.
Name | Type | Description |
---|---|---|
info |
object |
The additional info. |
type |
string |
The additional info type. |
ErrorDetail
The error detail.
Name | Type | Description |
---|---|---|
additionalInfo |
The error additional info. |
|
code |
string |
The error code. |
details |
The error details. |
|
message |
string |
The error message. |
target |
string |
The error target. |
ErrorResponse
Error response
Name | Type | Description |
---|---|---|
error |
The error object. |
KeyVaultProperties
Properties of the key vault.
Name | Type | Description |
---|---|---|
keyName |
string |
Name of Key Vault key. |
keyVaultUri |
string |
Uri of the key vault. |
keyVersion |
string |
Version of Key Vault key. |
OAuthClientCredentials
OAuthClientCredentials for clientId clientSecret auth.
Name | Type | Description |
---|---|---|
clientId |
string |
ClientId associated with the provider. |
clientSecret |
Properties of the key vault. |
|
kind | string: |
Enum for different types of AuthCredentials supported. |
systemData
Metadata pertaining to creation and last modification of the resource.
Name | Type | Description |
---|---|---|
createdAt |
string |
The timestamp of resource creation (UTC). |
createdBy |
string |
The identity that created the resource. |
createdByType |
The type of identity that created the resource. |
|
lastModifiedAt |
string |
The timestamp of resource last modification (UTC) |
lastModifiedBy |
string |
The identity that last modified the resource. |
lastModifiedByType |
The type of identity that last modified the resource. |