@azure/arm-resourcesdeployments package

Interfejsy

Alias

Typ aliasu.

AliasPath

Typ ścieżek dla aliasu.

AliasPathMetadata

interfejs modelu AliasPathMetadata

AliasPattern

Typ wzorca dla ścieżki aliasu.

ApiProfile

interfejs modelu ApiProfile

BasicDependency

Informacje o zależnościach wdrożenia.

CloudError

Odpowiedź na błąd żądania zarządzania zasobami.

DebugSetting

Ustawienie debugowania.

Dependency

Informacje o zależnościach wdrożenia.

Deployment

Parametry operacji wdrażania.

DeploymentDiagnosticsDefinition

Interfejs modelu WdrażanieDiagnostykaDefinicja

DeploymentExportResult

Wynik eksportu wdrożenia.

DeploymentExtended

Informacje o wdrożeniu.

DeploymentExtensionConfigItem

model interface DeploymentExtensionConfigItem

DeploymentExtensionDefinition

Interfejs modelu DeploymentExtensionDefinition

DeploymentExternalInput

Zewnętrzne dane wejściowe wdrożenia do parametryzacji.

DeploymentExternalInputDefinition

Definicja zewnętrznych danych wejściowych wdrożenia na potrzeby parametryzacji.

DeploymentIdentity

Konfiguracja tożsamości zarządzanej dla wdrożenia.

DeploymentOperation

Informacje o operacji wdrażania.

DeploymentOperationProperties

Właściwości operacji wdrażania.

DeploymentOperationsGetAtManagementGroupScopeOptionalParams

Parametry opcjonalne.

DeploymentOperationsGetAtScopeOptionalParams

Parametry opcjonalne.

DeploymentOperationsGetAtSubscriptionScopeOptionalParams

Parametry opcjonalne.

DeploymentOperationsGetAtTenantScopeOptionalParams

Parametry opcjonalne.

DeploymentOperationsGetOptionalParams

Parametry opcjonalne.

DeploymentOperationsListAtManagementGroupScopeOptionalParams

Parametry opcjonalne.

DeploymentOperationsListAtScopeOptionalParams

Parametry opcjonalne.

DeploymentOperationsListAtSubscriptionScopeOptionalParams

Parametry opcjonalne.

DeploymentOperationsListAtTenantScopeOptionalParams

Parametry opcjonalne.

DeploymentOperationsListOptionalParams

Parametry opcjonalne.

DeploymentOperationsOperations

Interfejs reprezentujący operacje DeploymentOperations.

DeploymentParameter

Parametr wdrożenia dla szablonu.

DeploymentProperties

Właściwości wdrożenia.

DeploymentPropertiesExtended

Właściwości wdrożenia z dodatkowymi szczegółami.

DeploymentValidateResult

Informacje z weryfikacji odpowiedzi wdrożenia szablonu.

DeploymentWhatIf

Parametry operacji analizy warunkowej wdrożenia.

DeploymentWhatIfProperties

Wdrażanie właściwości warunkowych.

DeploymentWhatIfSettings

Ustawienia operacji What-If wdrażania.

DeploymentsCalculateTemplateHashOptionalParams

Parametry opcjonalne.

DeploymentsCancelAtManagementGroupScopeOptionalParams

Parametry opcjonalne.

DeploymentsCancelAtScopeOptionalParams

Parametry opcjonalne.

DeploymentsCancelAtSubscriptionScopeOptionalParams

Parametry opcjonalne.

DeploymentsCancelAtTenantScopeOptionalParams

Parametry opcjonalne.

DeploymentsCancelOptionalParams

Parametry opcjonalne.

DeploymentsCheckExistenceAtManagementGroupScopeOptionalParams

Parametry opcjonalne.

DeploymentsCheckExistenceAtScopeOptionalParams

Parametry opcjonalne.

DeploymentsCheckExistenceAtSubscriptionScopeOptionalParams

Parametry opcjonalne.

DeploymentsCheckExistenceAtTenantScopeOptionalParams

Parametry opcjonalne.

DeploymentsCheckExistenceOptionalParams

Parametry opcjonalne.

DeploymentsClientOptionalParams

Parametry opcjonalne dla klienta.

DeploymentsCreateOrUpdateAtManagementGroupScopeOptionalParams

Parametry opcjonalne.

DeploymentsCreateOrUpdateAtScopeOptionalParams

Parametry opcjonalne.

DeploymentsCreateOrUpdateAtSubscriptionScopeOptionalParams

Parametry opcjonalne.

