@azure/arm-terraform package

Schnittstellen

AzureTerraformClientOptionalParams

Optionale Parameter für den Client.

BaseExportModel

Der Basisexportparameter

ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

ErrorDetail

Das Fehlerdetails.

ErrorResponse

Häufige Fehlerantwort für alle Azure Resource Manager-APIs, um Fehlerdetails für fehlgeschlagene Vorgänge zurückzugeben.

ExportQuery

Verwendet die ARG-Abfrage (Azure Resource Graph), um die zu exportierenden Ressourcen auszuwählen.

ExportResource

Angegebene Ressourcen, die nach ihren IDs exportiert werden sollen.

ExportResourceGroup

Exportparameter für eine Ressourcengruppe

ExportResult

Das Terraform-Exportergebnis

Operation

Details eines REST-API-Vorgangs, der von der Ressourcenanbieter-Operations-API zurückgegeben wird

OperationDisplay

Lokalisierte Anzeigeinformationen für eine Operation.

OperationsListOptionalParams

Optionale Parameter.

OperationsOperations

Schnittstelle, die vorgänge darstellt.

PageSettings

Optionen für die byPage-Methode

PagedAsyncIterableIterator

Eine Schnittstelle, die eine asynchrone iterierbare Iteration sowohl zum Abschluss als auch nach Seite ermöglicht.

RestorePollerOptions
TerraformExportTerraformOptionalParams

Optionale Parameter.

TerraformOperationStatus

Der Status des LRO (Long Running Operation) und das Exportergebnis.

TerraformOperations

Schnittstelle, die einen Terraform-Betrieb darstellt.

Typaliase

ActionType

Erweiterbare Enumeration. Gibt den Aktionstyp an. "Intern" bezieht sich auf Aktionen, die nur für interne APIs gelten.
KnownActionType- austauschbar mit ActionType verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt.

Bekannte Werte, die vom Dienst unterstützt werden

Interne: Aktionen gelten nur für interne APIs.

AuthorizationScopeFilter

Der Azure Resource Graph Authorization Scope Filter Parameter
KnownAuthorizationScopeFilter kann austauschbar mit AuthorizationScopeFilter verwendet werden; dieses Enum enthält die bekannten Werte, die der Dienst unterstützt.

Bekannte Werte, die vom Dienst unterstützt werden

AtScopeAndBelow: Gibt Zuweisungen für den gegebenen Scope und alle untergeordneten Scopes zurück.
AtScopeAndAbove: Gibt Zuweisungen für den gegebenen Umfang und alle übergeordneten Scopes zurück, aber keine Kind-Scopes.
AtScopeAboveAndBelow: Gibt Zuweisungen für den gegebenen Scope, alle Elternscopes und alle Kindscopes zurück.
AtScopeExact: Gibt Zuweisungen nur für den gegebenen Umfang zurück; Es sind keine Teleskope für Eltern oder Kinder enthalten.

AzureExtensionResourceType

Der Azure Extension resource type
KnownAzureExtensionResourceType kann austauschbar mit AzureExtensionResourceType verwendet werden; dieses Enum enthält die bekannten Werte, die der Dienst unterstützt.

Bekannte Werte, die vom Dienst unterstützt werden

role-assignments: Der Azure role assignment extension resource type
locks: Der Azure Lock Extension Resource Type
diagnostic-settings: Der Ressourcentyp der Azure-Diagnoseeinstellungen-Erweiterung

AzureSupportedClouds

Die unterstützten Werte für die Cloud-Einstellung als Zeichenfolgenliteraltyp

BaseExportModelUnion

Alias für BaseExportModelUnion

ContinuablePage

Eine Schnittstelle, die eine Seite mit Ergebnissen beschreibt.

Origin

Der beabsichtigte Ausführungsführer des Vorgangs; wie bei der ressourcenbasierten Zugriffssteuerung (Resource Based Access Control, RBAC) und der UX für Überwachungsprotokolle. Standardwert ist "User,System"
KnownOrigin austauschbar mit Origin verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt.

