@azure/arm-resourcesdeployments package

Rozhraní

Alias

Typ aliasu.

AliasPath

Typ cest pro alias.

AliasPathMetadata

modelové rozhraní AliasPathMetadata

AliasPattern

Typ vzoru pro cestu aliasu.

ApiProfile

modelové rozhraní ApiProfile

BasicDependency

Informace o závislostech nasazení

CloudError

Odpověď na chybu žádosti o správu prostředků.

DebugSetting

Nastavení ladění.

Dependency

Informace o závislostech nasazení

Deployment

Parametry operace nasazení

DeploymentDiagnosticsDefinition

Model Interface DeploymentDiagnosticsDefinition

DeploymentExportResult

Výsledek exportu nasazení.

DeploymentExtended

Informace o nasazení

DeploymentExtensionConfigItem

model interface DeploymentExtensionConfigItem

DeploymentExtensionDefinition

Model interface DeploymentExtensionDefinition

DeploymentExternalInput

Nasazení externího vstupu pro parametrizaci.

DeploymentExternalInputDefinition

Definice externího vstupu nasazení pro parametrizaci.

DeploymentIdentity

Konfigurace spravované identity pro nasazení.

DeploymentOperation

Informace o operaci nasazení

DeploymentOperationProperties

Vlastnosti operace nasazení

DeploymentOperationsGetAtManagementGroupScopeOptionalParams

Volitelné parametry.

DeploymentOperationsGetAtScopeOptionalParams

Volitelné parametry.

DeploymentOperationsGetAtSubscriptionScopeOptionalParams

Volitelné parametry.

DeploymentOperationsGetAtTenantScopeOptionalParams

Volitelné parametry.

DeploymentOperationsGetOptionalParams

Volitelné parametry.

DeploymentOperationsListAtManagementGroupScopeOptionalParams

Volitelné parametry.

DeploymentOperationsListAtScopeOptionalParams

Volitelné parametry.

DeploymentOperationsListAtSubscriptionScopeOptionalParams

Volitelné parametry.

DeploymentOperationsListAtTenantScopeOptionalParams

Volitelné parametry.

DeploymentOperationsListOptionalParams

Volitelné parametry.

DeploymentOperationsOperations

Rozhraní reprezentující operace DeploymentOperations.

DeploymentParameter

Parametr nasazení pro šablonu.

DeploymentProperties

Vlastnosti nasazení

DeploymentPropertiesExtended

Vlastnosti nasazení s dalšími podrobnostmi

DeploymentValidateResult

Informace z ověření odpovědi nasazení šablony

DeploymentWhatIf

Parametry operace Citlivostní analýza nasazení

DeploymentWhatIfProperties

Vlastnosti citlivostní citlivosti nasazení

DeploymentWhatIfSettings

Nastavení operace What-If nasazení

DeploymentsCalculateTemplateHashOptionalParams

Volitelné parametry.

DeploymentsCancelAtManagementGroupScopeOptionalParams

Volitelné parametry.

DeploymentsCancelAtScopeOptionalParams

Volitelné parametry.

DeploymentsCancelAtSubscriptionScopeOptionalParams

Volitelné parametry.

DeploymentsCancelAtTenantScopeOptionalParams

Volitelné parametry.

DeploymentsCancelOptionalParams

Volitelné parametry.

DeploymentsCheckExistenceAtManagementGroupScopeOptionalParams

Volitelné parametry.

DeploymentsCheckExistenceAtScopeOptionalParams

Volitelné parametry.

DeploymentsCheckExistenceAtSubscriptionScopeOptionalParams

Volitelné parametry.

DeploymentsCheckExistenceAtTenantScopeOptionalParams

Volitelné parametry.

DeploymentsCheckExistenceOptionalParams

Volitelné parametry.

DeploymentsClientOptionalParams

Volitelné parametry pro klienta.

DeploymentsCreateOrUpdateAtManagementGroupScopeOptionalParams

Volitelné parametry.

DeploymentsCreateOrUpdateAtScopeOptionalParams

Volitelné parametry.

DeploymentsCreateOrUpdateAtSubscriptionScopeOptionalParams

Volitelné parametry.

