@azure/arm-resourcesdeploymentstacks package

インターフェイス

ActionOnUnmanage

スタックの更新または削除後に管理されなくなったリソースの動作を定義します。

DenySettings

デプロイ スタックによってデプロイされたリソースをロックする方法を定義します。

DeploymentExtension

デプロイメント拡張の利用に関する詳細。

DeploymentExtensionConfig

デプロイ拡張の設定。 このオブジェクトのキーは拡張の設定スキーマと一致しているはずです。

DeploymentExtensionConfigItem

拡張設定プロパティの値や値を取得する方法についてです。

DeploymentExternalInput

パラメーター化のためのデプロイメント外部入力。

DeploymentExternalInputDefinition

パラメーター化のためのデプロイメント外部入力定義。

DeploymentParameter

テンプレートのデプロイ パラメーター。

DeploymentStack

デプロイ スタック オブジェクト。

DeploymentStackProperties

デプロイ スタックのプロパティ。

DeploymentStackTemplateDefinition

デプロイ スタックのテンプレート固有のプロパティをエクスポートします。

DeploymentStackValidateProperties

デプロイ スタック検証の結果の詳細。

DeploymentStackValidateResult

デプロイ スタックの検証結果。

DeploymentStacksChangeBase

プロパティのベースモデルで、ビフォー・アフタープロパティ値を持つ。

DeploymentStacksChangeBaseDenyStatusMode

プロパティのベースモデルで、ビフォー・アフタープロパティ値を持つ。

DeploymentStacksChangeBaseDeploymentStacksManagementStatus

プロパティのベースモデルで、ビフォー・アフタープロパティ値を持つ。

DeploymentStacksChangeDeltaDenySettings

モデルはビフォーアフターのプロパティ価値とそれらの間の差を示します。

DeploymentStacksChangeDeltaRecord

モデルはビフォーアフターのプロパティ価値とそれらの間の差を示します。

DeploymentStacksClientOptionalParams

クライアントのオプションのパラメーター。

DeploymentStacksCreateOrUpdateAtManagementGroupOptionalParams

省略可能なパラメーター。

DeploymentStacksCreateOrUpdateAtResourceGroupOptionalParams

省略可能なパラメーター。

DeploymentStacksCreateOrUpdateAtSubscriptionOptionalParams

省略可能なパラメーター。

DeploymentStacksDebugSetting

デバッグ設定。

DeploymentStacksDeleteAtManagementGroupOptionalParams

省略可能なパラメーター。

DeploymentStacksDeleteAtResourceGroupOptionalParams

省略可能なパラメーター。

DeploymentStacksDeleteAtSubscriptionOptionalParams

省略可能なパラメーター。

DeploymentStacksDiagnostic

エラーの追加情報

DeploymentStacksExportTemplateAtManagementGroupOptionalParams

省略可能なパラメーター。

DeploymentStacksExportTemplateAtResourceGroupOptionalParams

省略可能なパラメーター。

DeploymentStacksExportTemplateAtSubscriptionOptionalParams

省略可能なパラメーター。

DeploymentStacksGetAtManagementGroupOptionalParams

省略可能なパラメーター。

DeploymentStacksGetAtResourceGroupOptionalParams

省略可能なパラメーター。

DeploymentStacksGetAtSubscriptionOptionalParams

省略可能なパラメーター。

DeploymentStacksListAtManagementGroupOptionalParams

省略可能なパラメーター。

DeploymentStacksListAtResourceGroupOptionalParams

省略可能なパラメーター。

DeploymentStacksListAtSubscriptionOptionalParams

省略可能なパラメーター。

DeploymentStacksOperations

DeploymentStacks操作を表すインターフェース。

DeploymentStacksParametersLink

デプロイ パラメーターへの参照を表すエンティティ。

DeploymentStacksTemplateLink

テンプレートへの参照を表すエンティティ。

DeploymentStacksValidateStackAtManagementGroupOptionalParams

省略可能なパラメーター。

DeploymentStacksValidateStackAtResourceGroupOptionalParams

省略可能なパラメーター。

DeploymentStacksValidateStackAtSubscriptionOptionalParams

省略可能なパラメーター。

DeploymentStacksWhatIfChange

もしも演算の結果として展開スタックに予測される変化。

DeploymentStacksWhatIfPropertyChange

リソース プロパティに対する予測された変更。

DeploymentStacksWhatIfResourceChange

What-If 操作によって予測される単一のリソース変更に関する情報。

DeploymentStacksWhatIfResult

デプロイ スタック オブジェクト。