DeploymentsCreateOrUpdateAtTenantScopeOptionalParams

Parametry opcjonalne.

DeploymentsCreateOrUpdateOptionalParams

Parametry opcjonalne.

DeploymentsDeleteAtManagementGroupScopeOptionalParams

Parametry opcjonalne.

DeploymentsDeleteAtScopeOptionalParams

Parametry opcjonalne.

DeploymentsDeleteAtSubscriptionScopeOptionalParams

Parametry opcjonalne.

DeploymentsDeleteAtTenantScopeOptionalParams

Parametry opcjonalne.

DeploymentsDeleteOptionalParams

Parametry opcjonalne.

DeploymentsExportTemplateAtManagementGroupScopeOptionalParams

Parametry opcjonalne.

DeploymentsExportTemplateAtScopeOptionalParams

Parametry opcjonalne.

DeploymentsExportTemplateAtSubscriptionScopeOptionalParams

Parametry opcjonalne.

DeploymentsExportTemplateAtTenantScopeOptionalParams

Parametry opcjonalne.

DeploymentsExportTemplateOptionalParams

Parametry opcjonalne.

DeploymentsGetAtManagementGroupScopeOptionalParams

Parametry opcjonalne.

DeploymentsGetAtScopeOptionalParams

Parametry opcjonalne.

DeploymentsGetAtSubscriptionScopeOptionalParams

Parametry opcjonalne.

DeploymentsGetAtTenantScopeOptionalParams

Parametry opcjonalne.

DeploymentsGetOptionalParams

Parametry opcjonalne.

DeploymentsListAtManagementGroupScopeOptionalParams

Parametry opcjonalne.

DeploymentsListAtScopeOptionalParams

Parametry opcjonalne.

DeploymentsListAtSubscriptionScopeOptionalParams

Parametry opcjonalne.

DeploymentsListAtTenantScopeOptionalParams

Parametry opcjonalne.

DeploymentsListByResourceGroupOptionalParams

Parametry opcjonalne.

DeploymentsOperations

Interfejs reprezentujący operacje wdrożeń.

DeploymentsValidateAtManagementGroupScopeOptionalParams

Parametry opcjonalne.

DeploymentsValidateAtScopeOptionalParams

Parametry opcjonalne.

DeploymentsValidateAtSubscriptionScopeOptionalParams

Parametry opcjonalne.

DeploymentsValidateAtTenantScopeOptionalParams

Parametry opcjonalne.

DeploymentsValidateOptionalParams

Parametry opcjonalne.

DeploymentsWhatIfAtManagementGroupScopeOptionalParams

Parametry opcjonalne.

DeploymentsWhatIfAtSubscriptionScopeOptionalParams

Parametry opcjonalne.

DeploymentsWhatIfAtTenantScopeOptionalParams

Parametry opcjonalne.

DeploymentsWhatIfOptionalParams

Parametry opcjonalne.

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

ErrorResponse

Typowa odpowiedź na błędy dla wszystkich interfejsów API usługi Azure Resource Manager w celu zwrócenia szczegółów błędu dla operacji, które zakończyły się niepowodzeniem. (Jest to również zgodne z formatem odpowiedzi na błąd OData).

ExpressionEvaluationOptions

Określa, czy wyrażenia szablonu są obliczane w zakresie szablonu nadrzędnego, czy szablonu zagnieżdżonego.

ExtensionResource

Podstawowy zasób rozszerzenia.

HttpMessage

Komunikat HTTP.

KeyVaultParameterReference

Dokumentacja parametrów usługi Azure Key Vault.

KeyVaultReference

Dokumentacja usługi Azure Key Vault.

OnErrorDeployment

Wdrażanie przy zachowaniu błędu.

OnErrorDeploymentExtended

Wdrożenie dotyczące zachowania błędu z dodatkowymi szczegółami.

PageSettings

Opcje dla metody byPage

PagedAsyncIterableIterator

Interfejs, który umożliwia iterację asynchronialną zarówno do ukończenia, jak i według strony.

ParametersLink

Jednostka reprezentująca odwołanie do parametrów wdrożenia.

Provider

Informacje o dostawcy zasobów.

ProviderExtendedLocation

Lokalizacja rozszerzona dostawcy.

ProviderResourceType

Typ zasobu zarządzany przez dostawcę zasobów.

Resource

Typowe pola zwracane w odpowiedzi dla wszystkich zasobów usługi Azure Resource Manager

ResourceReference

Model identyfikatora zasobu.