DeploymentsCreateOrUpdateAtTenantScopeOptionalParams

Volitelné parametry.

DeploymentsCreateOrUpdateOptionalParams

Volitelné parametry.

DeploymentsDeleteAtManagementGroupScopeOptionalParams

Volitelné parametry.

DeploymentsDeleteAtScopeOptionalParams

Volitelné parametry.

DeploymentsDeleteAtSubscriptionScopeOptionalParams

Volitelné parametry.

DeploymentsDeleteAtTenantScopeOptionalParams

Volitelné parametry.

DeploymentsDeleteOptionalParams

Volitelné parametry.

DeploymentsExportTemplateAtManagementGroupScopeOptionalParams

Volitelné parametry.

DeploymentsExportTemplateAtScopeOptionalParams

Volitelné parametry.

DeploymentsExportTemplateAtSubscriptionScopeOptionalParams

Volitelné parametry.

DeploymentsExportTemplateAtTenantScopeOptionalParams

Volitelné parametry.

DeploymentsExportTemplateOptionalParams

Volitelné parametry.

DeploymentsGetAtManagementGroupScopeOptionalParams

Volitelné parametry.

DeploymentsGetAtScopeOptionalParams

Volitelné parametry.

DeploymentsGetAtSubscriptionScopeOptionalParams

Volitelné parametry.

DeploymentsGetAtTenantScopeOptionalParams

Volitelné parametry.

DeploymentsGetOptionalParams

Volitelné parametry.

DeploymentsListAtManagementGroupScopeOptionalParams

Volitelné parametry.

DeploymentsListAtScopeOptionalParams

Volitelné parametry.

DeploymentsListAtSubscriptionScopeOptionalParams

Volitelné parametry.

DeploymentsListAtTenantScopeOptionalParams

Volitelné parametry.

DeploymentsListByResourceGroupOptionalParams

Volitelné parametry.

DeploymentsOperations

Rozhraní představující Deployments operations.

DeploymentsValidateAtManagementGroupScopeOptionalParams

Volitelné parametry.

DeploymentsValidateAtScopeOptionalParams

Volitelné parametry.

DeploymentsValidateAtSubscriptionScopeOptionalParams

Volitelné parametry.

DeploymentsValidateAtTenantScopeOptionalParams

Volitelné parametry.

DeploymentsValidateOptionalParams

Volitelné parametry.

DeploymentsWhatIfAtManagementGroupScopeOptionalParams

Volitelné parametry.

DeploymentsWhatIfAtSubscriptionScopeOptionalParams

Volitelné parametry.

DeploymentsWhatIfAtTenantScopeOptionalParams

Volitelné parametry.

DeploymentsWhatIfOptionalParams

Volitelné parametry.

ErrorAdditionalInfo

Další informace o chybě správy prostředků

ErrorResponse

Běžná chybová odpověď pro všechna rozhraní API Azure Resource Manageru pro vrácení podrobností o chybě pro neúspěšné operace (To se také řídí formátem odpovědi na chybu OData.)

ExpressionEvaluationOptions

Určuje, jestli se výrazy šablony vyhodnocují v rámci oboru nadřazené šablony nebo vnořené šablony.

ExtensionResource

Základní prostředek rozšíření.

HttpMessage

Zpráva HTTP.

KeyVaultParameterReference

Referenční informace k parametrům služby Azure Key Vault

KeyVaultReference

Referenční informace ke službě Azure Key Vault

OnErrorDeployment

Nasazení při chování chyby

OnErrorDeploymentExtended

Nasazení při chování chyby s dalšími podrobnostmi

PageSettings

Možnosti pro metodu byPage

PagedAsyncIterableIterator

Rozhraní, které umožňuje asynchronní iteraci k dokončení i po stránce.

ParametersLink

Entita představující odkaz na parametry nasazení

Provider

Informace o poskytovateli prostředků

ProviderExtendedLocation

Rozšířené umístění poskytovatele.

ProviderResourceType

Typ prostředku spravovaný poskytovatelem prostředků

Resource

Běžná pole vrácená v odpovědi pro všechny prostředky Azure Resource Manageru

ResourceReference

Model ID prostředku.

RestorePollerOptions
ScopedDeployment

Parametry operace nasazení

