@azure/arm-resourcesdeployments package

クラス

DeploymentsClient

インターフェイス

Alias

エイリアスの種類。

AliasPath

エイリアスのパスの型。

AliasPathMetadata

model interface aliasPathMetadata

AliasPattern

エイリアス パスのパターンの型。

ApiProfile

モデルインターフェースApiProfile

BasicDependency

デプロイの依存関係情報。

CloudError

リソース管理要求のエラー応答。

DebugSetting

デバッグ設定。

Dependency

デプロイの依存関係情報。

Deployment

デプロイ操作のパラメーター。

DeploymentDiagnosticsDefinition

モデルインターフェース デプロイ診断定義

DeploymentExportResult

デプロイのエクスポート結果。

DeploymentExtended

デプロイ情報。

DeploymentExtensionConfigItem

model interface DeploymentExtensionConfigItem

DeploymentExtensionDefinition

モデルインターフェース デプロイ拡張定義

DeploymentExternalInput

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

DeploymentExternalInputDefinition

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

DeploymentIdentity

デプロイのマネージド ID 構成。

DeploymentOperation

デプロイ操作の情報。

DeploymentOperationProperties

展開操作のプロパティ。

DeploymentOperationsGetAtManagementGroupScopeOptionalParams

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

DeploymentOperationsGetAtScopeOptionalParams

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

DeploymentOperationsGetAtSubscriptionScopeOptionalParams

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

DeploymentOperationsGetAtTenantScopeOptionalParams

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

DeploymentOperationsGetOptionalParams

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

DeploymentOperationsListAtManagementGroupScopeOptionalParams

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

DeploymentOperationsListAtScopeOptionalParams

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

DeploymentOperationsListAtSubscriptionScopeOptionalParams

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

DeploymentOperationsListAtTenantScopeOptionalParams

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

DeploymentOperationsListOptionalParams

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

DeploymentOperationsOperations

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

DeploymentParameter

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

DeploymentProperties

展開のプロパティ。

DeploymentPropertiesExtended

追加の詳細を含む展開プロパティ。

DeploymentValidateResult

検証テンプレートのデプロイ応答からの情報。

DeploymentWhatIf

デプロイの What-if 操作パラメーター。

DeploymentWhatIfProperties

配置の What-if プロパティ。

DeploymentWhatIfSettings

展開 What-If 操作の設定。

DeploymentsCalculateTemplateHashOptionalParams

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

DeploymentsCancelAtManagementGroupScopeOptionalParams

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

DeploymentsCancelAtScopeOptionalParams

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

DeploymentsCancelAtSubscriptionScopeOptionalParams

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

DeploymentsCancelAtTenantScopeOptionalParams

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

DeploymentsCancelOptionalParams

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

DeploymentsCheckExistenceAtManagementGroupScopeOptionalParams

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

DeploymentsCheckExistenceAtScopeOptionalParams

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

DeploymentsCheckExistenceAtSubscriptionScopeOptionalParams

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

DeploymentsCheckExistenceAtTenantScopeOptionalParams

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

DeploymentsCheckExistenceOptionalParams

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

DeploymentsClientOptionalParams

クライアントの省略可能なパラメーター。

DeploymentsCreateOrUpdateAtManagementGroupScopeOptionalParams

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

DeploymentsCreateOrUpdateAtScopeOptionalParams

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

DeploymentsCreateOrUpdateAtSubscriptionScopeOptionalParams

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

DeploymentsCreateOrUpdateAtTenantScopeOptionalParams

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

DeploymentsCreateOrUpdateOptionalParams

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

DeploymentsDeleteAtManagementGroupScopeOptionalParams

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

DeploymentsDeleteAtScopeOptionalParams

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

DeploymentsDeleteAtSubscriptionScopeOptionalParams

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

DeploymentsDeleteAtTenantScopeOptionalParams

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

DeploymentsDeleteOptionalParams

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

DeploymentsExportTemplateAtManagementGroupScopeOptionalParams

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

DeploymentsExportTemplateAtScopeOptionalParams

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

DeploymentsExportTemplateAtSubscriptionScopeOptionalParams

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

DeploymentsExportTemplateAtTenantScopeOptionalParams

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