RestorePollerOptions
ScopedDeployment

Parametry operacji wdrażania.

ScopedDeploymentWhatIf

Parametry operacji analizy warunkowej wdrożenia.

SimplePollerLike

Prosty poller, który może służyć do sondowania długotrwałej operacji.

StatusMessage

Obiekt komunikatu o stanie operacji.

SystemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

TargetResource

Zasób docelowy.

TemplateHashResult

Wynik żądania obliczania skrótu szablonu. Zawiera on ciąg zmieryfikowanego szablonu i jego skrót.

TemplateLink

Jednostka reprezentująca odwołanie do szablonu.

UserAssignedIdentity

Właściwości tożsamości przypisanej przez użytkownika

WhatIfChange

Informacje o pojedynczej zmianie zasobu przewidywanej przez operację What-If.

WhatIfOperationProperties

Właściwości operacji wdrażania.

WhatIfOperationResult

Wynik operacji What-If. Zawiera listę przewidywanych zmian i link adresu URL, aby przejść do następnego zestawu wyników.

WhatIfPropertyChange

Przewidywana zmiana właściwości zasobu.

ZoneMapping

Strefowe mapowanie interfejsu modelu

Aliasy typu

AliasPathAttributes

Atrybuty tokenu, do którego odwołuje się ścieżka aliasu.
ZnaneAliasPathAttributes można używać zamiennie z aliasamiPathAttributes, wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

None: token, do którego odwołuje się ścieżka aliasu, nie ma atrybutów.
modyfikowalne: token, do którego odwołuje się ścieżka aliasu, można modyfikować przez zasady z efektem "modyfikuj".

AliasPathTokenType

Typ tokenu, do którego odwołuje się ścieżka aliasu.
KnownAliasPathTokenType można używać zamiennie z aliaspathtokenType, wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

Nieokreślone: nie określono typu tokenu.
Dowolny: typ tokenu może być dowolny.
ciąg: typ tokenu to ciąg.
Object: typ tokenu to obiekt.
tablicy: typ tokenu to tablica.
liczba całkowita: typ tokenu to liczba całkowita.
liczba: typ tokenu to liczba.
wartość logiczna: typ tokenu to wartość logiczna.

AliasPatternType

Typ wzorca aliasu

AliasType

Typ aliasu.

AzureSupportedClouds

Obsługiwane wartości ustawienia chmury jako typ literału ciągu

ChangeType

Typ zmiany, która zostanie wprowadzona do zasobu po wykonaniu wdrożenia.

ContinuablePage

Interfejs opisujący stronę wyników.

CreatedByType

Rodzaj jednostki, która utworzyła zasób.
KnownCreatedByType można używać zamiennie z parametrem CreatedByType, wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

użytkownik: jednostka została utworzona przez użytkownika.
Application: jednostka została utworzona przez aplikację.
managedIdentity: jednostka została utworzona przez tożsamość zarządzaną.
klucz: jednostka została utworzona przez klucz.

DeploymentIdentityType

Typ tożsamości.
KnownDeploymentIdentityType może być używany zamiennie z DeploymentIdentityType, to wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

Żadna: Żadna
UserAssigned: UserAssigned

DeploymentMode

Tryb używany do wdrażania zasobów. Ta wartość może być przyrostowa lub ukończona. W trybie przyrostowym zasoby są wdrażane bez usuwania istniejących zasobów, które nie są uwzględnione w szablonie. W trybie kompletnym zasoby są wdrażane, a istniejące zasoby w grupie zasobów, które nie są uwzględnione w szablonie, są usuwane. Należy zachować ostrożność podczas korzystania z trybu ukończenia, ponieważ możesz przypadkowo usunąć zasoby.

DeploymentsCheckExistenceAtManagementGroupScopeResponse
DeploymentsCheckExistenceAtScopeResponse
DeploymentsCheckExistenceAtSubscriptionScopeResponse
DeploymentsCheckExistenceAtTenantScopeResponse
DeploymentsCheckExistenceResponse
ExpressionEvaluationOptionsScopeType

Zakres, który ma być używany do oceny parametrów, zmiennych i funkcji w szablonie zagnieżdżonym.
KnownExpressionEvaluationOptionsScopeType można używać zamiennie z wyrażeniem ExpressionEvaluationOptionsScopeType, wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

NieOkreślone: NieOkreślone
Zewnętrzne: Zewnętrzne
Wewnętrzny: Wewnętrzny

ExtensionConfigPropertyType

Typ ExtensionConfigPropertyType

Level