DeploymentStacksWhatIfResultProperties

DeploymentStack WhatIfResult プロパティ

DeploymentStacksWhatIfResultsAtManagementGroupCreateOrUpdateOptionalParams

省略可能なパラメーター。

DeploymentStacksWhatIfResultsAtManagementGroupDeleteOptionalParams

省略可能なパラメーター。

DeploymentStacksWhatIfResultsAtManagementGroupGetOptionalParams

省略可能なパラメーター。

DeploymentStacksWhatIfResultsAtManagementGroupListOptionalParams

省略可能なパラメーター。

DeploymentStacksWhatIfResultsAtManagementGroupOperations

StacksWhatIfResultsAtManagementGroupの運用を表す展開を表現するインターフェース。

DeploymentStacksWhatIfResultsAtManagementGroupWhatIfOptionalParams

省略可能なパラメーター。

DeploymentStacksWhatIfResultsAtResourceGroupCreateOrUpdateOptionalParams

省略可能なパラメーター。

DeploymentStacksWhatIfResultsAtResourceGroupDeleteOptionalParams

省略可能なパラメーター。

DeploymentStacksWhatIfResultsAtResourceGroupGetOptionalParams

省略可能なパラメーター。

DeploymentStacksWhatIfResultsAtResourceGroupListOptionalParams

省略可能なパラメーター。

DeploymentStacksWhatIfResultsAtResourceGroupOperations

DeploymentStacksWhatIfResultsAtResourceGroup操作を表すインターフェース。

DeploymentStacksWhatIfResultsAtResourceGroupWhatIfOptionalParams

省略可能なパラメーター。

DeploymentStacksWhatIfResultsAtSubscriptionCreateOrUpdateOptionalParams

省略可能なパラメーター。

DeploymentStacksWhatIfResultsAtSubscriptionDeleteOptionalParams

省略可能なパラメーター。

DeploymentStacksWhatIfResultsAtSubscriptionGetOptionalParams

省略可能なパラメーター。

DeploymentStacksWhatIfResultsAtSubscriptionListOptionalParams

省略可能なパラメーター。

DeploymentStacksWhatIfResultsAtSubscriptionOperations

DeploymentStacksWhatIfResultsAtSubscription操作を表すインターフェース。

DeploymentStacksWhatIfResultsAtSubscriptionWhatIfOptionalParams

省略可能なパラメーター。

ErrorAdditionalInfo

リソース管理エラーの追加情報。

ErrorDetail

エラーの詳細。

ErrorResponse

すべてのAzure Resource Manager APIで失敗した操作に対してエラー詳細を返す共通のエラー応答です。

KeyVaultParameterReference

Azure Key Vault パラメーターリファレンス。

KeyVaultReference

Azure Key Vault リファレンス。

ManagedResourceReference

マネージド リソース モデル。

PageSettings

byPage メソッドのオプション

PagedAsyncIterableIterator

完了まで、およびページごとに非同期反復可能な反復を許可するインターフェイス。

ProxyResource

Azure Resource Manager プロキシ リソースのリソース モデル定義。 タグと場所はありません

Resource

すべての Azure Resource Manager リソースの応答で返される共通フィールド

ResourceReference

resourceId モデル。

ResourceReferenceExtended

resourceId 拡張モデル。 これは、失敗したリソースを resourceId とそれに対応するエラーで文書化するために使用されます。

RestorePollerOptions
SimplePollerLike

実行時間の長い操作をポーリングするために使用できる単純なポーリングツール。

SystemData

リソースの作成と最後の変更に関連するメタデータ。

型エイリアス

AzureSupportedClouds

文字列リテラル型としてのクラウド設定でサポートされている値

ContinuablePage

結果のページを記述するインターフェース。

CreatedByType

リソースを作成したエンティティの種類。
KnownCreatedByType を CreatedByType と同じ意味で使用できる、この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

ユーザー: エンティティはユーザーによって作成されました。
アプリケーション: エンティティはアプリケーションによって作成されました。
ManagedIdentity: エンティティはマネージド ID によって作成されました。
キー: エンティティはキーによって作成されました。

DenySettingsMode

denySettingsは、拒否されたアクションを定義するモードです。
KnownDenySettingsMode DenySettingsMode と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

denyDelete: 承認されたユーザーはリソースの読み取りと変更を行うことができますが、削除することはできません。
denyWriteAndDelete : 承認されたユーザーはリソースから読み取ることができますが、変更または削除することはできません。
なし: denyAssignment は適用されていません。

DenyStatusMode