DeploymentsExportTemplateOptionalParams

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

DeploymentsGetAtManagementGroupScopeOptionalParams

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

DeploymentsGetAtScopeOptionalParams

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

DeploymentsGetAtSubscriptionScopeOptionalParams

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

DeploymentsGetAtTenantScopeOptionalParams

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

DeploymentsGetOptionalParams

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

DeploymentsListAtManagementGroupScopeOptionalParams

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

DeploymentsListAtScopeOptionalParams

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

DeploymentsListAtSubscriptionScopeOptionalParams

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

DeploymentsListAtTenantScopeOptionalParams

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

DeploymentsListByResourceGroupOptionalParams

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

DeploymentsOperations

デプロイメント操作を表すインタフェース。

DeploymentsValidateAtManagementGroupScopeOptionalParams

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

DeploymentsValidateAtScopeOptionalParams

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

DeploymentsValidateAtSubscriptionScopeOptionalParams

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

DeploymentsValidateAtTenantScopeOptionalParams

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

DeploymentsValidateOptionalParams

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

DeploymentsWhatIfAtManagementGroupScopeOptionalParams

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

DeploymentsWhatIfAtSubscriptionScopeOptionalParams

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

DeploymentsWhatIfAtTenantScopeOptionalParams

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

DeploymentsWhatIfOptionalParams

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

ErrorAdditionalInfo

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

ErrorResponse

失敗した操作のエラーの詳細を返す、すべての Azure Resource Manager API の一般的なエラー応答。 (これは、OData エラー応答形式にも従います)。

ExpressionEvaluationOptions

親テンプレートのスコープ内でテンプレート式を評価するか、入れ子になったテンプレートを評価するかを指定します。

ExtensionResource

基本拡張機能リソース。

HttpMessage

HTTP メッセージ。

KeyVaultParameterReference

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

KeyVaultReference

Azure Key Vault リファレンス。

OnErrorDeployment

エラー動作でのデプロイ。

OnErrorDeploymentExtended

追加の詳細を含むエラー動作でのデプロイ。

PageSettings

byPage メソッドのオプション

PagedAsyncIterableIterator

完了とページごとの非同期反復を可能にするインターフェイス。

ParametersLink

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

Provider

リソース プロバイダー情報。

ProviderExtendedLocation

プロバイダーの拡張場所。

ProviderResourceType

リソース プロバイダーによって管理されるリソースの種類。

Resource

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

ResourceReference

リソース ID モデル。

RestorePollerOptions
ScopedDeployment

デプロイ操作のパラメーター。

ScopedDeploymentWhatIf

デプロイの What-if 操作パラメーター。

SimplePollerLike

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

StatusMessage

操作の状態メッセージ オブジェクト。

SystemData

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

TargetResource

ターゲット リソース。

TemplateHashResult

テンプレート ハッシュを計算する要求の結果。 縮小されたテンプレートとそのハッシュの文字列が含まれています。

TemplateLink

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

UserAssignedIdentity

ユーザー割り当て ID プロパティ

WhatIfChange

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

WhatIfOperationProperties

展開操作のプロパティ。

WhatIfOperationResult

What-If 操作の結果。 予測された変更の一覧と、次の結果セットにアクセスするための URL リンクが含まれています。

WhatIfPropertyChange

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

ZoneMapping

モデルインターフェースゾーンマッピング

型エイリアス

AliasPathAttributes

エイリアス パスが参照しているトークンの属性。
KnownAliasPathAttributes を AliasPathAttributes と同じ意味で使用できる、この列挙型には、サービスがサポートする既知の値が含まれています。

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

None: エイリアス パスが参照しているトークンに属性がありません。
変更可能な: エイリアス パスが参照しているトークンは、'modify' 効果を持つポリシーによって変更できます。

AliasPathTokenType

エイリアス パスが参照しているトークンの型。
KnownAliasPathTokenType AliasPathTokenType と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。

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

NotSpecified: トークンの種類が指定されていません。
任意の: トークンの種類は何でもかまいません。
文字列: トークンの種類は文字列です。
オブジェクト: トークンの種類はオブジェクトです。
配列: トークン型は配列です。
整数: トークンの種類は整数です。
数値: トークンの種類は number です。
Boolean: トークンの種類はブール値です。