Oznacza dodatkowy poziom odpowiedzi.
ZnaneLevel można używać zamiennie z poziomem, wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

Ostrzeżenie: Ostrzeżenie
Informacje: Informacje
Błąd: Błąd

OnErrorDeploymentType

Wdrożenie typu zachowania błędu. Możliwe wartości to LastSuccessful i SpecificDeployment.

PropertyChangeType

Typ właściwości zmienia się.

ProviderAuthorizationConsentState

Stan zgody autoryzacji dostawcy.
KnownProviderAuthorizationConsentState może być używany zamiennie z ProviderAuthorizationConsentState, to wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

NieOkreślone: NieOkreślone
Wymagane: Wymagane
NieWymagany: NieWymagany
Zgoda: Zgoda

ProvisioningOperation

Nazwa bieżącej operacji aprowizacji.

ProvisioningState

Określa stan aprowizacji.
KnownProvisioningState można używać zamiennie z parametrem ProvisioningState, wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

NieOkreślone: NieOkreślone
Zaakceptowane: Zaakceptowane
Bieganie: Bieganie
Gotowi: Gotowi
Tworzenie: Tworzenie
Stworzone: Stworzone
Usuwanie: Usuwanie
Usunięto: Usunięto
Anulowane: Odwołane
Niepowodzenie: Niepowodzenie
Udało się: Udało się
Aktualizacja: Aktualizacja

ValidationLevel

Poziom walidacji wykonywanej we wdrożeniu.
KnownValidationLevel może być używany zamiennie z ValidationLevel, to wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

Szablon: Przeprowadzana jest analiza statyczna szablonu.
Dostawca: wykonywana jest analiza statyczna szablonu, a deklaracje zasobów są wysyłane do dostawców zasobów w celu walidacji semantycznej. Sprawdza, czy obiekt wywołujący ma uprawnienia do zapisu RBAC dla każdego zasobu.
ProviderNoRbac: Przeprowadzana jest analiza statyczna szablonu, a deklaracje zasobów są wysyłane do dostawców zasobów w celu weryfikacji semantycznej. Pomija sprawdzanie, czy obiekt wywołujący ma uprawnienia do zapisu RBAC dla każdego zasobu.

WhatIfResultFormat

Format wyników What-If

Wyliczenia

AzureClouds

Enum opisujące środowiska Azure Cloud.

KnownAliasPathAttributes

Atrybuty tokenu, do którego odwołuje się ścieżka aliasu.

KnownAliasPathTokenType

Typ tokenu, do którego odwołuje się ścieżka aliasu.

KnownCreatedByType

Rodzaj jednostki, która utworzyła zasób.

KnownDeploymentIdentityType

Typ tożsamości.

KnownExpressionEvaluationOptionsScopeType

Zakres, który ma być używany do oceny parametrów, zmiennych i funkcji w szablonie zagnieżdżonym.

KnownExtensionConfigPropertyType

Znane wartości ExtensionConfigPropertyType akceptowane przez usługę.

KnownLevel

Oznacza dodatkowy poziom odpowiedzi.

KnownProviderAuthorizationConsentState

Stan zgody autoryzacji dostawcy.

KnownProvisioningState

Określa stan aprowizacji.

KnownValidationLevel

Poziom walidacji wykonywanej we wdrożeniu.

KnownVersions

Dostępne wersje interfejsu API.

Funkcje

isRestError(unknown)

Funkcja Typeguard dla błędu RestError

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

Tworzy poller ze stanu serializowanego innego poller. Może to być przydatne, gdy chcesz utworzyć sondy na innym hoście lub poller musi zostać skonstruowany po tym, jak oryginalny nie znajduje się w zakresie.

Zmienne

RestError

Niestandardowy typ błędu dla żądań potoku, który zakończył się niepowodzeniem.

Szczegóły funkcji

isRestError(unknown)

Funkcja Typeguard dla błędu RestError

function isRestError(e: unknown): e

Parametry

e

unknown

Coś złapanego przez klauzulę catch.

Zwraca

e

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

Tworzy poller ze stanu serializowanego innego poller. Może to być przydatne, gdy chcesz utworzyć sondy na innym hoście lub poller musi zostać skonstruowany po tym, jak oryginalny nie znajduje się w zakresie.

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>

Zwraca

PollerLike<OperationState<TResult>, TResult>

Szczegóły zmiennej

RestError

Niestandardowy typ błędu dla żądań potoku, który zakończył się niepowodzeniem.

RestError: RestErrorConstructor

Typ