@azure/arm-terraform package

Interfaces

AzureTerraformClientOptionalParams

Optional parameters for the client.

BaseExportModel

The base export parameter

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.

ExportQuery

Uses ARG (Azure Resource Graph) query to choose resources to be exported.

ExportResource

Specified resources to be exported by their ids.

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 an 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 (Long Running Operation) and the export result.

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.

AuthorizationScopeFilter

The Azure Resource Graph Authorization Scope Filter parameter
KnownAuthorizationScopeFilter can be used interchangeably with AuthorizationScopeFilter, this enum contains the known values that the service supports.

Known values supported by the service

AtScopeAndBelow: Returns assignments for the given scope and all child scopes.
AtScopeAndAbove: Returns assignments for the given scope and all parent scopes, but not child scopes.
AtScopeAboveAndBelow: Returns assignments for the given scope, all parent scopes, and all child scopes.
AtScopeExact: Returns assignments only for the given scope; no parent or child scopes are included.

AzureExtensionResourceType

The Azure extension resource type
KnownAzureExtensionResourceType can be used interchangeably with AzureExtensionResourceType, this enum contains the known values that the service supports.

Known values supported by the service

role-assignments: The Azure role assignment extension resource type
locks: The Azure lock extension resource type
diagnostic-settings: The Azure diagnostic settings extension resource type

AzureSupportedClouds

The supported values for cloud setting as a string literal type

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: 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.

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
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

AzureClouds

An enum to describe Azure Cloud environments.

KnownActionType

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

KnownAuthorizationScopeFilter

The Azure Resource Graph Authorization Scope Filter parameter

KnownAzureExtensionResourceType

The Azure extension resource type

KnownOrigin

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

KnownResourceProvisioningState

The provisioning state of a resource type.

KnownTargetProvider

The target Azure Terraform Provider

KnownType

The parameter type

KnownVersions

The available API versions.

Functions

isRestError(unknown)

Typeguard for RestError

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.

Variables

RestError

A custom error type for failed pipeline requests.

Function Details

isRestError(unknown)

Typeguard for RestError

function isRestError(e: unknown): e

Parameters

e

unknown

Something caught by a catch clause.

Returns

e

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

serializedState

string

sourceOperation

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

Returns

PollerLike<OperationState<TResult>, TResult>

Variable Details

RestError

A custom error type for failed pipeline requests.

RestError: RestErrorConstructor

Type