@azure/arm-resourcesdeployments package

Классы

DeploymentsClient

Интерфейсы

Alias

Тип псевдонима.

AliasPath

Тип путей для псевдонима.

AliasPathMetadata

интерфейс модели AliasPathMetadata

AliasPattern

Тип шаблона для пути псевдонима.

ApiProfile

ApiProfile интерфейса модели

BasicDependency

Сведения о зависимости развертывания.

CloudError

Ответ об ошибке для запроса на управление ресурсами.

DebugSetting

Параметр отладки.

Dependency

Сведения о зависимости развертывания.

Deployment

Параметры операции развертывания.

DeploymentDiagnosticsDefinition

Интерфейс модели РазвертываниеДиагностикаОпределение

DeploymentExportResult

Результат экспорта развертывания.

DeploymentExtended

Сведения о развертывании.

DeploymentExtensionConfigItem

model interface DeploymentExtensionConfigItem

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

Интерфейс, представляющий операции развертывания.

DeploymentsValidateAtManagementGroupScopeOptionalParams

Необязательные параметры.

DeploymentsValidateAtScopeOptionalParams

Необязательные параметры.

DeploymentsValidateAtSubscriptionScopeOptionalParams

Необязательные параметры.

DeploymentsValidateAtTenantScopeOptionalParams

Необязательные параметры.

DeploymentsValidateOptionalParams

Необязательные параметры.

DeploymentsWhatIfAtManagementGroupScopeOptionalParams

Необязательные параметры.

DeploymentsWhatIfAtSubscriptionScopeOptionalParams

Необязательные параметры.

DeploymentsWhatIfAtTenantScopeOptionalParams

Необязательные параметры.

DeploymentsWhatIfOptionalParams

Необязательные параметры.

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

ErrorResponse