Bekannte Werte, die vom Dienst unterstützt werden

Benutzer-: Gibt an, dass der Vorgang von einem Benutzer initiiert wird.
System-: Gibt an, dass der Vorgang von einem System initiiert wird.
Benutzer,System: Gibt an, dass der Vorgang von einem Benutzer oder System initiiert wird.

ResourceProvisioningState

Der Bereitstellungsstatus eines Ressourcentyps.
KnownResourceProvisioningState austauschbar mit ResourceProvisioningState verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt.

Bekannte Werte, die vom Dienst unterstützt werden

Erfolgreich: Ressource wurde erstellt.
Fehlgeschlagene: Fehler bei der Ressourcenerstellung.
Abgebrochene: Die Ressourcenerstellung wurde abgebrochen.

TargetProvider

Der Azure Terraform-Zielanbieter
KnownTargetProvider kann austauschbar mit TargetProvider verwendet werden, dieses Enum enthält die bekannten Werte, die der Dienst unterstützt.

Bekannte Werte, die vom Dienst unterstützt werden

Azurerm: https://registry.terraform.io/providers/hashicorp/azurerm/latest
Azapi: https://registry.terraform.io/providers/Azure/azapi/latest

Type

Der Parametertyp
KnownType austauschbar mit Type verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt.

Bekannte Werte, die vom Dienst unterstützt werden

ExportResource-
ExportResourceGroup-
ExportQuery-

Enumerationen

AzureClouds

Eine Enumeration zur Beschreibung von Azure Cloud-Umgebungen.

KnownActionType

Erweiterbare Enumeration. Gibt den Aktionstyp an. "Intern" bezieht sich auf Aktionen, die nur für interne APIs gelten.

KnownAuthorizationScopeFilter

Der Parameter Azure Resource Graph-Autorisierungsbereichsfilter

KnownAzureExtensionResourceType

Der Azure Extension resource type

KnownOrigin

Der beabsichtigte Ausführungsführer des Vorgangs; wie bei der ressourcenbasierten Zugriffssteuerung (Resource Based Access Control, RBAC) und der UX für Überwachungsprotokolle. Standardwert ist "User,System"

KnownResourceProvisioningState

Der Bereitstellungsstatus eines Ressourcentyps.

KnownTargetProvider

Der Azure Terraform-Zielanbieter

KnownType

Der Parametertyp

KnownVersions

Die verfügbaren API-Versionen.

Functions

isRestError(unknown)

Typeguard für RestError

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

Erstellt einen Poller aus dem serialisierten Zustand eines anderen Pollers. Dies kann nützlich sein, wenn Sie Umfragen auf einem anderen Host erstellen möchten oder ein Poller erstellt werden muss, nachdem das ursprüngliche Abfragefeld nicht im Gültigkeitsbereich liegt.

Variablen

RestError

Ein benutzerdefinierter Fehlertyp für fehlgeschlagene Pipelineanforderungen.

Details zur Funktion

isRestError(unknown)

Typeguard für RestError

function isRestError(e: unknown): e

Parameter

e

unknown

Etwas, das von einer Catch-Klausel abgefangen wird.

Gibt zurück

e

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

Erstellt einen Poller aus dem serialisierten Zustand eines anderen Pollers. Dies kann nützlich sein, wenn Sie Umfragen auf einem anderen Host erstellen möchten oder ein Poller erstellt werden muss, nachdem das ursprüngliche Abfragefeld nicht im Gültigkeitsbereich liegt.

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

Parameter

serializedState

string

sourceOperation

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

Gibt zurück

PollerLike<OperationState<TResult>, TResult>

Details zu Variablen

RestError

Ein benutzerdefinierter Fehlertyp für fehlgeschlagene Pipelineanforderungen.

RestError: RestErrorConstructor

Typ