@azure/arm-resourcesdeployments package

介面

Alias

別名類型。

AliasPath

別名的路徑類型。

AliasPathMetadata

模型介面 AliasPathMetadata

AliasPattern

別名路徑的模式類型。

ApiProfile

模型介面 ApiProfile

BasicDependency

部署相依性資訊。

CloudError

資源管理要求的錯誤回應。

DebugSetting

偵錯設定。

Dependency

部署相依性資訊。

Deployment

部署作業參數。

DeploymentDiagnosticsDefinition

模型介面 部署診斷定義

DeploymentExportResult

部署匯出結果。

DeploymentExtended

部署資訊。

DeploymentExtensionConfigItem

model interface DeploymentExtensionConfigItem

DeploymentExtensionDefinition

模型介面 DeploymentExtensionDefinition

DeploymentExternalInput

部署外部輸入以進行參數化。

DeploymentExternalInputDefinition

部署用於參數化的外部輸入定義。

DeploymentIdentity

部署的託管標識配置。

DeploymentOperation

部署作業資訊。

DeploymentOperationProperties

部署作業屬性。

DeploymentOperationsGetAtManagementGroupScopeOptionalParams

選擇性參數。

DeploymentOperationsGetAtScopeOptionalParams

選擇性參數。

DeploymentOperationsGetAtSubscriptionScopeOptionalParams

選擇性參數。

DeploymentOperationsGetAtTenantScopeOptionalParams

選擇性參數。

DeploymentOperationsGetOptionalParams

選擇性參數。

DeploymentOperationsListAtManagementGroupScopeOptionalParams

選擇性參數。

DeploymentOperationsListAtScopeOptionalParams

選擇性參數。

DeploymentOperationsListAtSubscriptionScopeOptionalParams

選擇性參數。

DeploymentOperationsListAtTenantScopeOptionalParams

選擇性參數。

DeploymentOperationsListOptionalParams

選擇性參數。

DeploymentOperationsOperations

介面代表部署作業。

DeploymentParameter

範本的部署參數。

DeploymentProperties

部署屬性。

DeploymentPropertiesExtended

具有其他詳細數據的部署屬性。

DeploymentValidateResult

來自驗證範本部署回應的資訊。

DeploymentWhatIf

部署假設狀況作業參數。

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

表示 Deployment作的介面。

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

資源標識元模型。

RestorePollerOptions
ScopedDeployment

部署作業參數。

ScopedDeploymentWhatIf

部署假設狀況作業參數。

SimplePollerLike

簡單的輪詢器,可用來輪詢長時間執行的作業。

StatusMessage

作業狀態消息物件。

SystemData

與建立和上次修改資源相關的元數據。

TargetResource

目標資源。

TemplateHashResult

計算範本哈希的要求結果。 它包含已縮減範本及其哈希的字串。

TemplateLink

表示範本參考的實體。

UserAssignedIdentity

使用者指派的身分識別屬性

WhatIfChange

What-If 作業所預測之單一資源變更的相關信息。

WhatIfOperationProperties

部署作業屬性。

WhatIfOperationResult

What-If 作業的結果。 包含預測的變更清單和 URL 連結,以取得下一組結果。

WhatIfPropertyChange

資源屬性的預測變更。

ZoneMapping

模型介面區域映射

類型別名

AliasPathAttributes

別名路徑所參考之令牌的屬性。
KnownAliasPathAttributes 可以與 AliasPathAttributes 交換使用,此列舉包含服務支援的已知值。

服務支援的已知值

None:別名路徑所參考的令牌沒有屬性。
可修改:別名路徑所參考的令牌可由具有 'modify' 效果的原則修改。

AliasPathTokenType

別名路徑所參考之令牌的類型。
KnownAliasPathTokenType 可以與 AliasPathTokenType 交換使用,此列舉包含服務支援的已知值。

服務支援的已知值

NotSpecified:未指定令牌類型。
任何:令牌類型可以是任何專案。
String:Token 類型為 string。
Object:Token 類型為 object。
Array:Token 類型為 array。
整數:令牌類型為整數。
數位:令牌類型為 number。
布爾值:令牌類型為布爾值。

AliasPatternType

別名模式的類型

AliasType

別名的類型。

AzureSupportedClouds

雲端設定為字串常值類型的支援值

ChangeType

執行部署時要對資源進行的變更類型。

ContinuablePage

描述結果頁面的介面。

CreatedByType

建立資源的實體種類。
KnownCreatedByType 可以與 CreatedByType 交換使用,此列舉包含服務支援的已知值。

服務支援的已知值

使用者:實體是由使用者建立的。
應用程式:實體是由應用程式所建立。
ManagedIdentity:實體是由受控識別所建立。
金鑰:實體是由金鑰所建立。

DeploymentIdentityType

識別類型。
KnownDeploymentIdentityType 可以與 DeploymentIdentityType 互換使用,此枚舉包含服務支援的已知值。

服務支援的已知值

:無
使用者指派:使用者指派

DeploymentMode

用來部署資源的模式。 此值可以是累加式或完成。 在累加模式中,會部署資源,而不刪除範本中未包含的現有資源。 在 [完成] 模式中,會部署資源,且不會包含在範本中的資源群組中現有的資源會遭到刪除。 當您不小心刪除資源時,請小心使用 [完成] 模式。

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 環境的 enum。

KnownAliasPathAttributes

別名路徑所參考之令牌的屬性。

KnownAliasPathTokenType

別名路徑所參考之令牌的類型。

KnownCreatedByType

建立資源的實體種類。

KnownDeploymentIdentityType

識別類型。

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

類型