ScopedDeploymentWhatIf

Parametry operace Citlivostní analýza nasazení

SimplePollerLike

Jednoduchý poller, který lze použít k dotazování dlouhotrvající operace.

StatusMessage

Objekt zprávy o stavu operace.

SystemData

Metadata týkající se vytvoření a poslední změny prostředku.

TargetResource

Cílový prostředek.

TemplateHashResult

Výsledek požadavku na výpočet hodnoty hash šablony Obsahuje řetězec minifikované šablony a jeho hash.

TemplateLink

Entita představující odkaz na šablonu.

UserAssignedIdentity

Vlastnosti identity přiřazené uživatelem

WhatIfChange

Informace o jedné změně prostředku předpovězené operací What-If

WhatIfOperationProperties

Vlastnosti operace nasazení

WhatIfOperationResult

Výsledek operace What-If Obsahuje seznam předpovídané změny a odkaz na adresu URL, který se dostane k další sadě výsledků.

WhatIfPropertyChange

Predikovaná změna vlastnosti prostředku.

ZoneMapping

Zónové mapování modelového rozhraní

Aliasy typu

AliasPathAttributes

Atributy tokenu, na který cesta aliasu odkazuje.
PoleAliasPathAttributes lze použít zaměnitelně s AliasPathAttributes, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

None: Token, na který cesta aliasu odkazuje, nemá žádné atributy.
upravitelné: Token, na který cesta aliasu odkazuje, je možné upravit zásadami s účinkem "modify".

AliasPathTokenType

Typ tokenu, na který cesta aliasu odkazuje.
PoleAliasPathTokenType lze použít zaměnitelně s AliasPathTokenType, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

Nezadá: Typ tokenu není zadán.
Libovolný: Typ tokenu může být cokoli.
řetězcové: Typ tokenu je řetězec.
Objekt: Typ tokenu je objekt.
pole: Typ tokenu je pole.
celočíselná: Typ tokenu je celé číslo.
číslo: Typ tokenu je číslo.
logická: Typ tokenu je logická hodnota.

AliasPatternType

Typ vzoru aliasu

AliasType

Typ aliasu.

AzureSupportedClouds

Podporované hodnoty pro nastavení cloudu jako typ řetězcového literálu

ChangeType

Typ změny, která se provede u prostředku při spuštění nasazení

ContinuablePage

Rozhraní, které popisuje stránku výsledků.

CreatedByType

Druh entity, která prostředek vytvořila.
PoleCreatedByType lze použít zaměnitelně s CreatedByType, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

user: Entita byla vytvořena uživatelem.
Application: Entita byla vytvořena aplikací.
ManagedIdentity: Entita byla vytvořena spravovanou identitou.
Klíč: Entita byla vytvořena klíčem.

DeploymentIdentityType

Typ identity.
KnownDeploymentIdentityType lze použít zaměnitelně s DeploymentIdentityType, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

Žádné: Žádné
UserAssigned: UserAssigned

DeploymentMode

Režim, který se používá k nasazení prostředků. Tato hodnota může být přírůstková nebo úplná. V přírůstkovém režimu se prostředky nasazují bez odstranění existujících prostředků, které nejsou součástí šablony. V režimu Dokončení se prostředky nasadí a existující prostředky ve skupině prostředků, které nejsou součástí šablony, se odstraní. Při použití režimu Dokončení buďte opatrní, protože nechtěně odstraňte prostředky.

DeploymentsCheckExistenceAtManagementGroupScopeResponse
DeploymentsCheckExistenceAtScopeResponse
DeploymentsCheckExistenceAtSubscriptionScopeResponse
DeploymentsCheckExistenceAtTenantScopeResponse
DeploymentsCheckExistenceResponse
ExpressionEvaluationOptionsScopeType

Rozsah, který se má použít pro vyhodnocení parametrů, proměnných a funkcí ve vnořené šabloně.
PoleExpressionEvaluationOptionsScopeType lze použít zaměnitelně s ExpressionEvaluationOptionsScopeType, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

Nespecifikováno: Nespecifikováno
Vnější: Vnější
Vnitřní: Vnitřní

ExtensionConfigPropertyType

Typ ExtensionConfigPropertyType