リソースに適用される denyAssignment 設定。
KnownDenyStatusMode DenyStatusMode と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

denyDelete: 承認されたユーザーはリソースの読み取りと変更を行うことができますが、削除することはできません。
notSupported: リソースの種類は denyAssignments をサポートしていません。
適用できない: denyAssignments は、デプロイ スタックのスコープ外のリソースではサポートされていません。
denyWriteAndDelete: 承認されたユーザーはリソースからのみ読み取ることができますが、変更または削除することはできません。
removedBySystem: リソース管理の変更 (管理グループの移動など) により、割り当ての拒否が Azure によって削除されました
なし: denyAssignment は適用されていません。
不明:割り当て拒否の状況は不明です。

DeploymentStackProvisioningState

デプロイ スタックの状態。
KnownDeploymentStackProvisioningState DeploymentStackProvisioningState と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

作成中:現在、デプロイスタックが作成されています
検証中:展開スタックは現在検証中です
待機中:展開スタックは現在待機中です
展開中:展開スタックは現在展開中です
キャンセル中:展開スタックがキャンセルされます
更新拒否割り当て:デプロイスタックが拒否割り当てを更新しています
deletingResources:デプロイスタックがリソースを削除しています
成功:展開スタックが成功裏に完了しました
失敗:デプロイスタックが失敗しました
キャンセル:展開スタックがキャンセルされました
削除:デプロイスタックが削除されています
初期化中:展開スタックが現在初期化中です
実行中:デプロイメントスタックが現在操作を実行しています

DeploymentStacksDiagnosticLevel

追加の応答レベルを示します。
KnownDeploymentStacksDiagnosticLevel はDeploymentStacksDiagnosticLevelと同義で使用可能で、この列挙はサービスがサポートする既知の値を示します。

サービスでサポートされている既知の値

情報:情報提供メッセージ。
警告:警告メッセージ。
エラー:エラーメッセージ。

DeploymentStacksManagementStatus

デプロイスタックリソースの管理状況。
KnownDeploymentStacksManagementStatus はDeploymentStacksManagementStatusと同義使用可能で、この列挙はサービスがサポートする既知の値を含む。

サービスでサポートされている既知の値

管理されている:リソースはデプロイスタックによって管理されます。
管理されていない:リソースはデプロイスタックによって管理されません。
不明:資源の管理状態は特定できません。

DeploymentStacksWhatIfChangeCertainty

は予測変化の信頼レベルを表します。
KnownDeploymentStacksWhatIfChangeCertainty はDeploymentStacksWhatIfChangeCertaintyと同義使用可能であり、この列挙はサービスがサポートする既知の値を含む。

サービスでサポートされている既知の値

確定:変化は確実です。
潜在的:展開時の条件によって変更が起こるかどうかは不明です。

DeploymentStacksWhatIfChangeType

デプロイの実行時にリソースに対して行われる変更の種類。
KnownDeploymentStacksWhatIfChangeType はDeploymentStacksWhatIfChangeTypeと互換的に使用できます。この列挙はサービスがサポートする既知の値を含む。

サービスでサポートされている既知の値

create:リソースは現在の状態には存在せず、望ましい状態に存在します。 デプロイの実行時にリソースが作成されます。
delete:リソースは現在の状態に存在し、目的の状態から欠けています。 デプロイメントが実行されると、リソースはAzureから削除されます。
切り離す:リソースは現在の状態に存在し、望ましい状態からは欠けています。 リソースはデプロイスタックから削除されますが、デプロイメント実行後はAzureに残ります。
修正:リソースは現在の状態かつ望ましい状態に存在し、展開が実行されると再デプロイされます。 リソースのプロパティが変更されます。
noChange:リソースは現在の状態かつ望ましい状態にあり、デプロイが実行されると再デプロイされます。 リソースのプロパティは変更されません。
サポートなし:このリソースはWhat-Ifでサポートされていません。

DeploymentStacksWhatIfPropertyChangeType

プロパティの変更の種類。
KnownDeploymentStacksWhatIfPropertyChangeType はDeploymentStacksWhatIfPropertyChangeTypeと互換的に使用可能で、この列挙はサービスがサポートする既知の値を含む。

サービスでサポートされている既知の値

array: プロパティは配列であり、ネストされた変更を含みます。
創造:プロパティは現在の状態には存在せず、望ましい状態には存在します。 このプロパティは、デプロイの実行時に作成されます。
delete:プロパティは現在の状態に存在し、目的の状態には欠けています。 デプロイの実行時に削除されます。
修正:性質は現在状態と望ましい状態の両方に存在し、異なる。 プロパティの値は、デプロイの実行時に変更されます。
noEffect:プロパティは設定も更新もされません。

