Microsoft.AgriculturePlatform (preview:2024-06-01)

2025/02/17 • 8 new methods

Operations_List (new)
Description :  List the operations for the provider
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.AgriculturePlatform/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 ,
}
,
]
,
}
,
}
AgriService_ListBySubscription (new)
Description :  List AgriServiceResource resources by subscription ID
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The AgriServiceResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is updating ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
config:
{
Description: Config of the AgriService instance. ,
Required: False ,
}
{
instanceUri:
{
Description: Instance URI of the AgriService instance. ,
Required: False ,
}
string ,
version:
{
Description: Version of AgriService instance. ,
Required: False ,
}
string ,
appServiceResourceId:
{
Description: App service resource Id. ,
Required: False ,
}
string ,
cosmosDbResourceId:
{
Description: Cosmos Db resource Id. ,
Required: False ,
}
string ,
storageAccountResourceId:
{
Description: Storage account resource Id. ,
Required: False ,
}
string ,
keyVaultResourceId:
{
Description: Key vault resource Id. ,
Required: False ,
}
string ,
redisCacheResourceId:
{
Description: Redis cache resource Id. ,
Required: False ,
}
string ,
}
,
managedOnBehalfOfConfiguration:
{
Description: Managed On Behalf Of Configuration. ,
Required: False ,
}
{
moboBrokerResources:
{
Description: Associated MoboBrokerResources. ,
Required: True ,
}
[
{
id:
{
Description: The fully qualified resource ID of the MoboBroker resource. Example: `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}` ,
Required: True ,
}
string ,
}
,
]
,
}
,
dataConnectorCredentials:
{
Description: Data connector credentials of AgriService instance. ,
Required: False ,
}
[
{
key:
{
Description: The key representing the credential. ,
Required: True ,
}
string ,
value:
{
Description: The data connector credential value. ,
Required: True ,
}
{
kind:
{
Description: Type of credential. ,
Enum:
{
OAuthClientCredentials: OAuth Client Credential type ,
ApiKeyAuthCredentials: API Key Auth Credential type ,
}
,
Required: False ,
}
enum ,
clientId:
{
Description: Client Id associated with the provider, if type of credentials is OAuthClientCredentials. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Uri of the key vault ,
Required: False ,
}
string ,
keyName:
{
Description: Name of the key vault key. ,
Required: False ,
}
string ,
keyVersion:
{
Description: Version of the key vault key. ,
Required: False ,
}
string ,
}
,
}
,
]
,
installedSolutions:
{
Description: AgriService installed solutions. ,
Required: False ,
}
[
{
key:
{
Description: The key representing the installed solution. ,
Required: True ,
}
string ,
value:
{
Description: The installed solution value. ,
Required: True ,
}
{
applicationName:
{
Description: Application name of the solution. ,
Required: False ,
}
string ,
partnerId:
{
Description: Partner Id. ,
Required: False ,
}
string ,
marketPlacePublisherId:
{
Description: Marketplace publisher Id. ,
Required: False ,
}
string ,
saasSubscriptionId:
{
Description: Saas subscription Id. ,
Required: False ,
}
string ,
saasSubscriptionName:
{
Description: Saas subscription name. ,
Required: False ,
}
string ,
planId:
{
Description: Plan Id. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
sku:
{
Description: The SKU (Stock Keeping Unit) assigned to this resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. E.g. P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
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 ,
}
,
]
,
}
,
}
AgriService_ListByResourceGroup (new)
Description :  List AgriServiceResource resources by resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgriculturePlatform/agriServices
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
}

⚐ Response (200)

