Microsoft.AgFoodPlatform (preview:2021-09-01)

2025/09/26 • 27 new, 27 deleted methods

Extensions_CreateOrUpdate (new)
Description :  Install or Update extension. AdditionalApiProperties are merged patch and if the extension is updated to a new version then the obsolete entries will be auto deleted from AdditionalApiProperties.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats/{farmBeatsResourceName}/extensions/{extensionId}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
farmBeatsResourceName:
{
Description: FarmBeats resource name. ,
Required: True ,
}
string ,
extensionId:
{
Description: Id of extension resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
requestBody:
{
Description: Extension resource request body. ,
Required: False ,
}
{
extensionVersion:
{
Description: Extension Version. ,
Required: False ,
}
string ,
additionalApiProperties:
{
Description: Additional Api Properties. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Extension resource properties. ,
Required: False ,
}
{
extensionId:
{
Description: Extension Id. ,
Required: False ,
}
string ,
extensionCategory:
{
Description: Extension category. e.g. weather/sensor/satellite. ,
Required: False ,
}
string ,
installedExtensionVersion:
{
Description: Installed extension version. ,
Required: False ,
}
string ,
extensionAuthLink:
{
Description: Extension auth link. ,
Required: False ,
}
string ,
extensionApiDocsLink:
{
Description: Extension api docs link. ,
Required: False ,
}
string ,
additionalApiProperties:
{
Description: Additional api properties. ,
Required: False ,
}
object ,
}
,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Extension resource properties. ,
Required: False ,
}
{
extensionId:
{
Description: Extension Id. ,
Required: False ,
}
string ,
extensionCategory:
{
Description: Extension category. e.g. weather/sensor/satellite. ,
Required: False ,
}
string ,
installedExtensionVersion:
{
Description: Installed extension version. ,
Required: False ,
}
string ,
extensionAuthLink:
{
Description: Extension auth link. ,
Required: False ,
}
string ,
extensionApiDocsLink:
{
Description: Extension api docs link. ,
Required: False ,
}
string ,
additionalApiProperties:
{
Description: Additional api properties. ,
Required: False ,
}
object ,
}
,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Extensions_Get (new)
Description :  Get installed extension details by extension id.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats/{farmBeatsResourceName}/extensions/{extensionId}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
farmBeatsResourceName:
{
Description: FarmBeats resource name. ,
Required: True ,
}
string ,
extensionId:
{
Description: Id of extension resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Extension resource properties. ,
Required: False ,
}
{
extensionId:
{
Description: Extension Id. ,
Required: False ,
}
string ,
extensionCategory:
{
Description: Extension category. e.g. weather/sensor/satellite. ,
Required: False ,
}
string ,
installedExtensionVersion:
{
Description: Installed extension version. ,
Required: False ,
}
string ,
extensionAuthLink:
{
Description: Extension auth link. ,
Required: False ,
}
string ,
extensionApiDocsLink:
{
Description: Extension api docs link. ,
Required: False ,
}
string ,
additionalApiProperties:
{
Description: Additional api properties. ,
Required: False ,
}
object ,
}
,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Extensions_Delete (new)
Description :  Uninstall extension.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats/{farmBeatsResourceName}/extensions/{extensionId}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
farmBeatsResourceName:
{
Description: FarmBeats resource name. ,
Required: True ,
}
string ,
extensionId:
{
Description: Id of extension resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Extensions_ListByFarmBeats (new)
Description :  Get installed extensions details.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats/{farmBeatsResourceName}/extensions
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
farmBeatsResourceName:
{
Description: FarmBeats resource name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
extensionIds:
{
Description: Installed extension ids. ,
Required: False ,
}
array ,
extensionCategories:
{
Description: Installed extension categories. ,
Required: False ,
}
array ,
$maxPageSize:
{
Description: Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50. ,
Format: int32 ,
Required: False ,
}
integer ,
$skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: False ,
}
[
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Extension resource properties. ,
Required: False ,
}
{
extensionId:
{
Description: Extension Id. ,
Required: False ,
}
string ,
extensionCategory:
{
Description: Extension category. e.g. weather/sensor/satellite. ,
Required: False ,
}
string ,
installedExtensionVersion:
{
Description: Installed extension version. ,
Required: False ,
}
string ,
extensionAuthLink:
{
Description: Extension auth link. ,
Required: False ,
}
string ,
extensionApiDocsLink:
{
Description: Extension api docs link. ,
Required: False ,
}
string ,
additionalApiProperties:
{
Description: Additional api properties. ,
Required: False ,
}
object ,
}
,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FarmBeatsExtensions_List (new)
Description :  Get list of farmBeats extension.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.AgFoodPlatform/farmBeatsExtensionDefinitions
{
farmBeatsExtensionIds:
{
Description: FarmBeatsExtension ids. ,
Required: False ,
}
array ,
farmBeatsExtensionNames:
{
Description: FarmBeats extension names. ,
Required: False ,
}
array ,
extensionCategories:
{
Description: Extension categories. ,
Required: False ,
}
array ,
publisherIds:
{
Description: Publisher ids. ,
Required: False ,
}
array ,
$maxPageSize:
{
Description: Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: False ,
}
[
{
properties:
{
Description: FarmBeatsExtension properties. ,
Required: False ,
}
{
targetResourceType:
{
Description: Target ResourceType of the farmBeatsExtension. ,
Required: False ,
}
string ,
farmBeatsExtensionId:
{
Description: FarmBeatsExtension ID. ,
Required: False ,
}
string ,
farmBeatsExtensionName:
{
Description: FarmBeatsExtension name. ,
Required: False ,
}
string ,
farmBeatsExtensionVersion:
{
Description: FarmBeatsExtension version. ,
Required: False ,
}
string ,
publisherId:
{
Description: Publisher ID. ,
Required: False ,
}
string ,
description:
{
Description: Textual description. ,
Required: False ,
}
string ,
extensionCategory:
{
Description: Category of the extension. e.g. weather/sensor/satellite. ,
Required: False ,
}
string ,
extensionAuthLink:
{
Description: FarmBeatsExtension auth link. ,
Required: False ,
}
string ,
extensionApiDocsLink:
{
Description: FarmBeatsExtension api docs link. ,
Required: False ,
}
string ,
detailedInformation:
{
Description: Detailed information which shows summary of requested data. Used in descriptive get extension metadata call. Information for weather category per api included are apisSupported, customParameters, PlatformParameters and Units supported. ,
Required: False ,
}
[
{
apiName:
{
Description: ApiName available for the farmBeatsExtension. ,
Required: False ,
}
string ,
customParameters:
{
Description: List of customParameters. ,
Required: False ,
}
[
string ,
]
,
platformParameters:
{
Description: List of platformParameters. ,
Required: False ,
}
[
string ,
]
,
unitsSupported:
{
Description: Unit systems info for the data provider. ,
Required: False ,
}
{
key:
{
Description: UnitSystem key sent as part of ProviderInput. ,
Required: True ,
}
string ,
values:
{
Description: List of unit systems supported by this data provider. ,
Required: True ,
}
[
string ,
]
,
}
,
apiInputParameters:
{
Description: List of apiInputParameters. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FarmBeatsExtensions_Get (new)
Description :  Get farmBeats extension.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.AgFoodPlatform/farmBeatsExtensionDefinitions/{farmBeatsExtensionId}
{
farmBeatsExtensionId:
{
Description: farmBeatsExtensionId to be queried. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: FarmBeatsExtension properties. ,
Required: False ,
}
{
targetResourceType:
{
Description: Target ResourceType of the farmBeatsExtension. ,
Required: False ,
}
string ,
farmBeatsExtensionId:
{
Description: FarmBeatsExtension ID. ,
Required: False ,
}
string ,
farmBeatsExtensionName:
{
Description: FarmBeatsExtension name. ,
Required: False ,
}
string ,
farmBeatsExtensionVersion:
{
Description: FarmBeatsExtension version. ,
Required: False ,
}
string ,
publisherId:
{
Description: Publisher ID. ,
Required: False ,
}
string ,
description:
{
Description: Textual description. ,
Required: False ,
}
string ,
extensionCategory:
{
Description: Category of the extension. e.g. weather/sensor/satellite. ,
Required: False ,
}
string ,
extensionAuthLink:
{
Description: FarmBeatsExtension auth link. ,
Required: False ,
}
string ,
extensionApiDocsLink:
{
Description: FarmBeatsExtension api docs link. ,
Required: False ,
}
string ,
detailedInformation:
{
Description: Detailed information which shows summary of requested data. Used in descriptive get extension metadata call. Information for weather category per api included are apisSupported, customParameters, PlatformParameters and Units supported. ,
Required: False ,
}
[
{
apiName:
{
Description: ApiName available for the farmBeatsExtension. ,
Required: False ,
}
string ,
customParameters:
{
Description: List of customParameters. ,
Required: False ,
}
[
string ,
]
,
platformParameters:
{
Description: List of platformParameters. ,
Required: False ,
}
[
string ,
]
,
unitsSupported:
{
Description: Unit systems info for the data provider. ,
Required: False ,
}
{
key:
{
Description: UnitSystem key sent as part of ProviderInput. ,
Required: True ,
}
string ,
values:
{
Description: List of unit systems supported by this data provider. ,
Required: True ,
}
[
string ,
]
,
}
,
apiInputParameters:
{
Description: List of apiInputParameters. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FarmBeatsModels_Get (new)
Description :  Get FarmBeats resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats/{farmBeatsResourceName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
farmBeatsResourceName:
{
Description: FarmBeats resource name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. The value must be an UUID. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. The value must be an UUID. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: FarmBeats ARM Resource properties. ,
Required: False ,
}
{
instanceUri:
{
Description: Uri of the FarmBeats instance. ,
Format: uri ,
Required: False ,
}
string ,
provisioningState:
{
Description: FarmBeats instance provisioning state. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
sensorIntegration:
{
Description: Sensor integration request model. ,
Required: False ,
}
{
enabled:
{
Description: Sensor integration enable state. Allowed values are True, None ,
Required: False ,
}
string ,
provisioningState:
{
Description: Sensor integration instance provisioning state. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningInfo:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). ,
Required: False ,
}
{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}
,
publicNetworkAccess:
{
Description: Property to allow or block public traffic for an Azure FarmBeats resource. ,
Enum:
{
Enabled: No description available. ,
Hybrid: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: The private endpoint connection resource. ,
Required: False ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FarmBeatsModels_CreateOrUpdate (new)
Description :  Create or update FarmBeats resource.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats/{farmBeatsResourceName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
farmBeatsResourceName:
{
Description: FarmBeats resource name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: FarmBeats resource create or update request object. ,
Required: True ,
}
{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. The value must be an UUID. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. The value must be an UUID. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: FarmBeats ARM Resource properties. ,
Required: False ,
}
{
instanceUri:
{
Description: Uri of the FarmBeats instance. ,
Format: uri ,
Required: False ,
}
string ,
provisioningState:
{
Description: FarmBeats instance provisioning state. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
sensorIntegration:
{
Description: Sensor integration request model. ,
Required: False ,
}
{
enabled:
{
Description: Sensor integration enable state. Allowed values are True, None ,
Required: False ,
}
string ,
provisioningState:
{
Description: Sensor integration instance provisioning state. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningInfo:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). ,
Required: False ,
}
{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}
,
publicNetworkAccess:
{
Description: Property to allow or block public traffic for an Azure FarmBeats resource. ,
Enum:
{
Enabled: No description available. ,
Hybrid: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: The private endpoint connection resource. ,
Required: False ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
}
,
}

⚐ Response (200)

{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. The value must be an UUID. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. The value must be an UUID. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: FarmBeats ARM Resource properties. ,
Required: False ,
}
{
instanceUri:
{
Description: Uri of the FarmBeats instance. ,
Format: uri ,
Required: False ,
}
string ,
provisioningState:
{
Description: FarmBeats instance provisioning state. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
sensorIntegration:
{
Description: Sensor integration request model. ,
Required: False ,
}
{
enabled:
{
Description: Sensor integration enable state. Allowed values are True, None ,
Required: False ,
}
string ,
provisioningState:
{
Description: Sensor integration instance provisioning state. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningInfo:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). ,
Required: False ,
}
{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}
,
publicNetworkAccess:
{
Description: Property to allow or block public traffic for an Azure FarmBeats resource. ,
Enum:
{
Enabled: No description available. ,
Hybrid: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: The private endpoint connection resource. ,
Required: False ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
}

⚐ Response (201)

{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. The value must be an UUID. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. The value must be an UUID. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: FarmBeats ARM Resource properties. ,
Required: False ,
}
{
instanceUri:
{
Description: Uri of the FarmBeats instance. ,
Format: uri ,
Required: False ,
}
string ,
provisioningState:
{
Description: FarmBeats instance provisioning state. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
sensorIntegration:
{
Description: Sensor integration request model. ,
Required: False ,
}
{
enabled:
{
Description: Sensor integration enable state. Allowed values are True, None ,
Required: False ,
}
string ,
provisioningState:
{
Description: Sensor integration instance provisioning state. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningInfo:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). ,
Required: False ,
}
{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}
,
publicNetworkAccess:
{
Description: Property to allow or block public traffic for an Azure FarmBeats resource. ,
Enum:
{
Enabled: No description available. ,
Hybrid: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: The private endpoint connection resource. ,
Required: False ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FarmBeatsModels_Update (new)
Description :  Update a FarmBeats resource.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats/{farmBeatsResourceName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
farmBeatsResourceName:
{
Description: FarmBeats resource name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Request object. ,
Required: True ,
}
{
location:
{
Description: Geo-location where the resource lives. ,
Required: False ,
}
string ,
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. The value must be an UUID. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. The value must be an UUID. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: FarmBeats ARM Resource properties. ,
Required: False ,
}
{
sensorIntegration:
{
Description: Sensor integration request model. ,
Required: False ,
}
{
enabled:
{
Description: Sensor integration enable state. Allowed values are True, None ,
Required: False ,
}
string ,
provisioningState:
{
Description: Sensor integration instance provisioning state. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningInfo:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). ,
Required: False ,
}
{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}
,
publicNetworkAccess:
{
Description: Property to allow or block public traffic for an Azure FarmBeats resource. ,
Enum:
{
Enabled: No description available. ,
Hybrid: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. The value must be an UUID. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. The value must be an UUID. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: FarmBeats ARM Resource properties. ,
Required: False ,
}
{
instanceUri:
{
Description: Uri of the FarmBeats instance. ,
Format: uri ,
Required: False ,
}
string ,
provisioningState:
{
Description: FarmBeats instance provisioning state. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
sensorIntegration:
{
Description: Sensor integration request model. ,
Required: False ,
}
{
enabled:
{
Description: Sensor integration enable state. Allowed values are True, None ,
Required: False ,
}
string ,
provisioningState:
{
Description: Sensor integration instance provisioning state. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningInfo:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). ,
Required: False ,
}
{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}
,
publicNetworkAccess:
{
Description: Property to allow or block public traffic for an Azure FarmBeats resource. ,
Enum:
{
Enabled: No description available. ,
Hybrid: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: The private endpoint connection resource. ,
Required: False ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FarmBeatsModels_Delete (new)
Description :  Delete a FarmBeats resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats/{farmBeatsResourceName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
farmBeatsResourceName:
{
Description: FarmBeats resource name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FarmBeatsModels_ListBySubscription (new)
Description :  Lists the FarmBeats instances for a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AgFoodPlatform/farmBeats
{
$maxPageSize:
{
Description: Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50. ,
Format: int32 ,
Required: False ,
}
integer ,
$skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: False ,
}
[
{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. The value must be an UUID. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. The value must be an UUID. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: FarmBeats ARM Resource properties. ,
Required: False ,
}
{
instanceUri:
{
Description: Uri of the FarmBeats instance. ,
Format: uri ,
Required: False ,
}
string ,
provisioningState:
{
Description: FarmBeats instance provisioning state. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
sensorIntegration:
{
Description: Sensor integration request model. ,
Required: False ,
}
{
enabled:
{
Description: Sensor integration enable state. Allowed values are True, None ,
Required: False ,
}
string ,
provisioningState:
{
Description: Sensor integration instance provisioning state. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningInfo:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). ,
Required: False ,
}
{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}
,
publicNetworkAccess:
{
Description: Property to allow or block public traffic for an Azure FarmBeats resource. ,
Enum:
{
Enabled: No description available. ,
Hybrid: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: The private endpoint connection resource. ,
Required: False ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FarmBeatsModels_ListByResourceGroup (new)
Description :  Lists the FarmBeats instances for a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats
{
$maxPageSize:
{
Description: Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50. ,
Format: int32 ,
Required: False ,
}
integer ,
$skipToken:
{
Description: Continuation token for getting next set of results. ,
Required: False ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: False ,
}
[
{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. The value must be an UUID. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. The value must be an UUID. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: FarmBeats ARM Resource properties. ,
Required: False ,
}
{
instanceUri:
{
Description: Uri of the FarmBeats instance. ,
Format: uri ,
Required: False ,
}
string ,
provisioningState:
{
Description: FarmBeats instance provisioning state. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
sensorIntegration:
{
Description: Sensor integration request model. ,
Required: False ,
}
{
enabled:
{
Description: Sensor integration enable state. Allowed values are True, None ,
Required: False ,
}
string ,
provisioningState:
{
Description: Sensor integration instance provisioning state. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningInfo:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). ,
Required: False ,
}
{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}
,
publicNetworkAccess:
{
Description: Property to allow or block public traffic for an Azure FarmBeats resource. ,
Enum:
{
Enabled: No description available. ,
Hybrid: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: The private endpoint connection resource. ,
Required: False ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
OperationResults_Get (new)
Description :  Get operationResults for a FarmBeats resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AgFoodPlatform/locations/{locations}/operationResults/{operationResultsId}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
locations:
{
Description: Location. ,
Required: True ,
}
string ,
operationResultsId:
{
Description: operation Results Id. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
status:
{
Description: Status of the async operation. ,
Required: False ,
}
string ,
error:
{
Description: Arm async operation error class. Ref: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/async-api-reference.md#azure-asyncoperation-resource-format. ,
Required: False ,
}
{
code:
{
Description: Status of the async operation. ,
Required: False ,
}
string ,
message:
{
Description: Status of the async operation. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Locations_CheckNameAvailability (new)
Description :  Checks the name availability of the resource with requested resource name.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.AgFoodPlatform/checkNameAvailability
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: NameAvailabilityRequest object. ,
Required: True ,
}
{
name:
{
Description: The name of the resource for which availability needs to be checked. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
nameAvailable:
{
Description: Indicates if the resource name is available. ,
Required: False ,
}
boolean ,
reason:
{
Description: The reason why the given name is not available. ,
Enum:
{
Invalid: No description available. ,
AlreadyExists: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Detailed reason why the given name is available. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Operations_List (new)
Description :  Lists the available operations of Microsoft.AgFoodPlatform resource provider.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.AgFoodPlatform/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_CreateOrUpdate (new)
Description :  Approves or Rejects a Private endpoint connection request.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats/{farmBeatsResourceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
farmBeatsResourceName:
{
Description: FarmBeats resource name. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: Private endpoint connection name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Request object. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_Get (new)
Description :  Get Private endpoint connection object.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats/{farmBeatsResourceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
farmBeatsResourceName:
{
Description: FarmBeats resource name. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: Private endpoint connection name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (404)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_Delete (new)
Description :  Delete Private endpoint connection request.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats/{farmBeatsResourceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
farmBeatsResourceName:
{
Description: FarmBeats resource name. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: Private endpoint connection name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_ListByResource (new)
Description :  Get list of Private endpoint connections.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats/{farmBeatsResourceName}/privateEndpointConnections
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
farmBeatsResourceName:
{
Description: FarmBeats resource name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateLinkResources_ListByResource (new)
Description :  Get list of Private link resources.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats/{farmBeatsResourceName}/privateLinkResources
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
farmBeatsResourceName:
{
Description: FarmBeats resource name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of private link resources ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupId:
{
Description: The private link resource group id. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The private link resource required member names. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The private link resource private link DNS zone name. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateLinkResources_Get (new)
Description :  Get Private link resource object.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats/{farmBeatsResourceName}/privateLinkResources/{subResourceName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
farmBeatsResourceName:
{
Description: FarmBeats resource name. ,
Required: True ,
}
string ,
subResourceName:
{
Description: Sub resource name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupId:
{
Description: The private link resource group id. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The private link resource required member names. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The private link resource private link DNS zone name. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (404)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Solutions_CreateOrUpdate (new)
Description :  Install Or Update Solution.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats/{farmBeatsResourceName}/solutions/{solutionId}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
farmBeatsResourceName:
{
Description: FarmBeats resource name. ,
Required: True ,
}
string ,
solutionId:
{
Description: Solution Id of the solution. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Solution resource request body. ,
Required: False ,
}
{
properties:
{
Description: Solution resource properties. ,
Required: False ,
}
{
solutionId:
{
Description: Solution Id. ,
Required: False ,
}
string ,
partnerId:
{
Description: Partner Id of the Solution. ,
Required: False ,
}
string ,
saasSubscriptionId:
{
Description: SaaS subscriptionId of the installed SaaS application. ,
Required: True ,
}
string ,
saasSubscriptionName:
{
Description: SaaS subscription name of the installed SaaS application. ,
Required: True ,
}
string ,
marketplacePublisherId:
{
Description: SaaS application Publisher Id. ,
Required: True ,
}
string ,
planId:
{
Description: SaaS application Plan Id. ,
Required: True ,
}
string ,
offerId:
{
Description: SaaS application Offer Id. ,
Required: True ,
}
string ,
termId:
{
Description: SaaS application Term Id. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Solution resource properties. ,
Required: False ,
}
{
solutionId:
{
Description: Solution Id. ,
Required: False ,
}
string ,
partnerId:
{
Description: Partner Id of the Solution. ,
Required: False ,
}
string ,
saasSubscriptionId:
{
Description: SaaS subscriptionId of the installed SaaS application. ,
Required: True ,
}
string ,
saasSubscriptionName:
{
Description: SaaS subscription name of the installed SaaS application. ,
Required: True ,
}
string ,
marketplacePublisherId:
{
Description: SaaS application Publisher Id. ,
Required: True ,
}
string ,
planId:
{
Description: SaaS application Plan Id. ,
Required: True ,
}
string ,
offerId:
{
Description: SaaS application Offer Id. ,
Required: True ,
}
string ,
termId:
{
Description: SaaS application Term Id. ,
Required: True ,
}
string ,
}
,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Solution resource properties. ,
Required: False ,
}
{
solutionId:
{
Description: Solution Id. ,
Required: False ,
}
string ,
partnerId:
{
Description: Partner Id of the Solution. ,
Required: False ,
}
string ,
saasSubscriptionId:
{
Description: SaaS subscriptionId of the installed SaaS application. ,
Required: True ,
}
string ,
saasSubscriptionName:
{
Description: SaaS subscription name of the installed SaaS application. ,
Required: True ,
}
string ,
marketplacePublisherId:
{
Description: SaaS application Publisher Id. ,
Required: True ,
}
string ,
planId:
{
Description: SaaS application Plan Id. ,
Required: True ,
}
string ,
offerId:
{
Description: SaaS application Offer Id. ,
Required: True ,
}
string ,
termId:
{
Description: SaaS application Term Id. ,
Required: True ,
}
string ,
}
,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Solutions_Get (new)
Description :  Get installed Solution details by Solution id.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats/{farmBeatsResourceName}/solutions/{solutionId}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
farmBeatsResourceName:
{
Description: FarmBeats resource name. ,
Required: True ,
}
string ,
solutionId:
{
Description: Solution Id of the solution. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Solution resource properties. ,
Required: False ,
}
{
solutionId:
{
Description: Solution Id. ,
Required: False ,
}
string ,
partnerId:
{
Description: Partner Id of the Solution. ,
Required: False ,
}
string ,
saasSubscriptionId:
{
Description: SaaS subscriptionId of the installed SaaS application. ,
Required: True ,
}
string ,
saasSubscriptionName:
{
Description: SaaS subscription name of the installed SaaS application. ,
Required: True ,
}
string ,
marketplacePublisherId:
{
Description: SaaS application Publisher Id. ,
Required: True ,
}
string ,
planId:
{
Description: SaaS application Plan Id. ,
Required: True ,
}
string ,
offerId:
{
Description: SaaS application Offer Id. ,
Required: True ,
}
string ,
termId:
{
Description: SaaS application Term Id. ,
Required: True ,
}
string ,
}
,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Solutions_Delete (new)
Description :  Uninstall Solution.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats/{farmBeatsResourceName}/solutions/{solutionId}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
farmBeatsResourceName:
{
Description: FarmBeats resource name. ,
Required: True ,
}
string ,
solutionId:
{
Description: Solution Id of the solution. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Solutions_List (new)
Description :  Get installed Solutions details.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats/{farmBeatsResourceName}/solutions
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
farmBeatsResourceName:
{
Description: FarmBeats resource name. ,
Required: True ,
}
string ,
solutionIds:
{
Description: Installed Solution ids. ,
Required: False ,
}
array ,
ids:
{
Description: Ids of the resource. ,
Required: False ,
}
array ,
names:
{
Description: Names of the resource. ,
Required: False ,
}
array ,
propertyFilters:
{
Description: Filters on key-value pairs within the Properties object. eg. "{testKey} eq {testValue}". ,
Required: False ,
}
array ,
statuses:
{
Description: Statuses of the resource. ,
Required: False ,
}
array ,
minCreatedDateTime:
{
Description: Minimum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxCreatedDateTime:
{
Description: Maximum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
minLastModifiedDateTime:
{
Description: Minimum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxLastModifiedDateTime:
{
Description: Maximum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
$maxPageSize:
{
Description: Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50. ,
Format: int32 ,
Required: False ,
}
integer ,
$skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: False ,
}
[
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Solution resource properties. ,
Required: False ,
}
{
solutionId:
{
Description: Solution Id. ,
Required: False ,
}
string ,
partnerId:
{
Description: Partner Id of the Solution. ,
Required: False ,
}
string ,
saasSubscriptionId:
{
Description: SaaS subscriptionId of the installed SaaS application. ,
Required: True ,
}
string ,
saasSubscriptionName:
{
Description: SaaS subscription name of the installed SaaS application. ,
Required: True ,
}
string ,
marketplacePublisherId:
{
Description: SaaS application Publisher Id. ,
Required: True ,
}
string ,
planId:
{
Description: SaaS application Plan Id. ,
Required: True ,
}
string ,
offerId:
{
Description: SaaS application Offer Id. ,
Required: True ,
}
string ,
termId:
{
Description: SaaS application Term Id. ,
Required: True ,
}
string ,
}
,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
}
,
]
,
$skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SolutionsDiscoverability_List (new)
Description :  Get list of farmBeats solutions.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.AgFoodPlatform/farmBeatsSolutionDefinitions
{
farmBeatsSolutionIds:
{
Description: Ids of FarmBeats Solutions which the customer requests to fetch. ,
Required: False ,
}
array ,
farmBeatsSolutionNames:
{
Description: Names of FarmBeats Solutions which the customer requests to fetch. ,
Required: False ,
}
array ,
$maxPageSize:
{
Description: Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: False ,
}
[
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: FarmBeatsSolution properties. ,
Required: False ,
}
{
partnerId:
{
Description: Solution Partner Id. ,
Required: False ,
}
string ,
partnerTenantId:
{
Description: Solution Partner Tenant Id. ,
Required: False ,
}
string ,
dataAccessScopes:
{
Description: Gets scope of the FarmBeats data access that's required for processing solution request to partner. Example: For gdd they might need weatherScope and satelliteScope. ,
Required: False ,
}
[
string ,
]
,
marketplaceOfferDetails:
{
Required: False ,
}
{
saasOfferId:
{
Required: False ,
}
string ,
publisherId:
{
Required: False ,
}
string ,
}
,
inputParametersValidationScopes:
{
Description: Gets scope of the FarmBeats related parameters that need to be validated in apiInputParameters. Example: For if 'FarmHierarchy' is the input scope for 'WeatherScope' data access For working with WeatherScope we need FarmHierarchy info implies 'farmerId', 'resourceId', 'resourceType' in request body. ,
Required: False ,
}
[
{
resourceIdName:
{
Required: False ,
}
string ,
resourceType:
{
Required: False ,
}
string ,
}
,
]
,
openApiSpecsDictionary:
{
Description: Gets apiVersion: Swagger Document Dictionary to capture all api versions of swagger exposed by partner to farmbeats. ,
Required: False ,
}
object ,
evaluatedOutputsDictionary:
{
Description: Gets example name: insight sample response Dictionary to capture all variations of computed results ingested by partner. ,
Required: False ,
}
object ,
accessFBApplicationId:
{
Description: Application id of the multi tenant application to be used by partner to access FarmBeats data. ,
Format: uuid ,
Required: False ,
}
string ,
saaSApplicationId:
{
Description: Application id of the SaaS multi tenant application. ,
Format: uuid ,
Required: False ,
}
string ,
actionIds:
{
Description: List of ActionIds needed to make the SaaS multi tenant application access relevant fb data. ,
Required: False ,
}
[
string ,
]
,
roleId:
{
Description: Role Id of the SaaS multi tenant application to access relevant fb data. ,
Required: False ,
}
string ,
roleName:
{
Description: Role Name of the SaaS multi tenant application to access relevant fb data. ,
Required: False ,
}
string ,
accessFBApplicationName:
{
Description: Application name of the multi tenant application to be used by partner to access FarmBeatsData. ,
Required: False ,
}
string ,
}
,
}
,
]
,
$skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SolutionsDiscoverability_Get (new)
Description :  Get farmBeats solution by id.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.AgFoodPlatform/farmBeatsSolutionDefinitions/{farmBeatsSolutionId}
{
farmBeatsSolutionId:
{
Description: farmBeatsSolutionId to be queried. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: FarmBeatsSolution properties. ,
Required: False ,
}
{
partnerId:
{
Description: Solution Partner Id. ,
Required: False ,
}
string ,
partnerTenantId:
{
Description: Solution Partner Tenant Id. ,
Required: False ,
}
string ,
dataAccessScopes:
{
Description: Gets scope of the FarmBeats data access that's required for processing solution request to partner. Example: For gdd they might need weatherScope and satelliteScope. ,
Required: False ,
}
[
string ,
]
,
marketplaceOfferDetails:
{
Required: False ,
}
{
saasOfferId:
{
Required: False ,
}
string ,
publisherId:
{
Required: False ,
}
string ,
}
,
inputParametersValidationScopes:
{
Description: Gets scope of the FarmBeats related parameters that need to be validated in apiInputParameters. Example: For if 'FarmHierarchy' is the input scope for 'WeatherScope' data access For working with WeatherScope we need FarmHierarchy info implies 'farmerId', 'resourceId', 'resourceType' in request body. ,
Required: False ,
}
[
{
resourceIdName:
{
Required: False ,
}
string ,
resourceType:
{
Required: False ,
}
string ,
}
,
]
,
openApiSpecsDictionary:
{
Description: Gets apiVersion: Swagger Document Dictionary to capture all api versions of swagger exposed by partner to farmbeats. ,
Required: False ,
}
object ,
evaluatedOutputsDictionary:
{
Description: Gets example name: insight sample response Dictionary to capture all variations of computed results ingested by partner. ,
Required: False ,
}
object ,
accessFBApplicationId:
{
Description: Application id of the multi tenant application to be used by partner to access FarmBeats data. ,
Format: uuid ,
Required: False ,
}
string ,
saaSApplicationId:
{
Description: Application id of the SaaS multi tenant application. ,
Format: uuid ,
Required: False ,
}
string ,
actionIds:
{
Description: List of ActionIds needed to make the SaaS multi tenant application access relevant fb data. ,
Required: False ,
}
[
string ,
]
,
roleId:
{
Description: Role Id of the SaaS multi tenant application to access relevant fb data. ,
Required: False ,
}
string ,
roleName:
{
Description: Role Name of the SaaS multi tenant application to access relevant fb data. ,
Required: False ,
}
string ,
accessFBApplicationName:
{
Description: Application name of the multi tenant application to be used by partner to access FarmBeatsData. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Extensions_CreateOrUpdate (removed)
Description :  Install or Update extension. AdditionalApiProperties are merged patch and if the extension is updated to a new version then the obsolete entries will be auto deleted from AdditionalApiProperties.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats/{farmBeatsResourceName}/extensions/{extensionId}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
farmBeatsResourceName:
{
Description: FarmBeats resource name. ,
Required: True ,
}
string ,
extensionId:
{
Description: Id of extension resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
requestBody:
{
Description: Extension resource request body. ,
Required: False ,
}
{
extensionVersion:
{
Description: Extension Version. ,
Required: False ,
}
string ,
additionalApiProperties:
{
Description: Additional Api Properties. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Extension resource properties. ,
Required: False ,
}
{
extensionId:
{
Description: Extension Id. ,
Required: False ,
}
string ,
extensionCategory:
{
Description: Extension category. e.g. weather/sensor/satellite. ,
Required: False ,
}
string ,
installedExtensionVersion:
{
Description: Installed extension version. ,
Required: False ,
}
string ,
extensionAuthLink:
{
Description: Extension auth link. ,
Required: False ,
}
string ,
extensionApiDocsLink:
{
Description: Extension api docs link. ,
Required: False ,
}
string ,
additionalApiProperties:
{
Description: Additional api properties. ,
Required: False ,
}
object ,
}
,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Extension resource properties. ,
Required: False ,
}
{
extensionId:
{
Description: Extension Id. ,
Required: False ,
}
string ,
extensionCategory:
{
Description: Extension category. e.g. weather/sensor/satellite. ,
Required: False ,
}
string ,
installedExtensionVersion:
{
Description: Installed extension version. ,
Required: False ,
}
string ,
extensionAuthLink:
{
Description: Extension auth link. ,
Required: False ,
}
string ,
extensionApiDocsLink:
{
Description: Extension api docs link. ,
Required: False ,
}
string ,
additionalApiProperties:
{
Description: Additional api properties. ,
Required: False ,
}
object ,
}
,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Extensions_Get (removed)
Description :  Get installed extension details by extension id.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats/{farmBeatsResourceName}/extensions/{extensionId}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
farmBeatsResourceName:
{
Description: FarmBeats resource name. ,
Required: True ,
}
string ,
extensionId:
{
Description: Id of extension resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Extension resource properties. ,
Required: False ,
}
{
extensionId:
{
Description: Extension Id. ,
Required: False ,
}
string ,
extensionCategory:
{
Description: Extension category. e.g. weather/sensor/satellite. ,
Required: False ,
}
string ,
installedExtensionVersion:
{
Description: Installed extension version. ,
Required: False ,
}
string ,
extensionAuthLink:
{
Description: Extension auth link. ,
Required: False ,
}
string ,
extensionApiDocsLink:
{
Description: Extension api docs link. ,
Required: False ,
}
string ,
additionalApiProperties:
{
Description: Additional api properties. ,
Required: False ,
}
object ,
}
,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Extensions_Delete (removed)
Description :  Uninstall extension.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats/{farmBeatsResourceName}/extensions/{extensionId}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
farmBeatsResourceName:
{
Description: FarmBeats resource name. ,
Required: True ,
}
string ,
extensionId:
{
Description: Id of extension resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Extensions_ListByFarmBeats (removed)
Description :  Get installed extensions details.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats/{farmBeatsResourceName}/extensions
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
farmBeatsResourceName:
{
Description: FarmBeats resource name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
extensionIds:
{
Description: Installed extension ids. ,
Required: False ,
}
array ,
extensionCategories:
{
Description: Installed extension categories. ,
Required: False ,
}
array ,
$maxPageSize:
{
Description: Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50. ,
Format: int32 ,
Required: False ,
}
integer ,
$skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: False ,
}
[
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Extension resource properties. ,
Required: False ,
}
{
extensionId:
{
Description: Extension Id. ,
Required: False ,
}
string ,
extensionCategory:
{
Description: Extension category. e.g. weather/sensor/satellite. ,
Required: False ,
}
string ,
installedExtensionVersion:
{
Description: Installed extension version. ,
Required: False ,
}
string ,
extensionAuthLink:
{
Description: Extension auth link. ,
Required: False ,
}
string ,
extensionApiDocsLink:
{
Description: Extension api docs link. ,
Required: False ,
}
string ,
additionalApiProperties:
{
Description: Additional api properties. ,
Required: False ,
}
object ,
}
,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FarmBeatsExtensions_List (removed)
Description :  Get list of farmBeats extension.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.AgFoodPlatform/farmBeatsExtensionDefinitions
{
farmBeatsExtensionIds:
{
Description: FarmBeatsExtension ids. ,
Required: False ,
}
array ,
farmBeatsExtensionNames:
{
Description: FarmBeats extension names. ,
Required: False ,
}
array ,
extensionCategories:
{
Description: Extension categories. ,
Required: False ,
}
array ,
publisherIds:
{
Description: Publisher ids. ,
Required: False ,
}
array ,
$maxPageSize:
{
Description: Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: False ,
}
[
{
properties:
{
Description: FarmBeatsExtension properties. ,
Required: False ,
}
{
targetResourceType:
{
Description: Target ResourceType of the farmBeatsExtension. ,
Required: False ,
}
string ,
farmBeatsExtensionId:
{
Description: FarmBeatsExtension ID. ,
Required: False ,
}
string ,
farmBeatsExtensionName:
{
Description: FarmBeatsExtension name. ,
Required: False ,
}
string ,
farmBeatsExtensionVersion:
{
Description: FarmBeatsExtension version. ,
Required: False ,
}
string ,
publisherId:
{
Description: Publisher ID. ,
Required: False ,
}
string ,
description:
{
Description: Textual description. ,
Required: False ,
}
string ,
extensionCategory:
{
Description: Category of the extension. e.g. weather/sensor/satellite. ,
Required: False ,
}
string ,
extensionAuthLink:
{
Description: FarmBeatsExtension auth link. ,
Required: False ,
}
string ,
extensionApiDocsLink:
{
Description: FarmBeatsExtension api docs link. ,
Required: False ,
}
string ,
detailedInformation:
{
Description: Detailed information which shows summary of requested data. Used in descriptive get extension metadata call. Information for weather category per api included are apisSupported, customParameters, PlatformParameters and Units supported. ,
Required: False ,
}
[
{
apiName:
{
Description: ApiName available for the farmBeatsExtension. ,
Required: False ,
}
string ,
customParameters:
{
Description: List of customParameters. ,
Required: False ,
}
[
string ,
]
,
platformParameters:
{
Description: List of platformParameters. ,
Required: False ,
}
[
string ,
]
,
unitsSupported:
{
Description: Unit systems info for the data provider. ,
Required: False ,
}
{
key:
{
Description: UnitSystem key sent as part of ProviderInput. ,
Required: True ,
}
string ,
values:
{
Description: List of unit systems supported by this data provider. ,
Required: True ,
}
[
string ,
]
,
}
,
apiInputParameters:
{
Description: List of apiInputParameters. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FarmBeatsExtensions_Get (removed)
Description :  Get farmBeats extension.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.AgFoodPlatform/farmBeatsExtensionDefinitions/{farmBeatsExtensionId}
{
farmBeatsExtensionId:
{
Description: farmBeatsExtensionId to be queried. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: FarmBeatsExtension properties. ,
Required: False ,
}
{
targetResourceType:
{
Description: Target ResourceType of the farmBeatsExtension. ,
Required: False ,
}
string ,
farmBeatsExtensionId:
{
Description: FarmBeatsExtension ID. ,
Required: False ,
}
string ,
farmBeatsExtensionName:
{
Description: FarmBeatsExtension name. ,
Required: False ,
}
string ,
farmBeatsExtensionVersion:
{
Description: FarmBeatsExtension version. ,
Required: False ,
}
string ,
publisherId:
{
Description: Publisher ID. ,
Required: False ,
}
string ,
description:
{
Description: Textual description. ,
Required: False ,
}
string ,
extensionCategory:
{
Description: Category of the extension. e.g. weather/sensor/satellite. ,
Required: False ,
}
string ,
extensionAuthLink:
{
Description: FarmBeatsExtension auth link. ,
Required: False ,
}
string ,
extensionApiDocsLink:
{
Description: FarmBeatsExtension api docs link. ,
Required: False ,
}
string ,
detailedInformation:
{
Description: Detailed information which shows summary of requested data. Used in descriptive get extension metadata call. Information for weather category per api included are apisSupported, customParameters, PlatformParameters and Units supported. ,
Required: False ,
}
[
{
apiName:
{
Description: ApiName available for the farmBeatsExtension. ,
Required: False ,
}
string ,
customParameters:
{
Description: List of customParameters. ,
Required: False ,
}
[
string ,
]
,
platformParameters:
{
Description: List of platformParameters. ,
Required: False ,
}
[
string ,
]
,
unitsSupported:
{
Description: Unit systems info for the data provider. ,
Required: False ,
}
{
key:
{
Description: UnitSystem key sent as part of ProviderInput. ,
Required: True ,
}
string ,
values:
{
Description: List of unit systems supported by this data provider. ,
Required: True ,
}
[
string ,
]
,
}
,
apiInputParameters:
{
Description: List of apiInputParameters. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FarmBeatsModels_Get (removed)
Description :  Get FarmBeats resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats/{farmBeatsResourceName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
farmBeatsResourceName:
{
Description: FarmBeats resource name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. The value must be an UUID. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. The value must be an UUID. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: FarmBeats ARM Resource properties. ,
Required: False ,
}
{
instanceUri:
{
Description: Uri of the FarmBeats instance. ,
Format: uri ,
Required: False ,
}
string ,
provisioningState:
{
Description: FarmBeats instance provisioning state. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
sensorIntegration:
{
Description: Sensor integration request model. ,
Required: False ,
}
{
enabled:
{
Description: Sensor integration enable state. Allowed values are True, None ,
Required: False ,
}
string ,
provisioningState:
{
Description: Sensor integration instance provisioning state. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningInfo:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). ,
Required: False ,
}
{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}
,
publicNetworkAccess:
{
Description: Property to allow or block public traffic for an Azure FarmBeats resource. ,
Enum:
{
Enabled: No description available. ,
Hybrid: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: The private endpoint connection resource. ,
Required: False ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FarmBeatsModels_CreateOrUpdate (removed)
Description :  Create or update FarmBeats resource.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats/{farmBeatsResourceName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
farmBeatsResourceName:
{
Description: FarmBeats resource name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: FarmBeats resource create or update request object. ,
Required: True ,
}
{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. The value must be an UUID. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. The value must be an UUID. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: FarmBeats ARM Resource properties. ,
Required: False ,
}
{
instanceUri:
{
Description: Uri of the FarmBeats instance. ,
Format: uri ,
Required: False ,
}
string ,
provisioningState:
{
Description: FarmBeats instance provisioning state. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
sensorIntegration:
{
Description: Sensor integration request model. ,
Required: False ,
}
{
enabled:
{
Description: Sensor integration enable state. Allowed values are True, None ,
Required: False ,
}
string ,
provisioningState:
{
Description: Sensor integration instance provisioning state. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningInfo:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). ,
Required: False ,
}
{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}
,
publicNetworkAccess:
{
Description: Property to allow or block public traffic for an Azure FarmBeats resource. ,
Enum:
{
Enabled: No description available. ,
Hybrid: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: The private endpoint connection resource. ,
Required: False ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
}
,
}

⚐ Response (200)

{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. The value must be an UUID. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. The value must be an UUID. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: FarmBeats ARM Resource properties. ,
Required: False ,
}
{
instanceUri:
{
Description: Uri of the FarmBeats instance. ,
Format: uri ,
Required: False ,
}
string ,
provisioningState:
{
Description: FarmBeats instance provisioning state. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
sensorIntegration:
{
Description: Sensor integration request model. ,
Required: False ,
}
{
enabled:
{
Description: Sensor integration enable state. Allowed values are True, None ,
Required: False ,
}
string ,
provisioningState:
{
Description: Sensor integration instance provisioning state. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningInfo:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). ,
Required: False ,
}
{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}
,
publicNetworkAccess:
{
Description: Property to allow or block public traffic for an Azure FarmBeats resource. ,
Enum:
{
Enabled: No description available. ,
Hybrid: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: The private endpoint connection resource. ,
Required: False ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
}

⚐ Response (201)

{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. The value must be an UUID. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. The value must be an UUID. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: FarmBeats ARM Resource properties. ,
Required: False ,
}
{
instanceUri:
{
Description: Uri of the FarmBeats instance. ,
Format: uri ,
Required: False ,
}
string ,
provisioningState:
{
Description: FarmBeats instance provisioning state. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
sensorIntegration:
{
Description: Sensor integration request model. ,
Required: False ,
}
{
enabled:
{
Description: Sensor integration enable state. Allowed values are True, None ,
Required: False ,
}
string ,
provisioningState:
{
Description: Sensor integration instance provisioning state. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningInfo:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). ,
Required: False ,
}
{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}
,
publicNetworkAccess:
{
Description: Property to allow or block public traffic for an Azure FarmBeats resource. ,
Enum:
{
Enabled: No description available. ,
Hybrid: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: The private endpoint connection resource. ,
Required: False ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FarmBeatsModels_Update (removed)
Description :  Update a FarmBeats resource.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats/{farmBeatsResourceName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
farmBeatsResourceName:
{
Description: FarmBeats resource name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Request object. ,
Required: True ,
}
{
location:
{
Description: Geo-location where the resource lives. ,
Required: False ,
}
string ,
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. The value must be an UUID. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. The value must be an UUID. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: FarmBeats ARM Resource properties. ,
Required: False ,
}
{
sensorIntegration:
{
Description: Sensor integration request model. ,
Required: False ,
}
{
enabled:
{
Description: Sensor integration enable state. Allowed values are True, None ,
Required: False ,
}
string ,
provisioningState:
{
Description: Sensor integration instance provisioning state. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningInfo:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). ,
Required: False ,
}
{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}
,
publicNetworkAccess:
{
Description: Property to allow or block public traffic for an Azure FarmBeats resource. ,
Enum:
{
Enabled: No description available. ,
Hybrid: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. The value must be an UUID. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. The value must be an UUID. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: FarmBeats ARM Resource properties. ,
Required: False ,
}
{
instanceUri:
{
Description: Uri of the FarmBeats instance. ,
Format: uri ,
Required: False ,
}
string ,
provisioningState:
{
Description: FarmBeats instance provisioning state. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
sensorIntegration:
{
Description: Sensor integration request model. ,
Required: False ,
}
{
enabled:
{
Description: Sensor integration enable state. Allowed values are True, None ,
Required: False ,
}
string ,
provisioningState:
{
Description: Sensor integration instance provisioning state. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningInfo:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). ,
Required: False ,
}
{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}
,
publicNetworkAccess:
{
Description: Property to allow or block public traffic for an Azure FarmBeats resource. ,
Enum:
{
Enabled: No description available. ,
Hybrid: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: The private endpoint connection resource. ,
Required: False ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FarmBeatsModels_Delete (removed)
Description :  Delete a FarmBeats resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats/{farmBeatsResourceName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
farmBeatsResourceName:
{
Description: FarmBeats resource name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FarmBeatsModels_ListBySubscription (removed)
Description :  Lists the FarmBeats instances for a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AgFoodPlatform/farmBeats
{
$maxPageSize:
{
Description: Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50. ,
Format: int32 ,
Required: False ,
}
integer ,
$skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: False ,
}
[
{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. The value must be an UUID. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. The value must be an UUID. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: FarmBeats ARM Resource properties. ,
Required: False ,
}
{
instanceUri:
{
Description: Uri of the FarmBeats instance. ,
Format: uri ,
Required: False ,
}
string ,
provisioningState:
{
Description: FarmBeats instance provisioning state. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
sensorIntegration:
{
Description: Sensor integration request model. ,
Required: False ,
}
{
enabled:
{
Description: Sensor integration enable state. Allowed values are True, None ,
Required: False ,
}
string ,
provisioningState:
{
Description: Sensor integration instance provisioning state. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningInfo:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). ,
Required: False ,
}
{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}
,
publicNetworkAccess:
{
Description: Property to allow or block public traffic for an Azure FarmBeats resource. ,
Enum:
{
Enabled: No description available. ,
Hybrid: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: The private endpoint connection resource. ,
Required: False ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FarmBeatsModels_ListByResourceGroup (removed)
Description :  Lists the FarmBeats instances for a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats
{
$maxPageSize:
{
Description: Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50. ,
Format: int32 ,
Required: False ,
}
integer ,
$skipToken:
{
Description: Continuation token for getting next set of results. ,
Required: False ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: False ,
}
[
{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. The value must be an UUID. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. The value must be an UUID. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: FarmBeats ARM Resource properties. ,
Required: False ,
}
{
instanceUri:
{
Description: Uri of the FarmBeats instance. ,
Format: uri ,
Required: False ,
}
string ,
provisioningState:
{
Description: FarmBeats instance provisioning state. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
sensorIntegration:
{
Description: Sensor integration request model. ,
Required: False ,
}
{
enabled:
{
Description: Sensor integration enable state. Allowed values are True, None ,
Required: False ,
}
string ,
provisioningState:
{
Description: Sensor integration instance provisioning state. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningInfo:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). ,
Required: False ,
}
{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}
,
publicNetworkAccess:
{
Description: Property to allow or block public traffic for an Azure FarmBeats resource. ,
Enum:
{
Enabled: No description available. ,
Hybrid: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: The private endpoint connection resource. ,
Required: False ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
OperationResults_Get (removed)
Description :  Get operationResults for a FarmBeats resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AgFoodPlatform/locations/{locations}/operationResults/{operationResultsId}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
locations:
{
Description: Location. ,
Required: True ,
}
string ,
operationResultsId:
{
Description: operation Results Id. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
status:
{
Description: Status of the async operation. ,
Required: False ,
}
string ,
error:
{
Description: Arm async operation error class. Ref: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/async-api-reference.md#azure-asyncoperation-resource-format. ,
Required: False ,
}
{
code:
{
Description: Status of the async operation. ,
Required: False ,
}
string ,
message:
{
Description: Status of the async operation. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Locations_CheckNameAvailability (removed)
Description :  Checks the name availability of the resource with requested resource name.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.AgFoodPlatform/checkNameAvailability
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: NameAvailabilityRequest object. ,
Required: True ,
}
{
name:
{
Description: The name of the resource for which availability needs to be checked. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
nameAvailable:
{
Description: Indicates if the resource name is available. ,
Required: False ,
}
boolean ,
reason:
{
Description: The reason why the given name is not available. ,
Enum:
{
Invalid: No description available. ,
AlreadyExists: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Detailed reason why the given name is available. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Operations_List (removed)
Description :  Lists the available operations of Microsoft.AgFoodPlatform resource provider.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.AgFoodPlatform/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_CreateOrUpdate (removed)
Description :  Approves or Rejects a Private endpoint connection request.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats/{farmBeatsResourceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
farmBeatsResourceName:
{
Description: FarmBeats resource name. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: Private endpoint connection name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Request object. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_Get (removed)
Description :  Get Private endpoint connection object.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats/{farmBeatsResourceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
farmBeatsResourceName:
{
Description: FarmBeats resource name. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: Private endpoint connection name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (404)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_Delete (removed)
Description :  Delete Private endpoint connection request.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats/{farmBeatsResourceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
farmBeatsResourceName:
{
Description: FarmBeats resource name. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: Private endpoint connection name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_ListByResource (removed)
Description :  Get list of Private endpoint connections.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats/{farmBeatsResourceName}/privateEndpointConnections
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
farmBeatsResourceName:
{
Description: FarmBeats resource name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateLinkResources_ListByResource (removed)
Description :  Get list of Private link resources.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats/{farmBeatsResourceName}/privateLinkResources
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
farmBeatsResourceName:
{
Description: FarmBeats resource name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of private link resources ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupId:
{
Description: The private link resource group id. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The private link resource required member names. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The private link resource private link DNS zone name. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateLinkResources_Get (removed)
Description :  Get Private link resource object.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats/{farmBeatsResourceName}/privateLinkResources/{subResourceName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
farmBeatsResourceName:
{
Description: FarmBeats resource name. ,
Required: True ,
}
string ,
subResourceName:
{
Description: Sub resource name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupId:
{
Description: The private link resource group id. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The private link resource required member names. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The private link resource private link DNS zone name. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (404)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Solutions_CreateOrUpdate (removed)
Description :  Install Or Update Solution.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats/{farmBeatsResourceName}/solutions/{solutionId}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
farmBeatsResourceName:
{
Description: FarmBeats resource name. ,
Required: True ,
}
string ,
solutionId:
{
Description: Solution Id of the solution. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Solution resource request body. ,
Required: False ,
}
{
properties:
{
Description: Solution resource properties. ,
Required: False ,
}
{
solutionId:
{
Description: Solution Id. ,
Required: False ,
}
string ,
partnerId:
{
Description: Partner Id of the Solution. ,
Required: False ,
}
string ,
saasSubscriptionId:
{
Description: SaaS subscriptionId of the installed SaaS application. ,
Required: True ,
}
string ,
saasSubscriptionName:
{
Description: SaaS subscription name of the installed SaaS application. ,
Required: True ,
}
string ,
marketplacePublisherId:
{
Description: SaaS application Publisher Id. ,
Required: True ,
}
string ,
planId:
{
Description: SaaS application Plan Id. ,
Required: True ,
}
string ,
offerId:
{
Description: SaaS application Offer Id. ,
Required: True ,
}
string ,
termId:
{
Description: SaaS application Term Id. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Solution resource properties. ,
Required: False ,
}
{
solutionId:
{
Description: Solution Id. ,
Required: False ,
}
string ,
partnerId:
{
Description: Partner Id of the Solution. ,
Required: False ,
}
string ,
saasSubscriptionId:
{
Description: SaaS subscriptionId of the installed SaaS application. ,
Required: True ,
}
string ,
saasSubscriptionName:
{
Description: SaaS subscription name of the installed SaaS application. ,
Required: True ,
}
string ,
marketplacePublisherId:
{
Description: SaaS application Publisher Id. ,
Required: True ,
}
string ,
planId:
{
Description: SaaS application Plan Id. ,
Required: True ,
}
string ,
offerId:
{
Description: SaaS application Offer Id. ,
Required: True ,
}
string ,
termId:
{
Description: SaaS application Term Id. ,
Required: True ,
}
string ,
}
,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Solution resource properties. ,
Required: False ,
}
{
solutionId:
{
Description: Solution Id. ,
Required: False ,
}
string ,
partnerId:
{
Description: Partner Id of the Solution. ,
Required: False ,
}
string ,
saasSubscriptionId:
{
Description: SaaS subscriptionId of the installed SaaS application. ,
Required: True ,
}
string ,
saasSubscriptionName:
{
Description: SaaS subscription name of the installed SaaS application. ,
Required: True ,
}
string ,
marketplacePublisherId:
{
Description: SaaS application Publisher Id. ,
Required: True ,
}
string ,
planId:
{
Description: SaaS application Plan Id. ,
Required: True ,
}
string ,
offerId:
{
Description: SaaS application Offer Id. ,
Required: True ,
}
string ,
termId:
{
Description: SaaS application Term Id. ,
Required: True ,
}
string ,
}
,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Solutions_Get (removed)
Description :  Get installed Solution details by Solution id.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats/{farmBeatsResourceName}/solutions/{solutionId}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
farmBeatsResourceName:
{
Description: FarmBeats resource name. ,
Required: True ,
}
string ,
solutionId:
{
Description: Solution Id of the solution. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Solution resource properties. ,
Required: False ,
}
{
solutionId:
{
Description: Solution Id. ,
Required: False ,
}
string ,
partnerId:
{
Description: Partner Id of the Solution. ,
Required: False ,
}
string ,
saasSubscriptionId:
{
Description: SaaS subscriptionId of the installed SaaS application. ,
Required: True ,
}
string ,
saasSubscriptionName:
{
Description: SaaS subscription name of the installed SaaS application. ,
Required: True ,
}
string ,
marketplacePublisherId:
{
Description: SaaS application Publisher Id. ,
Required: True ,
}
string ,
planId:
{
Description: SaaS application Plan Id. ,
Required: True ,
}
string ,
offerId:
{
Description: SaaS application Offer Id. ,
Required: True ,
}
string ,
termId:
{
Description: SaaS application Term Id. ,
Required: True ,
}
string ,
}
,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Solutions_Delete (removed)
Description :  Uninstall Solution.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats/{farmBeatsResourceName}/solutions/{solutionId}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
farmBeatsResourceName:
{
Description: FarmBeats resource name. ,
Required: True ,
}
string ,
solutionId:
{
Description: Solution Id of the solution. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Solutions_List (removed)
Description :  Get installed Solutions details.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats/{farmBeatsResourceName}/solutions
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
farmBeatsResourceName:
{
Description: FarmBeats resource name. ,
Required: True ,
}
string ,
solutionIds:
{
Description: Installed Solution ids. ,
Required: False ,
}
array ,
ids:
{
Description: Ids of the resource. ,
Required: False ,
}
array ,
names:
{
Description: Names of the resource. ,
Required: False ,
}
array ,
propertyFilters:
{
Description: Filters on key-value pairs within the Properties object. eg. "{testKey} eq {testValue}". ,
Required: False ,
}
array ,
statuses:
{
Description: Statuses of the resource. ,
Required: False ,
}
array ,
minCreatedDateTime:
{
Description: Minimum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxCreatedDateTime:
{
Description: Maximum creation date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
minLastModifiedDateTime:
{
Description: Minimum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
maxLastModifiedDateTime:
{
Description: Maximum last modified date of resource (inclusive). ,
Format: date-time ,
Required: False ,
}
string ,
$maxPageSize:
{
Description: Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50. ,
Format: int32 ,
Required: False ,
}
integer ,
$skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: False ,
}
[
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Solution resource properties. ,
Required: False ,
}
{
solutionId:
{
Description: Solution Id. ,
Required: False ,
}
string ,
partnerId:
{
Description: Partner Id of the Solution. ,
Required: False ,
}
string ,
saasSubscriptionId:
{
Description: SaaS subscriptionId of the installed SaaS application. ,
Required: True ,
}
string ,
saasSubscriptionName:
{
Description: SaaS subscription name of the installed SaaS application. ,
Required: True ,
}
string ,
marketplacePublisherId:
{
Description: SaaS application Publisher Id. ,
Required: True ,
}
string ,
planId:
{
Description: SaaS application Plan Id. ,
Required: True ,
}
string ,
offerId:
{
Description: SaaS application Offer Id. ,
Required: True ,
}
string ,
termId:
{
Description: SaaS application Term Id. ,
Required: True ,
}
string ,
}
,
eTag:
{
Description: The ETag value to implement optimistic concurrency. ,
Required: False ,
}
string ,
}
,
]
,
$skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SolutionsDiscoverability_List (removed)
Description :  Get list of farmBeats solutions.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.AgFoodPlatform/farmBeatsSolutionDefinitions
{
farmBeatsSolutionIds:
{
Description: Ids of FarmBeats Solutions which the customer requests to fetch. ,
Required: False ,
}
array ,
farmBeatsSolutionNames:
{
Description: Names of FarmBeats Solutions which the customer requests to fetch. ,
Required: False ,
}
array ,
$maxPageSize:
{
Description: Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: False ,
}
[
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: FarmBeatsSolution properties. ,
Required: False ,
}
{
partnerId:
{
Description: Solution Partner Id. ,
Required: False ,
}
string ,
partnerTenantId:
{
Description: Solution Partner Tenant Id. ,
Required: False ,
}
string ,
dataAccessScopes:
{
Description: Gets scope of the FarmBeats data access that's required for processing solution request to partner. Example: For gdd they might need weatherScope and satelliteScope. ,
Required: False ,
}
[
string ,
]
,
marketplaceOfferDetails:
{
Required: False ,
}
{
saasOfferId:
{
Required: False ,
}
string ,
publisherId:
{
Required: False ,
}
string ,
}
,
inputParametersValidationScopes:
{
Description: Gets scope of the FarmBeats related parameters that need to be validated in apiInputParameters. Example: For if 'FarmHierarchy' is the input scope for 'WeatherScope' data access For working with WeatherScope we need FarmHierarchy info implies 'farmerId', 'resourceId', 'resourceType' in request body. ,
Required: False ,
}
[
{
resourceIdName:
{
Required: False ,
}
string ,
resourceType:
{
Required: False ,
}
string ,
}
,
]
,
openApiSpecsDictionary:
{
Description: Gets apiVersion: Swagger Document Dictionary to capture all api versions of swagger exposed by partner to farmbeats. ,
Required: False ,
}
object ,
evaluatedOutputsDictionary:
{
Description: Gets example name: insight sample response Dictionary to capture all variations of computed results ingested by partner. ,
Required: False ,
}
object ,
accessFBApplicationId:
{
Description: Application id of the multi tenant application to be used by partner to access FarmBeats data. ,
Format: uuid ,
Required: False ,
}
string ,
saaSApplicationId:
{
Description: Application id of the SaaS multi tenant application. ,
Format: uuid ,
Required: False ,
}
string ,
actionIds:
{
Description: List of ActionIds needed to make the SaaS multi tenant application access relevant fb data. ,
Required: False ,
}
[
string ,
]
,
roleId:
{
Description: Role Id of the SaaS multi tenant application to access relevant fb data. ,
Required: False ,
}
string ,
roleName:
{
Description: Role Name of the SaaS multi tenant application to access relevant fb data. ,
Required: False ,
}
string ,
accessFBApplicationName:
{
Description: Application name of the multi tenant application to be used by partner to access FarmBeatsData. ,
Required: False ,
}
string ,
}
,
}
,
]
,
$skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SolutionsDiscoverability_Get (removed)
Description :  Get farmBeats solution by id.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.AgFoodPlatform/farmBeatsSolutionDefinitions/{farmBeatsSolutionId}
{
farmBeatsSolutionId:
{
Description: farmBeatsSolutionId to be queried. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: FarmBeatsSolution properties. ,
Required: False ,
}
{
partnerId:
{
Description: Solution Partner Id. ,
Required: False ,
}
string ,
partnerTenantId:
{
Description: Solution Partner Tenant Id. ,
Required: False ,
}
string ,
dataAccessScopes:
{
Description: Gets scope of the FarmBeats data access that's required for processing solution request to partner. Example: For gdd they might need weatherScope and satelliteScope. ,
Required: False ,
}
[
string ,
]
,
marketplaceOfferDetails:
{
Required: False ,
}
{
saasOfferId:
{
Required: False ,
}
string ,
publisherId:
{
Required: False ,
}
string ,
}
,
inputParametersValidationScopes:
{
Description: Gets scope of the FarmBeats related parameters that need to be validated in apiInputParameters. Example: For if 'FarmHierarchy' is the input scope for 'WeatherScope' data access For working with WeatherScope we need FarmHierarchy info implies 'farmerId', 'resourceId', 'resourceType' in request body. ,
Required: False ,
}
[
{
resourceIdName:
{
Required: False ,
}
string ,
resourceType:
{
Required: False ,
}
string ,
}
,
]
,
openApiSpecsDictionary:
{
Description: Gets apiVersion: Swagger Document Dictionary to capture all api versions of swagger exposed by partner to farmbeats. ,
Required: False ,
}
object ,
evaluatedOutputsDictionary:
{
Description: Gets example name: insight sample response Dictionary to capture all variations of computed results ingested by partner. ,
Required: False ,
}
object ,
accessFBApplicationId:
{
Description: Application id of the multi tenant application to be used by partner to access FarmBeats data. ,
Format: uuid ,
Required: False ,
}
string ,
saaSApplicationId:
{
Description: Application id of the SaaS multi tenant application. ,
Format: uuid ,
Required: False ,
}
string ,
actionIds:
{
Description: List of ActionIds needed to make the SaaS multi tenant application access relevant fb data. ,
Required: False ,
}
[
string ,
]
,
roleId:
{
Description: Role Id of the SaaS multi tenant application to access relevant fb data. ,
Required: False ,
}
string ,
roleName:
{
Description: Role Name of the SaaS multi tenant application to access relevant fb data. ,
Required: False ,
}
string ,
accessFBApplicationName:
{
Description: Application name of the multi tenant application to be used by partner to access FarmBeatsData. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}