@azure/arm-managementgroups package

Классы

ManagementGroupsAPI

Интерфейсы

CheckNameAvailabilityOptionalParams

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

CheckNameAvailabilityRequest

Параметры проверки доступности имени группы управления.

CheckNameAvailabilityResult

Описывает результат запроса на проверку доступности имени группы управления.

CreateManagementGroupChildInfo

Дочерние сведения группы управления, используемой во время создания.

CreateManagementGroupDetails

Сведения о группе управления, используемой во время создания.

CreateManagementGroupProperties

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

CreateManagementGroupRequest

Параметры создания группы управления.

CreateOrUpdateSettingsProperties

Свойства запроса для создания или обновления параметров группы управления

CreateOrUpdateSettingsRequest

Параметры для создания или обновления параметров группы управления

CreateParentGroupInfo

(Необязательно) Идентификатор родительской группы управления, используемой во время создания.

DescendantInfo

Потомок.

DescendantInfoProperties

Общие свойства потомка.

DescendantParentGroupInfo

Идентификатор родительской группы управления.

EntitiesListOptionalParams

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

EntitiesOperations

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

EntityInfo

Сущность.

EntityInfoProperties

Общие свойства сущности.

EntityParentGroupInfo

(Необязательно) Идентификатор родительской группы управления.

ErrorAdditionalInfo

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

ErrorDetail

Подробности ошибки.

ErrorResponse

Распространенный ответ об ошибке для всех API Azure Resource Manager для возврата сведений об ошибке для неудачных операций.

HierarchySettings

Параметры, определенные в области группы управления.

HierarchySettingsCreateOrUpdateOptionalParams

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

HierarchySettingsDeleteOptionalParams

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

HierarchySettingsGetOptionalParams

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

HierarchySettingsInfo

Ресурс параметров иерархии.

HierarchySettingsList

Выводит список всех параметров иерархии.

HierarchySettingsListOptionalParams

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

HierarchySettingsOperations

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

HierarchySettingsProperties

Общие свойства иерархических настроек.

HierarchySettingsUpdateOptionalParams

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

ManagementGroup

Сведения о группе управления.

ManagementGroupChildInfo

Дочерние сведения группы управления.

ManagementGroupDetails

Сведения о группе управления.

ManagementGroupInfo

Ресурс группы управления.

ManagementGroupInfoProperties

Общие свойства управленческой группы.

ManagementGroupPathElement

Элемент пути предки группы управления.

ManagementGroupProperties

Общие свойства управленческой группы.

ManagementGroupSubscriptionsCreateOptionalParams

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

ManagementGroupSubscriptionsDeleteOptionalParams

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

ManagementGroupSubscriptionsGetSubscriptionOptionalParams

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

ManagementGroupSubscriptionsListSubscriptionsUnderManagementGroupOptionalParams

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

ManagementGroupSubscriptionsOperations

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

ManagementGroupsAPIOptionalParams

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

ManagementGroupsCreateOrUpdateOptionalParams

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

ManagementGroupsDeleteOptionalParams

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

ManagementGroupsGetOptionalParams

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

ManagementGroupsListDescendantsOptionalParams

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

ManagementGroupsListOptionalParams

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

ManagementGroupsOperations

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

ManagementGroupsUpdateOptionalParams

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

Operation

Сведения об операции REST API, возвращаемой из API операций поставщика ресурсов

OperationDisplay

Локализованная информация для отображения операции.

OperationsListOptionalParams

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

OperationsOperations

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

PageSettings

Параметры метода byPage

PagedAsyncIterableIterator

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

ParentGroupInfo

(Необязательно) Идентификатор родительской группы управления.

PatchManagementGroupRequest

Параметры исправления группы управления.

ProxyResource

Определение модели ресурсов для ресурса прокси-сервера Azure Resource Manager. У него не будут теги и расположение

Resource

Общие поля, возвращаемые в ответе для всех ресурсов Azure Resource Manager

RestorePollerOptions
SimplePollerLike

Простой опросщик, который можно использовать для опроса длительной операции.

StartTenantBackfillOptionalParams

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

SubscriptionUnderManagementGroup

Сведения о подписке в группе управления.

SubscriptionUnderManagementGroupProperties

Общие свойства подписки под управляющей группой.

SystemData

Метаданные, относящиеся к созданию и последнему изменении ресурса.

TenantBackfillStatusOptionalParams

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

TenantBackfillStatusResult

Состояние обратной заполнения клиента

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

ActionType

Расширяемое перечисление. Указывает тип действия. "Внутренний" относится к действиям, которые предназначены только для внутренних API.
KnownActionType можно использовать взаимозаменяемо с ActionType, этот перечисление содержит известные значения, поддерживаемые службой.

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

Внутренние: действия предназначены только для внутренних API.

AzureSupportedClouds

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

ContinuablePage

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

CreatedByType

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

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

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

EntitySearchType

Тип сущностиПоискТип

EntityViewParameterType

Тип EntityViewParameterType

ManagementGroupChildType

Тип детского ресурса.

ManagementGroupExpandType

Тип управленияGroupExpandType

Origin

Предполагаемый исполнитель операции; например, в интерфейсах управления доступом на основе ресурсов (RBAC) и журналов аудита. Значение по умолчанию — "user,system"
KnownOrigin можно использовать взаимозаменяемо с Origin, этот перечисление содержит известные значения, поддерживаемые службой.

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

user: Указывает, что операция инициирована пользователем.
system: указывает, что операция инициируется системой.
user,system: указывает, что операция инициирована пользователем или системой.

Permissions

Конкретные права пользователя на этот предмет.

Reason

Требуется, если nameAvailable == false. Invalid означает, что имя не соответствует требованиям поставщика ресурса к именованию (неправильная длина, неподдерживаемые символы и т.д.) AlreadyExists указывает на то, что название уже используется и поэтому недоступно.

Status

Статус засыпки арендаторов

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

AzureClouds

Перечисление для описания облачных сред Azure.

KnownActionType

Расширяемое перечисление. Указывает тип действия. "Внутренний" относится к действиям, которые предназначены только для внутренних API.

KnownCreatedByType

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

KnownEntitySearchType

Известные значения EntitySearchType , которые сервис принимает.

KnownEntityViewParameterType

Известные значения EntityViewParameterType , которые сервис принимает.

KnownManagementGroupExpandType

Известные значения ManagementGroupExpandType , которые сервис принимает.

KnownOrigin

Предполагаемый исполнитель операции; например, в интерфейсах управления доступом на основе ресурсов (RBAC) и журналов аудита. Значение по умолчанию — user, system

KnownVersions

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

Функции

isRestError(unknown)

Typeguard для RestError

restorePoller<TResponse, TResult>(ManagementGroupsAPI, 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>(ManagementGroupsAPI, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

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

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

Тип