ResourceStatusMode

デプロイ スタック内のリソースの現在の管理状態。
KnownResourceStatusMode ResourceStatusMode と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

マネージド: このリソースはデプロイ スタックによって管理されます。
removeDenyFailed: リソースの拒否割り当てを削除できません。
deleteFailed: Azure からリソースを削除できません。 削除は、次のスタックデプロイで再試行されるか、手動で削除できます。

ResourcesWithoutDeleteSupportAction

削除をサポートしないリソースに対してアクションを指定します。
KnownResourcesWithoutDeleteSupportAction はResourcesWithoutDeleteSupportActionと互換的に使用可能で、この列挙にはサービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

デタッチ:指定されたリソースをデプロイスタックから切り離し、続行します。
失敗:リソースを削除できない場合はデプロイスタックに失敗します。

UnmanageActionManagementGroupMode

新しく管理されていないリソースに対するアクションを指定します。
KnownUnmanageActionManagementGroupMode UnmanageActionManagementGroupMode と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

delete:Azureから管理グループを削除します。
detach:管理グループは引き続きAzureに保て。

UnmanageActionResourceGroupMode

新たに管理されていないリソースグループのためのアクションを指定します。
KnownUnmanageActionResourceGroupMode UnmanageActionResourceGroupMode と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

delete:Azureからリソースグループを削除します。
detach:リソースグループはAzureに入れておく。

UnmanageActionResourceMode

新しく管理されていないリソースに対するアクションを指定します。
KnownUnmanageActionResourceMode UnmanageActionResourceMode と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

delete: Azureからリソースを削除してください
detach:資源は保持Azure

ValidationLevel

デプロイメントで実行される検証のレベル。
KnownValidationLevel は ValidationLevel と同じ意味で使用でき、この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

テンプレート: テンプレートの静的分析が実行されます。
プロバイダー: テンプレートの静的分析が実行され、セマンティック検証のためにリソース宣言がリソース プロバイダーに送信されます。 呼び出し元が各リソースに対する RBAC 書き込みアクセス許可を持っていることを検証します。
ProviderNoRbac: テンプレートの静的分析が実行され、セマンティック検証のためにリソース宣言がリソース プロバイダーに送信されます。 呼び出し元が各リソースに対する RBAC 書き込みアクセス許可を持っているかどうかの検証をスキップします。

列挙型

AzureClouds

Azure Cloud 環境を説明するための列挙式です。

KnownCreatedByType

リソースを作成したエンティティの種類。

KnownDenySettingsMode

denySettingsは、拒否されたアクションを定義するモードです。

KnownDenyStatusMode

リソースに適用される denyAssignment 設定。

KnownDeploymentStackProvisioningState

デプロイ スタックの状態。

KnownDeploymentStacksDiagnosticLevel

追加の応答レベルを示します。

KnownDeploymentStacksManagementStatus

デプロイスタックリソースの管理状況。

KnownDeploymentStacksWhatIfChangeCertainty

は予測変化の信頼レベルを表します。

KnownDeploymentStacksWhatIfChangeType

デプロイの実行時にリソースに対して行われる変更の種類。

KnownDeploymentStacksWhatIfPropertyChangeType

プロパティの変更の種類。

KnownResourceStatusMode

デプロイ スタック内のリソースの現在の管理状態。

KnownResourcesWithoutDeleteSupportAction

削除をサポートしないリソースに対してアクションを指定します。

KnownUnmanageActionManagementGroupMode

新しく管理されていないリソースに対するアクションを指定します。

KnownUnmanageActionResourceGroupMode

新たに管理されていないリソースグループのためのアクションを指定します。

KnownUnmanageActionResourceMode

新しく管理されていないリソースに対するアクションを指定します。

KnownValidationLevel

デプロイメントで実行される検証のレベル。

KnownVersions

使用可能な API バージョン。

関数

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

別のポーラーのシリアル化された状態からポーラーを作成します。 これは、別のホストにポーラーを作成する場合や、元のポーラーがスコープ内にない後にポーラーを構築する必要がある場合に便利です。

関数の詳細

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

別のポーラーのシリアル化された状態からポーラーを作成します。 これは、別のホストにポーラーを作成する場合や、元のポーラーがスコープ内にない後にポーラーを構築する必要がある場合に便利です。

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

パラメーター

serializedState

string

sourceOperation

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

返品

PollerLike<OperationState<TResult>, TResult>