AliasPatternType

エイリアス パターンの種類

AliasType

エイリアスの型。

AzureSupportedClouds

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

ChangeType

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

ContinuablePage

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

CreatedByType

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

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

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

DeploymentIdentityType

ID の種類。
KnownDeploymentIdentityType は DeploymentIdentityType と同じ意味で使用でき、この列挙型にはサービスがサポートする既知の値が含まれています。

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

なし:なし
UserAssigned: UserAssigned(ユーザー割り当て)

DeploymentMode

リソースのデプロイに使用されるモード。 この値には、Incremental または Complete のいずれかを指定できます。 増分モードでは、テンプレートに含まれていない既存のリソースを削除せずにリソースがデプロイされます。 完全モードでは、リソースがデプロイされ、テンプレートに含まれていないリソース グループ内の既存のリソースが削除されます。 リソースを誤って削除する可能性があるため、完全モードを使用する場合は注意してください。

DeploymentsCheckExistenceAtManagementGroupScopeResponse
DeploymentsCheckExistenceAtScopeResponse
DeploymentsCheckExistenceAtSubscriptionScopeResponse
DeploymentsCheckExistenceAtTenantScopeResponse
DeploymentsCheckExistenceResponse
ExpressionEvaluationOptionsScopeType

入れ子になったテンプレート内のパラメーター、変数、関数の評価に使用するスコープ。
KnownExpressionEvaluationOptionsScopeType ExpressionEvaluationOptionsScopeType と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。

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

指定されていない:指定されていない
外側:外側
内側:内側

ExtensionConfigPropertyType

ExtensionConfigPropertyType のタイプ

Level

追加の応答レベルを示します。
KnownLevel を Level と同じ意味で使用できる 、この列挙型には、サービスがサポートする既知の値が含まれています。

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

警告:警告
情報:情報
エラー:エラー

OnErrorDeploymentType

エラー動作の種類でのデプロイ。 指定できる値は LastSuccessful と SpecificDeployment です。

PropertyChangeType

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

ProviderAuthorizationConsentState

プロバイダー承認の同意の状態。
KnownProviderAuthorizationConsentState ProviderAuthorizationConsentState と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。

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

指定されていない:指定されていない
必須:必須
不要:不要
同意:同意

ProvisioningOperation

現在のプロビジョニング操作の名前。

ProvisioningState

プロビジョニングの状態を示します。
KnownProvisioningState ProvisioningState と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。

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

指定されていない:指定されていない
受け入れられる: 受け入れられる
ランニング:ランニング
準備完了:準備完了
作成:作成
創造:創造された
削除: 削除
削除済み:削除済み
キャンセル:キャンセル
失敗: 失敗
成功:成功
更新:更新中

ValidationLevel

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

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

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

WhatIfResultFormat

What-If 結果の形式

列挙型

AzureClouds

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

KnownAliasPathAttributes

エイリアス パスが参照しているトークンの属性。

KnownAliasPathTokenType

エイリアス パスが参照しているトークンの型。

KnownCreatedByType

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

KnownDeploymentIdentityType

ID の種類。

KnownExpressionEvaluationOptionsScopeType

入れ子になったテンプレート内のパラメーター、変数、関数の評価に使用するスコープ。

KnownExtensionConfigPropertyType

サービスが受け入れる ExtensionConfigPropertyType の既知の値。

KnownLevel

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

KnownProviderAuthorizationConsentState

プロバイダー承認の同意の状態。

KnownProvisioningState

プロビジョニングの状態を示します。

KnownValidationLevel

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

KnownVersions

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

関数

isRestError(unknown)

RestError の Typeguard

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

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

変数

RestError

失敗したパイプライン要求のカスタム エラーの種類。

関数の詳細

isRestError(unknown)

RestError の Typeguard

function isRestError(e: unknown): e

パラメーター

e

unknown

catch 句によってキャッチされる何か。

返品

e

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

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

function restorePoller<TResponse, TResult>(client: DeploymentsClient, 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>

変数の詳細

RestError

失敗したパイプライン要求のカスタム エラーの種類。

RestError: RestErrorConstructor