{
value:
{
Description: The AgriServiceResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is updating ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
config:
{
Description: Config of the AgriService instance. ,
Required: False ,
}
{
instanceUri:
{
Description: Instance URI of the AgriService instance. ,
Required: False ,
}
string ,
version:
{
Description: Version of AgriService instance. ,
Required: False ,
}
string ,
appServiceResourceId:
{
Description: App service resource Id. ,
Required: False ,
}
string ,
cosmosDbResourceId:
{
Description: Cosmos Db resource Id. ,
Required: False ,
}
string ,
storageAccountResourceId:
{
Description: Storage account resource Id. ,
Required: False ,
}
string ,
keyVaultResourceId:
{
Description: Key vault resource Id. ,
Required: False ,
}
string ,
redisCacheResourceId:
{
Description: Redis cache resource Id. ,
Required: False ,
}
string ,
}
,
managedOnBehalfOfConfiguration:
{
Description: Managed On Behalf Of Configuration. ,
Required: False ,
}
{
moboBrokerResources:
{
Description: Associated MoboBrokerResources. ,
Required: True ,
}
[
{
id:
{
Description: The fully qualified resource ID of the MoboBroker resource. Example: `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}` ,
Required: True ,
}
string ,
}
,
]
,
}
,
dataConnectorCredentials:
{
Description: Data connector credentials of AgriService instance. ,
Required: False ,
}
[
{
key:
{
Description: The key representing the credential. ,
Required: True ,
}
string ,
value:
{
Description: The data connector credential value. ,
Required: True ,
}
{
kind:
{
Description: Type of credential. ,
Enum:
{
OAuthClientCredentials: OAuth Client Credential type ,
ApiKeyAuthCredentials: API Key Auth Credential type ,
}
,
Required: False ,
}
enum ,
clientId:
{
Description: Client Id associated with the provider, if type of credentials is OAuthClientCredentials. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Uri of the key vault ,
Required: False ,
}
string ,
keyName:
{
Description: Name of the key vault key. ,
Required: False ,
}
string ,
keyVersion:
{
Description: Version of the key vault key. ,
Required: False ,
}
string ,
}
,
}
,
]
,
installedSolutions:
{
Description: AgriService installed solutions. ,
Required: False ,
}
[
{
key:
{
Description: The key representing the installed solution. ,
Required: True ,
}
string ,
value:
{
Description: The installed solution value. ,
Required: True ,
}
{
applicationName:
{
Description: Application name of the solution. ,
Required: False ,
}
string ,
partnerId:
{
Description: Partner Id. ,
Required: False ,
}
string ,
marketPlacePublisherId:
{
Description: Marketplace publisher Id. ,
Required: False ,
}
string ,
saasSubscriptionId:
{
Description: Saas subscription Id. ,
Required: False ,
}
string ,
saasSubscriptionName:
{
Description: Saas subscription name. ,
Required: False ,
}
string ,
planId:
{
Description: Plan Id. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
sku:
{
Description: The SKU (Stock Keeping Unit) assigned to this resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. E.g. P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
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 ,
}
,
]
,
}
,
}
AgriService_Get (new)
Description :  Get a AgriServiceResource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgriculturePlatform/agriServices/{agriServiceResourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
agriServiceResourceName:
{
Description: The name of the AgriService resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is updating ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
config:
{
Description: Config of the AgriService instance. ,
Required: False ,
}
{
instanceUri:
{
Description: Instance URI of the AgriService instance. ,
Required: False ,
}
string ,
version:
{
Description: Version of AgriService instance. ,
Required: False ,
}
string ,
appServiceResourceId:
{
Description: App service resource Id. ,
Required: False ,
}
string ,
cosmosDbResourceId:
{
Description: Cosmos Db resource Id. ,
Required: False ,
}
string ,
storageAccountResourceId:
{
Description: Storage account resource Id. ,
Required: False ,
}
string ,
keyVaultResourceId:
{
Description: Key vault resource Id. ,
Required: False ,
}
string ,
redisCacheResourceId:
{
Description: Redis cache resource Id. ,
Required: False ,
}
string ,
}
,
managedOnBehalfOfConfiguration:
{
Description: Managed On Behalf Of Configuration. ,
Required: False ,
}
{
moboBrokerResources:
{
Description: Associated MoboBrokerResources. ,
Required: True ,
}
[
{
id:
{
Description: The fully qualified resource ID of the MoboBroker resource. Example: `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}` ,
Required: True ,
}
string ,
}
,
]
,
}
,
dataConnectorCredentials:
{
Description: Data connector credentials of AgriService instance. ,
Required: False ,
}
[
{
key:
{
Description: The key representing the credential. ,
Required: True ,
}
string ,
value:
{
Description: The data connector credential value. ,
Required: True ,
}
{
kind:
{
Description: Type of credential. ,
Enum:
{
OAuthClientCredentials: OAuth Client Credential type ,
ApiKeyAuthCredentials: API Key Auth Credential type ,
}
,
Required: False ,
}
enum ,
clientId:
{
Description: Client Id associated with the provider, if type of credentials is OAuthClientCredentials. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Uri of the key vault ,
Required: False ,
}
string ,
keyName:
{
Description: Name of the key vault key. ,
Required: False ,
}
string ,
keyVersion:
{
Description: Version of the key vault key. ,
Required: False ,
}
string ,
}
,
}
,
]
,
installedSolutions:
{
Description: AgriService installed solutions. ,
Required: False ,
}
[
{
key:
{
Description: The key representing the installed solution. ,
Required: True ,
}
string ,
value:
{
Description: The installed solution value. ,
Required: True ,
}
{
applicationName:
{
Description: Application name of the solution. ,
Required: False ,
}
string ,
partnerId:
{
Description: Partner Id. ,
Required: False ,
}
string ,
marketPlacePublisherId:
{
Description: Marketplace publisher Id. ,
Required: False ,
}
string ,
saasSubscriptionId:
{
Description: Saas subscription Id. ,
Required: False ,
}
string ,
saasSubscriptionName:
{
Description: Saas subscription name. ,
Required: False ,
}
string ,
planId:
{
Description: Plan Id. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
sku:
{
Description: The SKU (Stock Keeping Unit) assigned to this resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. E.g. P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
AgriService_CreateOrUpdate (new)
Description :  Create a AgriServiceResource
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgriculturePlatform/agriServices/{agriServiceResourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
agriServiceResourceName:
{
Description: The name of the AgriService resource. ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is updating ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
config:
{
Description: Config of the AgriService instance. ,
Required: False ,
}
{
instanceUri:
{
Description: Instance URI of the AgriService instance. ,
Required: False ,
}
string ,
version:
{
Description: Version of AgriService instance. ,
Required: False ,
}
string ,
appServiceResourceId:
{
Description: App service resource Id. ,
Required: False ,
}
string ,
cosmosDbResourceId:
{
Description: Cosmos Db resource Id. ,
Required: False ,
}
string ,
storageAccountResourceId:
{
Description: Storage account resource Id. ,
Required: False ,
}
string ,
keyVaultResourceId:
{
Description: Key vault resource Id. ,
Required: False ,
}
string ,
redisCacheResourceId:
{
Description: Redis cache resource Id. ,
Required: False ,
}
string ,
}
,
managedOnBehalfOfConfiguration:
{
Description: Managed On Behalf Of Configuration. ,
Required: False ,
}
{
moboBrokerResources:
{
Description: Associated MoboBrokerResources. ,
Required: True ,
}
[
{
id:
{
Description: The fully qualified resource ID of the MoboBroker resource. Example: `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}` ,
Required: True ,
}
string ,
}
,
]
,
}
,
dataConnectorCredentials:
{
Description: Data connector credentials of AgriService instance. ,
Required: False ,
}
[
{
key:
{
Description: The key representing the credential. ,
Required: True ,
}
string ,
value:
{
Description: The data connector credential value. ,
Required: True ,
}
{
kind:
{
Description: Type of credential. ,
Enum:
{
OAuthClientCredentials: OAuth Client Credential type ,
ApiKeyAuthCredentials: API Key Auth Credential type ,
}
,
Required: False ,
}
enum ,
clientId:
{
Description: Client Id associated with the provider, if type of credentials is OAuthClientCredentials. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Uri of the key vault ,
Required: False ,
}
string ,
keyName:
{
Description: Name of the key vault key. ,
Required: False ,
}
string ,
keyVersion:
{
Description: Version of the key vault key. ,
Required: False ,
}
string ,
}
,
}
,
]
,
installedSolutions:
{
Description: AgriService installed solutions. ,
Required: False ,
}
[
{
key:
{
Description: The key representing the installed solution. ,
Required: True ,
}
string ,
value:
{
Description: The installed solution value. ,
Required: True ,
}
{
applicationName:
{
Description: Application name of the solution. ,
Required: False ,
}
string ,
partnerId:
{
Description: Partner Id. ,
Required: False ,
}
string ,
marketPlacePublisherId:
{
Description: Marketplace publisher Id. ,
Required: False ,
}
string ,
saasSubscriptionId:
{
Description: Saas subscription Id. ,
Required: False ,
}
string ,
saasSubscriptionName:
{
Description: Saas subscription name. ,
Required: False ,
}
string ,
planId:
{
Description: Plan Id. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
sku:
{
Description: The SKU (Stock Keeping Unit) assigned to this resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. E.g. P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is updating ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
config:
{
Description: Config of the AgriService instance. ,
Required: False ,
}
{
instanceUri:
{
Description: Instance URI of the AgriService instance. ,
Required: False ,
}
string ,
version:
{
Description: Version of AgriService instance. ,
Required: False ,
}
string ,
appServiceResourceId:
{
Description: App service resource Id. ,
Required: False ,
}
string ,
cosmosDbResourceId:
{
Description: Cosmos Db resource Id. ,
Required: False ,
}
string ,
storageAccountResourceId:
{
Description: Storage account resource Id. ,
Required: False ,
}
string ,
keyVaultResourceId:
{
Description: Key vault resource Id. ,
Required: False ,
}
string ,
redisCacheResourceId:
{
Description: Redis cache resource Id. ,
Required: False ,
}
string ,
}
,
managedOnBehalfOfConfiguration:
{
Description: Managed On Behalf Of Configuration. ,
Required: False ,
}
{
moboBrokerResources:
{
Description: Associated MoboBrokerResources. ,
Required: True ,
}
[
{
id:
{
Description: The fully qualified resource ID of the MoboBroker resource. Example: `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}` ,
Required: True ,
}
string ,
}
,
]
,
}
,
dataConnectorCredentials:
{
Description: Data connector credentials of AgriService instance. ,
Required: False ,
}
[
{
key:
{
Description: The key representing the credential. ,
Required: True ,
}
string ,
value:
{
Description: The data connector credential value. ,
Required: True ,
}
{
kind:
{
Description: Type of credential. ,
Enum:
{
OAuthClientCredentials: OAuth Client Credential type ,
ApiKeyAuthCredentials: API Key Auth Credential type ,
}
,
Required: False ,
}
enum ,
clientId:
{
Description: Client Id associated with the provider, if type of credentials is OAuthClientCredentials. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Uri of the key vault ,
Required: False ,
}
string ,
keyName:
{
Description: Name of the key vault key. ,
Required: False ,
}
string ,
keyVersion:
{
Description: Version of the key vault key. ,
Required: False ,
}
string ,
}
,
}
,
]
,
installedSolutions:
{
Description: AgriService installed solutions. ,
Required: False ,
}
[
{
key:
{
Description: The key representing the installed solution. ,
Required: True ,
}
string ,
value:
{
Description: The installed solution value. ,
Required: True ,
}
{
applicationName:
{
Description: Application name of the solution. ,
Required: False ,
}
string ,
partnerId:
{
Description: Partner Id. ,
Required: False ,
}
string ,
marketPlacePublisherId:
{
Description: Marketplace publisher Id. ,
Required: False ,
}
string ,
saasSubscriptionId:
{
Description: Saas subscription Id. ,
Required: False ,
}
string ,
saasSubscriptionName:
{
Description: Saas subscription name. ,
Required: False ,
}
string ,
planId:
{
Description: Plan Id. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
sku:
{
Description: The SKU (Stock Keeping Unit) assigned to this resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. E.g. P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Schema of the AgriService resource from Microsoft.AgriculturePlatform resource provider. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is updating ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
config:
{
Description: Config of the AgriService instance. ,
Required: False ,
}
{
instanceUri:
{
Description: Instance URI of the AgriService instance. ,
Required: False ,
}
string ,
version:
{
Description: Version of AgriService instance. ,
Required: False ,
}
string ,
appServiceResourceId:
{
Description: App service resource Id. ,
Required: False ,
}
string ,
cosmosDbResourceId:
{
Description: Cosmos Db resource Id. ,
Required: False ,
}
string ,
storageAccountResourceId:
{
Description: Storage account resource Id. ,
Required: False ,
}
string ,
keyVaultResourceId:
{
Description: Key vault resource Id. ,
Required: False ,
}
string ,
redisCacheResourceId:
{
Description: Redis cache resource Id. ,
Required: False ,
}
string ,
}
,
managedOnBehalfOfConfiguration:
{
Description: Managed On Behalf Of Configuration. ,
Required: False ,
}
{
moboBrokerResources:
{
Description: Associated MoboBrokerResources. ,
Required: True ,
}
[
{
id:
{
Description: The fully qualified resource ID of the MoboBroker resource. Example: `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}` ,
Required: True ,
}
string ,
}
,
]
,
}
,
dataConnectorCredentials:
{
Description: Data connector credentials of AgriService instance. ,
Required: False ,
}
[
{
key:
{
Description: The key representing the credential. ,
Required: True ,
}
string ,
value:
{
Description: The data connector credential value. ,
Required: True ,
}
{
kind:
{
Description: Type of credential. ,
Enum:
{
OAuthClientCredentials: OAuth Client Credential type ,
ApiKeyAuthCredentials: API Key Auth Credential type ,
}
,
Required: False ,
}
enum ,
clientId:
{
Description: Client Id associated with the provider, if type of credentials is OAuthClientCredentials. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Uri of the key vault ,
Required: False ,
}
string ,
keyName:
{
Description: Name of the key vault key. ,
Required: False ,
}
string ,
keyVersion:
{
Description: Version of the key vault key. ,
Required: False ,
}
string ,
}
,
}
,
]
,
installedSolutions:
{
Description: AgriService installed solutions. ,
Required: False ,
}
[
{
key:
{
Description: The key representing the installed solution. ,
Required: True ,
}
string ,
value:
{
Description: The installed solution value. ,
Required: True ,
}
{
applicationName:
{
Description: Application name of the solution. ,
Required: False ,
}
string ,
partnerId:
{
Description: Partner Id. ,
Required: False ,
}
string ,
marketPlacePublisherId:
{
Description: Marketplace publisher Id. ,
Required: False ,
}
string ,
saasSubscriptionId:
{
Description: Saas subscription Id. ,
Required: False ,
}
string ,
saasSubscriptionName:
{
Description: Saas subscription name. ,
Required: False ,
}
string ,
planId:
{
Description: Plan Id. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
sku:
{
Description: The SKU (Stock Keeping Unit) assigned to this resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. E.g. P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
AgriService_Update (new)
Description :  Update a AgriServiceResource
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgriculturePlatform/agriServices/{agriServiceResourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
agriServiceResourceName:
{
Description: The name of the AgriService resource. ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity assigned to this resource. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The identities assigned to this resource by the user. ,
Required: False ,
}
object ,
}
,
sku:
{
Description: The SKU (Stock Keeping Unit) assigned to this resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: False ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
config:
{
Description: Config of the AgriService instance. ,
Required: False ,
}
{
instanceUri:
{
Description: Instance URI of the AgriService instance. ,
Required: False ,
}
string ,
version:
{
Description: Version of AgriService instance. ,
Required: False ,
}
string ,
appServiceResourceId:
{
Description: App service resource Id. ,
Required: False ,
}
string ,
cosmosDbResourceId:
{
Description: Cosmos Db resource Id. ,
Required: False ,
}
string ,
storageAccountResourceId:
{
Description: Storage account resource Id. ,
Required: False ,
}
string ,
keyVaultResourceId:
{
Description: Key vault resource Id. ,
Required: False ,
}
string ,
redisCacheResourceId:
{
Description: Redis cache resource Id. ,
Required: False ,
}
string ,
}
,
dataConnectorCredentials:
{
Description: Data connector credentials of AgriService instance. ,
Required: False ,
}
[
{
key:
{
Description: The key representing the credential. ,
Required: True ,
}
string ,
value:
{
Description: The data connector credential value. ,
Required: True ,
}
{
kind:
{
Description: Type of credential. ,
Enum:
{
OAuthClientCredentials: OAuth Client Credential type ,
ApiKeyAuthCredentials: API Key Auth Credential type ,
}
,
Required: False ,
}
enum ,
clientId:
{
Description: Client Id associated with the provider, if type of credentials is OAuthClientCredentials. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Uri of the key vault ,
Required: False ,
}
string ,
keyName:
{
Description: Name of the key vault key. ,
Required: False ,
}
string ,
keyVersion:
{
Description: Version of the key vault key. ,
Required: False ,
}
string ,
}
,
}
,
]
,
installedSolutions:
{
Description: AgriService installed solutions. ,
Required: False ,
}
[
{
key:
{
Description: The key representing the installed solution. ,
Required: True ,
}
string ,
value:
{
Description: The installed solution value. ,
Required: True ,
}
{
applicationName:
{
Description: Application name of the solution. ,
Required: False ,
}
string ,
partnerId:
{
Description: Partner Id. ,
Required: False ,
}
string ,
marketPlacePublisherId:
{
Description: Marketplace publisher Id. ,
Required: False ,
}
string ,
saasSubscriptionId:
{
Description: Saas subscription Id. ,
Required: False ,
}
string ,
saasSubscriptionName:
{
Description: Saas subscription name. ,
Required: False ,
}
string ,
planId:
{
Description: Plan Id. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is updating ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
config:
{
Description: Config of the AgriService instance. ,
Required: False ,
}
{
instanceUri:
{
Description: Instance URI of the AgriService instance. ,
Required: False ,
}
string ,
version:
{
Description: Version of AgriService instance. ,
Required: False ,
}
string ,
appServiceResourceId:
{
Description: App service resource Id. ,
Required: False ,
}
string ,
cosmosDbResourceId:
{
Description: Cosmos Db resource Id. ,
Required: False ,
}
string ,
storageAccountResourceId:
{
Description: Storage account resource Id. ,
Required: False ,
}
string ,
keyVaultResourceId:
{
Description: Key vault resource Id. ,
Required: False ,
}
string ,
redisCacheResourceId:
{
Description: Redis cache resource Id. ,
Required: False ,
}
string ,
}
,
managedOnBehalfOfConfiguration:
{
Description: Managed On Behalf Of Configuration. ,
Required: False ,
}
{
moboBrokerResources:
{
Description: Associated MoboBrokerResources. ,
Required: True ,
}
[
{
id:
{
Description: The fully qualified resource ID of the MoboBroker resource. Example: `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}` ,
Required: True ,
}
string ,
}
,
]
,
}
,
dataConnectorCredentials:
{
Description: Data connector credentials of AgriService instance. ,
Required: False ,
}
[
{
key:
{
Description: The key representing the credential. ,
Required: True ,
}
string ,
value:
{
Description: The data connector credential value. ,
Required: True ,
}
{
kind:
{
Description: Type of credential. ,
Enum:
{
OAuthClientCredentials: OAuth Client Credential type ,
ApiKeyAuthCredentials: API Key Auth Credential type ,
}
,
Required: False ,
}
enum ,
clientId:
{
Description: Client Id associated with the provider, if type of credentials is OAuthClientCredentials. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Uri of the key vault ,
Required: False ,
}
string ,
keyName:
{
Description: Name of the key vault key. ,
Required: False ,
}
string ,
keyVersion:
{
Description: Version of the key vault key. ,
Required: False ,
}
string ,
}
,
}
,
]
,
installedSolutions:
{
Description: AgriService installed solutions. ,
Required: False ,
}
[
{
key:
{
Description: The key representing the installed solution. ,
Required: True ,
}
string ,
value:
{
Description: The installed solution value. ,
Required: True ,
}
{
applicationName:
{
Description: Application name of the solution. ,
Required: False ,
}
string ,
partnerId:
{
Description: Partner Id. ,
Required: False ,
}
string ,
marketPlacePublisherId:
{
Description: Marketplace publisher Id. ,
Required: False ,
}
string ,
saasSubscriptionId:
{
Description: Saas subscription Id. ,
Required: False ,
}
string ,
saasSubscriptionName:
{
Description: Saas subscription name. ,
Required: False ,
}
string ,
planId:
{
Description: Plan Id. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
sku:
{
Description: The SKU (Stock Keeping Unit) assigned to this resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. E.g. P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ 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 ,
}
,
]
,
}
,
}
AgriService_Delete (new)
Description :  Delete a AgriServiceResource
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgriculturePlatform/agriServices/{agriServiceResourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
agriServiceResourceName:
{
Description: The name of the AgriService resource. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ 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 ,
}
,
]
,
}
,
}
AgriService_ListAvailableSolutions (new)
Description :  Returns the list of available agri solutions.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgriculturePlatform/agriServices/{agriServiceResourceName}/listAvailableSolutions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
agriServiceResourceName:
{
Description: The name of the AgriService resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
solutions:
{
Description: Agri solutions list. ,
Required: True ,
}
[
{
partnerId:
{
Description: Partner Id. ,
Required: True ,
}
string ,
solutionId:
{
Description: Solution Id. ,
Required: True ,
}
string ,
partnerTenantId:
{
Description: Partner tenant Id. ,
Required: True ,
}
string ,
dataAccessScopes:
{
Description: Data access scopes. ,
Required: True ,
}
[
string ,
]
,
marketPlaceOfferDetails:
{
Description: Marketplace offer details. ,
Required: True ,
}
{
saasOfferId:
{
Description: Saas offer Id. ,
Required: True ,
}
string ,
publisherId:
{
Description: Publisher Id. ,
Required: True ,
}
string ,
}
,
saasApplicationId:
{
Description: Saas application Id. ,
Required: True ,
}
string ,
accessAzureDataManagerForAgricultureApplicationId:
{
Description: Entra application Id used to access azure data manager for agriculture instance. ,
Required: True ,
}
string ,
accessAzureDataManagerForAgricultureApplicationName:
{
Description: Entra application name used to access azure data manager for agriculture instance. ,
Required: True ,
}
string ,
isValidateInput:
{
Description: Whether solution inference will validate input. ,
Required: True ,
}
boolean ,
}
,
]
,
}

⚐ 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 ,
}
,
]
,
}
,
}