@azure/arm-agrifood package

Classes

AgriFoodMgmtClient

Interfaces

AgriFoodMgmtClientOptionalParams

Optional parameters.

ArmAsyncOperation

Arm async operation class. Ref: https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/async-operations.

CheckNameAvailabilityRequest

The check availability request body.

CheckNameAvailabilityResponse

The check availability result.

DetailedInformation

Model to capture detailed information for farmBeatsExtensions.

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. (This also follows the OData error response format.).

Extension

Extension resource.

ExtensionListResponse

Paged response contains list of requested objects and a URL link to get the next set of results.

Extensions

Interface representing a Extensions.

ExtensionsCreateOptionalParams

Optional parameters.

ExtensionsDeleteOptionalParams

Optional parameters.

ExtensionsGetOptionalParams

Optional parameters.

ExtensionsListByFarmBeatsNextOptionalParams

Optional parameters.

ExtensionsListByFarmBeatsOptionalParams

Optional parameters.

ExtensionsUpdateOptionalParams

Optional parameters.

FarmBeats

FarmBeats ARM Resource.

FarmBeatsExtension

FarmBeats extension resource.

FarmBeatsExtensionListResponse

Paged response contains list of requested objects and a URL link to get the next set of results.

FarmBeatsExtensions

Interface representing a FarmBeatsExtensions.

FarmBeatsExtensionsGetOptionalParams

Optional parameters.

FarmBeatsExtensionsListNextOptionalParams

Optional parameters.

FarmBeatsExtensionsListOptionalParams

Optional parameters.

FarmBeatsListResponse

Paged response contains list of requested objects and a URL link to get the next set of results.

FarmBeatsModels

Interface representing a FarmBeatsModels.

FarmBeatsModelsCreateOrUpdateOptionalParams

Optional parameters.

FarmBeatsModelsDeleteOptionalParams

Optional parameters.

FarmBeatsModelsGetOperationResultOptionalParams

Optional parameters.

FarmBeatsModelsGetOptionalParams

Optional parameters.

FarmBeatsModelsListByResourceGroupNextOptionalParams

Optional parameters.

FarmBeatsModelsListByResourceGroupOptionalParams

Optional parameters.

FarmBeatsModelsListBySubscriptionNextOptionalParams

Optional parameters.

FarmBeatsModelsListBySubscriptionOptionalParams

Optional parameters.

FarmBeatsModelsUpdateHeaders

Defines headers for FarmBeatsModels_update operation.

FarmBeatsModelsUpdateOptionalParams

Optional parameters.

FarmBeatsUpdateProperties

FarmBeats ARM Resource properties.

FarmBeatsUpdateRequestModel

FarmBeats update request.

Identity

Identity for the resource.

Locations

Interface representing a Locations.

LocationsCheckNameAvailabilityOptionalParams

Optional parameters.

Operation

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

OperationDisplay

Localized display information for this particular operation.

OperationListResult

A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.

Operations

Interface representing a Operations.

OperationsListNextOptionalParams

Optional parameters.

OperationsListOptionalParams

Optional parameters.

PrivateEndpoint

The Private Endpoint resource.

PrivateEndpointConnection

The Private Endpoint Connection resource.

PrivateEndpointConnectionListResult

List of private endpoint connection associated with the specified storage account

PrivateEndpointConnections

Interface representing a PrivateEndpointConnections.

PrivateEndpointConnectionsCreateOrUpdateOptionalParams

Optional parameters.

PrivateEndpointConnectionsDeleteHeaders

Defines headers for PrivateEndpointConnections_delete operation.

PrivateEndpointConnectionsDeleteOptionalParams

Optional parameters.

PrivateEndpointConnectionsGetOptionalParams

Optional parameters.

PrivateEndpointConnectionsListByResourceOptionalParams

Optional parameters.

PrivateLinkResource

A private link resource

PrivateLinkResourceListResult

A list of private link resources

PrivateLinkResources

Interface representing a PrivateLinkResources.

PrivateLinkResourcesGetOptionalParams

Optional parameters.

PrivateLinkResourcesListByResourceOptionalParams

Optional parameters.

PrivateLinkServiceConnectionState

A collection of information about the state of the connection between service consumer and provider.

ProxyResource

The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location

Resource

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

SensorIntegration

Sensor integration request model.

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'

UnitSystemsInfo

Unit systems info for the data provider.

Type Aliases

ActionType

Defines values for ActionType.
KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports.

Known values supported by the service

