@azure/arm-terraform package

Classes

AzureTerraformClient

Interfaces

AzureTerraformClientOptionalParams	Optional parameters for the client.
BaseExportModel	The base export parameter
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ExportQuery	Export parameter for resources queried by ARG (Azure Resource Graph)
ExportResource	Export parameter for individual resources.
ExportResourceGroup	Export parameter for a resource group
ExportResult	The Terraform export result
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.
RestorePollerOptions
TerraformExportTerraformOptionalParams	Optional parameters.
TerraformOperationStatus	The status of the LRO operation.
TerraformOperations	Interface representing a Terraform operations.

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.
BaseExportModelUnion	Alias for BaseExportModelUnion
ContinuablePage	An interface that describes a page of results.
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 system user,system
ResourceProvisioningState	The provisioning state of a resource type. KnownResourceProvisioningState can be used interchangeably with ResourceProvisioningState, 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.
TargetProvider	The target Azure Terraform Provider <xref:KnowntargetProvider> can be used interchangeably with targetProvider, this enum contains the known values that the service supports. Known values supported by the service azurerm: https://registry.terraform.io/providers/hashicorp/azurerm/latest azapi: https://registry.terraform.io/providers/Azure/azapi/latest
Type	The parameter type KnownType can be used interchangeably with Type, this enum contains the known values that the service supports. Known values supported by the service ExportResource ExportResourceGroup ExportQuery

Enums

KnownActionType	Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
KnownOrigin	Known values of Origin that the service accepts.
KnownResourceProvisioningState	The provisioning state of a resource type.
KnownTargetProvider	The target Azure Terraform Provider
KnownType	The parameter type
KnownVersions	The available API versions.

Functions

restorePoller<TResponse, TResult>(AzureTerraformClient, 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>(AzureTerraformClient, 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: AzureTerraformClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

client

AzureTerraformClient

serializedState

string

sourceOperation

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

options

RestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>