Level

Označuje dodatečnou úroveň odezvy.
PoleLevel lze použít zaměnitelně s úrovní, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

Varování: Varování
Info: Info
Chyba: Chyba

OnErrorDeploymentType

Nasazení typu chování chyby. Možné hodnoty jsou LastSuccessful a SpecificDeployment.

PropertyChangeType

Typ vlastnosti se změní.

ProviderAuthorizationConsentState

Stav souhlasu s autorizací zprostředkovatele.
PoleProviderAuthorizationConsentState lze použít zaměnitelně s ProviderAuthorizationConsentState, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

Nespecifikováno: Nespecifikováno
Povinné: Povinné
Nepovinné: NepovinnéPovinné
Souhlas: Souhlas

ProvisioningOperation

Název aktuální operace zřizování.

ProvisioningState

Označuje stav zřizování.
KnownProvisioningState lze použít zaměnitelně s ProvisioningState, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

Nespecifikováno: Nespecifikováno
Přijato: Přijato
Běh: Běh
Připraveni: Připraveni
Vytváření: Vytváření
Vytvořeno: Vytvořeno
Smazání: Odstranění
Smazáno: Smazáno
Zrušeno: Zrušeno
Nezdařilo se: Nezdařilo se
Uspěl: Uspěl
Aktualizace: Aktualizace

ValidationLevel

Úroveň ověření provedeného při nasazení.
KnownValidationLevel lze použít zaměnitelně s ValidationLevel, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

Šablona: Provede se statická analýza šablony.
Poskytovatel: Provede se statická analýza šablony a deklarace prostředků se odešlou poskytovatelům prostředků k sémantickému ověření. Ověří, zda má volající oprávnění k zápisu RBAC pro každý prostředek.
ProviderNoRbac: Provede se statická analýza šablony a deklarace prostředků se odešlou poskytovatelům prostředků k sémantickému ověření. Přeskočí ověření, zda má volající oprávnění k zápisu RBAC pro každý prostředek.

WhatIfResultFormat

Formát výsledků What-If

Výčty

AzureClouds

Enum pro popis prostředí Azure Cloud.

KnownAliasPathAttributes

Atributy tokenu, na který cesta aliasu odkazuje.

KnownAliasPathTokenType

Typ tokenu, na který cesta aliasu odkazuje.

KnownCreatedByType

Druh entity, která prostředek vytvořila.

KnownDeploymentIdentityType

Typ identity.

KnownExpressionEvaluationOptionsScopeType

Rozsah, který se má použít pro vyhodnocení parametrů, proměnných a funkcí ve vnořené šabloně.

KnownExtensionConfigPropertyType

Známé hodnoty ExtensionConfigPropertyType , které služba přijímá.

KnownLevel

Označuje dodatečnou úroveň odezvy.

KnownProviderAuthorizationConsentState

Stav souhlasu s autorizací zprostředkovatele.

KnownProvisioningState

Označuje stav zřizování.

KnownValidationLevel

Úroveň ověření provedeného při nasazení.

KnownVersions

Dostupné verze rozhraní API.

Funkce

isRestError(unknown)

Typeguard pro RestError

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

Vytvoří poller ze serializovaného stavu jiného polleru. To může být užitečné v případě, že chcete vytvořit pollery na jiném hostiteli nebo je třeba vytvořit poller po původním dotazu, který není v rozsahu.

Proměnné

RestError

Vlastní typ chyby pro neúspěšné požadavky kanálu.

Podrobnosti funkce

isRestError(unknown)

Typeguard pro RestError

function isRestError(e: unknown): e

Parametry

e

unknown

Něco zachyceného klauzulí catch.

Návraty

e

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

Vytvoří poller ze serializovaného stavu jiného polleru. To může být užitečné v případě, že chcete vytvořit pollery na jiném hostiteli nebo je třeba vytvořit poller po původním dotazu, který není v rozsahu.

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

Parametry

serializedState

string

sourceOperation

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

Návraty

PollerLike<OperationState<TResult>, TResult>

Podrobnosti proměnné

RestError

Vlastní typ chyby pro neúspěšné požadavky kanálu.

RestError: RestErrorConstructor

Typ