Internal

CheckNameAvailabilityReason

Defines values for CheckNameAvailabilityReason.
KnownCheckNameAvailabilityReason can be used interchangeably with CheckNameAvailabilityReason, this enum contains the known values that the service supports.

Known values supported by the service

Invalid
AlreadyExists

CreatedByType

Defines values for CreatedByType.
KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports.

Known values supported by the service

User
Application
ManagedIdentity
Key

ExtensionsCreateResponse

Contains response data for the create operation.

ExtensionsGetResponse

Contains response data for the get operation.

ExtensionsListByFarmBeatsNextResponse

Contains response data for the listByFarmBeatsNext operation.

ExtensionsListByFarmBeatsResponse

Contains response data for the listByFarmBeats operation.

ExtensionsUpdateResponse

Contains response data for the update operation.

FarmBeatsExtensionsGetResponse

Contains response data for the get operation.

FarmBeatsExtensionsListNextResponse

Contains response data for the listNext operation.

FarmBeatsExtensionsListResponse

Contains response data for the list operation.

FarmBeatsModelsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

FarmBeatsModelsGetOperationResultResponse

Contains response data for the getOperationResult operation.

FarmBeatsModelsGetResponse

Contains response data for the get operation.

FarmBeatsModelsListByResourceGroupNextResponse

Contains response data for the listByResourceGroupNext operation.

FarmBeatsModelsListByResourceGroupResponse

Contains response data for the listByResourceGroup operation.

FarmBeatsModelsListBySubscriptionNextResponse

Contains response data for the listBySubscriptionNext operation.

FarmBeatsModelsListBySubscriptionResponse

Contains response data for the listBySubscription operation.

FarmBeatsModelsUpdateResponse

Contains response data for the update operation.

LocationsCheckNameAvailabilityResponse

Contains response data for the checkNameAvailability operation.

OperationsListNextResponse

Contains response data for the listNext operation.

OperationsListResponse

Contains response data for the list operation.

Origin

Defines values for Origin.
KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports.

Known values supported by the service

user
system
user,system

PrivateEndpointConnectionProvisioningState

Defines values for PrivateEndpointConnectionProvisioningState.
KnownPrivateEndpointConnectionProvisioningState can be used interchangeably with PrivateEndpointConnectionProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded
Creating
Deleting
Failed

PrivateEndpointConnectionsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

PrivateEndpointConnectionsGetResponse

Contains response data for the get operation.

PrivateEndpointConnectionsListByResourceResponse

Contains response data for the listByResource operation.

PrivateEndpointServiceConnectionStatus

Defines values for PrivateEndpointServiceConnectionStatus.
KnownPrivateEndpointServiceConnectionStatus can be used interchangeably with PrivateEndpointServiceConnectionStatus, this enum contains the known values that the service supports.

Known values supported by the service

Pending
Approved
Rejected

PrivateLinkResourcesGetResponse

Contains response data for the get operation.

PrivateLinkResourcesListByResourceResponse

Contains response data for the listByResource operation.

ProvisioningState

Defines values for ProvisioningState.
KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Creating
Updating
Deleting
Succeeded
Failed

PublicNetworkAccess

Defines values for PublicNetworkAccess.
KnownPublicNetworkAccess can be used interchangeably with PublicNetworkAccess, this enum contains the known values that the service supports.

Known values supported by the service

Enabled
Hybrid

Enums

KnownActionType

Known values of ActionType that the service accepts.

KnownCheckNameAvailabilityReason

Known values of CheckNameAvailabilityReason that the service accepts.

KnownCreatedByType

Known values of CreatedByType that the service accepts.

KnownOrigin

Known values of Origin that the service accepts.

KnownPrivateEndpointConnectionProvisioningState

Known values of PrivateEndpointConnectionProvisioningState that the service accepts.

KnownPrivateEndpointServiceConnectionStatus

Known values of PrivateEndpointServiceConnectionStatus that the service accepts.

KnownProvisioningState

Known values of ProvisioningState that the service accepts.

KnownPublicNetworkAccess

Known values of PublicNetworkAccess that the service accepts.

Functions

getContinuationToken(unknown)

Given a result page from a pageable operation, returns a continuation token that can be used to begin paging from that point later.

Function Details

getContinuationToken(unknown)

Given a result page from a pageable operation, returns a continuation token that can be used to begin paging from that point later.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

A result object from calling .byPage() on a paged operation.

Returns

string | undefined

The continuation token that can be passed into byPage().