Share via


@azure/arm-agricultureplatform package

Classes

AgriculturePlatformClient

Interfaces

AgriServiceConfig

Config of the AgriService resource instance.

AgriServiceCreateOrUpdateOptionalParams

Optional parameters.

AgriServiceDeleteOptionalParams

Optional parameters.

AgriServiceGetOptionalParams

Optional parameters.

AgriServiceListAvailableSolutionsOptionalParams

Optional parameters.

AgriServiceListByResourceGroupOptionalParams

Optional parameters.

AgriServiceListBySubscriptionOptionalParams

Optional parameters.

AgriServiceOperations

Interface representing a AgriService operations.

AgriServiceResource

Schema of the AgriService resource from Microsoft.AgriculturePlatform resource provider.

AgriServiceResourceProperties

Details of the Agriculture AgriDataManager.

AgriServiceResourceUpdate

The type used for update operations of the AgriServiceResource.

AgriServiceResourceUpdateProperties

The updatable properties of the AgriServiceResource.

AgriServiceUpdateOptionalParams

Optional parameters.

AgriculturePlatformClientOptionalParams

Optional parameters for the client.

AvailableAgriSolutionListResult

The list of available agri solutions.

DataConnectorCredentialMap

Mapping of data connector credentials.

DataConnectorCredentials

The properties related to an AgriService data connector.

DataManagerForAgricultureSolution

Data Manager for Agriculture solution.

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Common error response for all Azure Resource Manager APIs to return error details for failed operations.

InstalledSolutionMap

Mapping of installed solutions.

ManagedOnBehalfOfConfiguration

Configuration of the managed on behalf of resource.

ManagedServiceIdentity

Managed service identity (system assigned and/or user assigned identities)

MarketPlaceOfferDetails

Marketplace offer details of Agri solution.

MoboBrokerResource

MoboBroker resource.

Operation

Details of a REST API operation, returned from the Resource Provider Operations API

OperationDisplay

Localized display information for and operation.

OperationsListOptionalParams

Optional parameters.

OperationsOperations

Interface representing a Operations operations.

PageSettings

Options for the byPage method

PagedAsyncIterableIterator

An interface that allows async iterable iteration both to completion and by page.

Resource

Common fields that are returned in the response for all Azure Resource Manager resources

RestorePollerOptions
Sku

The resource model definition representing SKU

Solution

Installed data manager for Agriculture solution detail.

SystemData

Metadata pertaining to creation and last modification of the resource.

TrackedResource

The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a '___location'

UserAssignedIdentity

User assigned identity properties

Type Aliases

ActionType

Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports.

Known values supported by the service

Internal: Actions are for internal-only APIs.

AuthCredentialsKind

Types of different kind of Data connector auth credentials supported.
KnownAuthCredentialsKind can be used interchangeably with AuthCredentialsKind, this enum contains the known values that the service supports.

Known values supported by the service

OAuthClientCredentials: OAuth Client Credential type
ApiKeyAuthCredentials: API Key Auth Credential type

ContinuablePage

An interface that describes a page of results.

CreatedByType

The kind of entity that created the resource.
<xref:KnowncreatedByType> can be used interchangeably with createdByType, this enum contains the known values that the service supports.

Known values supported by the service

User: The entity was created by a user.
Application: The entity was created by an application.
ManagedIdentity: The entity was created by a managed identity.
Key: The entity was created by a key.

ManagedServiceIdentityType

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
KnownManagedServiceIdentityType can be used interchangeably with ManagedServiceIdentityType, this enum contains the known values that the service supports.

Known values supported by the service

None: No managed identity.
SystemAssigned: System assigned managed identity.
UserAssigned: User assigned managed identity.
SystemAssigned,UserAssigned: System and user assigned managed identity.

Origin

The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports.

Known values supported by the service

user: Indicates the operation is initiated by a user.
system: Indicates the operation is initiated by a system.
user,system: Indicates the operation is initiated by a user or system.

ProvisioningState

The status of the current operation.
KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

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

SkuTier

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.

Enums

KnownActionType

Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.

KnownAuthCredentialsKind

Types of different kind of Data connector auth credentials supported.

KnownCreatedByType

The kind of entity that created the resource.

KnownManagedServiceIdentityType

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

KnownOrigin

The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"

KnownProvisioningState

The status of the current operation.

KnownVersions

Supported API versions for the Microsoft.AgriculturePlatform resource provider.

Functions

restorePoller<TResponse, TResult>(AgriculturePlatformClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

Function Details

restorePoller<TResponse, TResult>(AgriculturePlatformClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

function restorePoller<TResponse, TResult>(client: AgriculturePlatformClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

Returns

PollerLike<OperationState<TResult>, TResult>