Распространенный ответ об ошибке для всех API Azure Resource Manager для возврата сведений об ошибке для неудачных операций. (Это также следует формату ответа на ошибку 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

интерфейс модели ZoneMapping

Псевдонимы типа

AliasPathAttributes

Атрибуты маркера, к которому ссылается путь псевдонима.
KnownAliasPathAttributes можно использовать взаимозаменяемо с AliasPathAttributes, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

None: маркер, на который ссылается путь псевдонима, не имеет атрибутов.
модификатор: маркер, к которому ссылается путь псевдонима, можно изменить с помощью политик с эффектом "изменить".

AliasPathTokenType

Тип маркера, на который ссылается путь псевдонима.
KnownAliasPathTokenType можно использовать взаимозаменяемо с AliasPathTokenType, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

NotSpecified: тип токена не указан.
любой: тип токена может быть любым.
string: тип токена является строкой.
объект: тип токена — объект.
массив: тип токена — массив.
целочисленное: тип токена является целым числом.
число: тип токена — число.
логические: тип токена является логическим.

AliasPatternType

Тип шаблона псевдонима

AliasType

Тип псевдонима.

AzureSupportedClouds

Поддерживаемые значения для настройки облака в виде строкового литерала

ChangeType

Тип изменения, которое будет выполнено в ресурс при выполнении развертывания.

ContinuablePage

Интерфейс, описывающий страницу результатов.

CreatedByType

Тип сущности, создающей ресурс.
KnownCreatedByType можно использовать взаимозаменяемо с CreatedByType, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

user: сущность была создана пользователем.
приложения: сущность была создана приложением.
ManagedIdentity: сущность была создана управляемым удостоверением.
ключ: сущность была создана ключом.

DeploymentIdentityType

Тип удостоверения.
KnownDeploymentIdentityType может использоваться взаимозаменяемо с DeploymentIdentityType, это перечисление содержит известные значения, которые поддерживает служба.

Известные значения, поддерживаемые службой

Нет: Нет
UserAssigned: UserAssigned

DeploymentMode

Режим, используемый для развертывания ресурсов. Это значение может быть добавочным или завершенным. В добавочном режиме ресурсы развертываются без удаления существующих ресурсов, не включенных в шаблон. В полном режиме ресурсы развертываются и существующие ресурсы в группе ресурсов, не включенные в шаблон, удаляются. Будьте осторожны при использовании режима завершения, так как вы можете непреднамеренно удалить ресурсы.

DeploymentsCheckExistenceAtManagementGroupScopeResponse
DeploymentsCheckExistenceAtScopeResponse
DeploymentsCheckExistenceAtSubscriptionScopeResponse
DeploymentsCheckExistenceAtTenantScopeResponse
DeploymentsCheckExistenceResponse
ExpressionEvaluationOptionsScopeType

Область видимости, используемая для вычисления параметров, переменных и функций во вложенном шаблоне.
KnownExpressionEvaluationOptionsScopeType можно использовать взаимозаменяемо с ExpressionEvaluationOptionsScopeType, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

NotSpecificified: NotSpecified
Внешний: Внешний
Внутренний: Внутренний

ExtensionConfigPropertyType

Тип расширенияConfigPropertyType

Level

Обозначает дополнительный уровень ответа.
KnownLevel можно использовать взаимозаменяемо с level, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

Внимание: Предупреждение
Информация: Информация
Ошибка: Ошибка

OnErrorDeploymentType

Развертывание по типу поведения ошибки. Возможные значения: LastSuccessful и SpecificDeployment.

PropertyChangeType

Тип изменения свойства.

ProviderAuthorizationConsentState

Состояние согласия на авторизацию поставщика.
KnownProviderAuthorizationConsentState можно использовать взаимозаменяемо с ProviderAuthorizationConsentState, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

NotSpecificified: NotSpecified
Обязательно: Обязательно
НеОбязательно: НеОбязательно
Согласие: Согласие

ProvisioningOperation

Имя текущей операции подготовки.

ProvisioningState

Обозначает состояние подготовки.
KnownProvisioningState можно использовать взаимозаменяемо с ProvisioningState, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

NotSpecificified: NotSpecified
Принято: Принято
Бег: Бег
Готово: Готово
Создание: Создание
Создано: Создано
Удаление: Удаление
Удалено: Удалено
Отменено: Отменено
Failed: Неудача
Удалось: Успешно
Обновление: обновление

ValidationLevel

Уровень проверки, выполняемой при развертывании.
KnownValidationLevel можно использовать взаимозаменяемо с ValidationLevel, это перечисление содержит известные значения, которые поддерживает служба.

Известные значения, поддерживаемые службой

Шаблон: Выполняется статический анализ шаблона.
Поставщик: выполняется статический анализ шаблона, и объявления ресурсов отправляются поставщикам ресурсов для семантической проверки. Проверяет, есть ли у вызывающего объекта разрешения на запись RBAC для каждого ресурса.
ProviderNoRbac: выполняется статический анализ шаблона и объявления ресурсов отправляются поставщикам ресурсов для семантической проверки. Пропускает проверку того, что вызывающий объект имеет разрешения на запись RBAC для каждого ресурса.

WhatIfResultFormat

Формат результатов What-If

Перечисления

AzureClouds

Enum для описания среды Azure Cloud.

KnownAliasPathAttributes

Атрибуты маркера, к которому ссылается путь псевдонима.

KnownAliasPathTokenType

Тип маркера, на который ссылается путь псевдонима.

KnownCreatedByType

Тип сущности, создающей ресурс.

KnownDeploymentIdentityType

Тип удостоверения.

KnownExpressionEvaluationOptionsScopeType

Область видимости, используемая для вычисления параметров, переменных и функций во вложенном шаблоне.

KnownExtensionConfigPropertyType

Известные значения ExtensionConfigPropertyType , которые принимает служба.

KnownLevel

Обозначает дополнительный уровень ответа.

KnownProviderAuthorizationConsentState

Состояние согласия на авторизацию поставщика.

KnownProvisioningState

Обозначает состояние подготовки.

KnownValidationLevel

Уровень проверки, выполняемой при развертывании.

KnownVersions

Доступные версии API.

Функции

isRestError(unknown)

Typeguard для RestError

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

Создает опрашиватель из сериализованного состояния другого опрашителя. Это может быть полезно, если вы хотите создать опросы на другом узле или опросщике необходимо создать после того, как исходный не находится в области.

Переменные

RestError

Настраиваемый тип ошибки для неудачных запросов конвейера.

Сведения о функции

isRestError(unknown)

Typeguard для RestError

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

Тип