@azure/arm-managementgroups package

Interfaces

CheckNameAvailabilityOptionalParams

Parámetros opcionales.

CheckNameAvailabilityRequest

Parámetros de comprobación de disponibilidad del nombre del grupo de administración.

CheckNameAvailabilityResult

Describe el resultado de la solicitud para comprobar la disponibilidad del nombre del grupo de administración.

CreateManagementGroupChildInfo

Información secundaria de un grupo de administración utilizado durante la creación.

CreateManagementGroupDetails

Detalles de un grupo de administración usado durante la creación.

CreateManagementGroupProperties

Las propiedades genéricas de un grupo de administración que se usan durante la creación.

CreateManagementGroupRequest

Parámetros de creación de grupos de administración.

CreateOrUpdateSettingsProperties

Las propiedades de la solicitud para crear o actualizar la configuración del grupo de administración

CreateOrUpdateSettingsRequest

Parámetros para crear o actualizar la configuración del grupo de administración

CreateParentGroupInfo

(Opcional) Identificador del grupo de administración primario usado durante la creación.

DescendantInfo

Descendiente.

DescendantInfoProperties

Las propiedades genéricas de un descendiente.

DescendantParentGroupInfo

Identificador del grupo de administración primario.

EntitiesListOptionalParams

Parámetros opcionales.

EntitiesOperations

Interfaz que representa las operaciones de una Entidad.

EntityInfo

La entidad.

EntityInfoProperties

Las propiedades genéricas de una entidad.

EntityParentGroupInfo

(Opcional) Identificador del grupo de administración primario.

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

ErrorDetail

Detalle del error.

ErrorResponse

Respuesta de error común para todas las API de Azure Resource Manager para devolver los detalles de error de las operaciones con errores.

HierarchySettings

Configuración definida en el ámbito del grupo de administración.

HierarchySettingsCreateOrUpdateOptionalParams

Parámetros opcionales.

HierarchySettingsDeleteOptionalParams

Parámetros opcionales.

HierarchySettingsGetOptionalParams

Parámetros opcionales.

HierarchySettingsInfo

Recurso de configuración de jerarquía.

HierarchySettingsList

Enumera todas las configuraciones de jerarquía.

HierarchySettingsListOptionalParams

Parámetros opcionales.

HierarchySettingsOperations

Interfaz que representa una operación de HierarchySettings.

HierarchySettingsProperties

Las propiedades genéricas de los ajustes jerárquicos.

HierarchySettingsUpdateOptionalParams

Parámetros opcionales.

ManagementGroup

Detalles del grupo de administración.

ManagementGroupChildInfo

Información secundaria de un grupo de administración.

ManagementGroupDetails

Detalles de un grupo de administración.

ManagementGroupInfo

El recurso del grupo de administración.

ManagementGroupInfoProperties

Las propiedades genéricas de un grupo de gestión.

ManagementGroupPathElement

Elemento path de los antecesores de un grupo de administración.

ManagementGroupProperties

Las propiedades genéricas de un grupo de gestión.

ManagementGroupSubscriptionsCreateOptionalParams

Parámetros opcionales.

ManagementGroupSubscriptionsDeleteOptionalParams

Parámetros opcionales.

ManagementGroupSubscriptionsGetSubscriptionOptionalParams

Parámetros opcionales.

ManagementGroupSubscriptionsListSubscriptionsUnderManagementGroupOptionalParams

Parámetros opcionales.

ManagementGroupSubscriptionsOperations

Interfaz que representa una operación de ManagementGroupSubscriptions.

ManagementGroupsAPIOptionalParams

Parámetros opcionales para el cliente.

ManagementGroupsCreateOrUpdateOptionalParams

Parámetros opcionales.

ManagementGroupsDeleteOptionalParams

Parámetros opcionales.

ManagementGroupsGetOptionalParams

Parámetros opcionales.

ManagementGroupsListDescendantsOptionalParams

Parámetros opcionales.

ManagementGroupsListOptionalParams

Parámetros opcionales.

ManagementGroupsOperations

Interfaz que representa una operación de ManagementGroups.

ManagementGroupsUpdateOptionalParams

Parámetros opcionales.

Operation

Detalles de una operación de API REST, devuelta desde la API de operaciones del proveedor de recursos

OperationDisplay

Información de visualización localizada para una operación.

OperationsListOptionalParams

Parámetros opcionales.

OperationsOperations

Interfaz que representa una operación de operaciones.

PageSettings

Opciones para el método byPage

PagedAsyncIterableIterator

Interfaz que permite la iteración asincrónica tanto a la finalización como a la página.

ParentGroupInfo

(Opcional) Identificador del grupo de administración primario.

PatchManagementGroupRequest

Parámetros de revisión del grupo de administración.

ProxyResource

Definición del modelo de recursos para un recurso proxy de Azure Resource Manager. No tendrá etiquetas ni una ubicación

Resource

Campos comunes que se devuelven en la respuesta de todos los recursos de Azure Resource Manager

RestorePollerOptions
SimplePollerLike

Un sondeo sencillo que se puede usar para sondear una operación de larga duración.

StartTenantBackfillOptionalParams

Parámetros opcionales.

SubscriptionUnderManagementGroup

Los detalles de la suscripción en el grupo de administración.

SubscriptionUnderManagementGroupProperties

Las propiedades genéricas de la suscripción bajo un grupo de gestión.

SystemData

Metadatos relativos a la creación y última modificación del recurso.

TenantBackfillStatusOptionalParams

Parámetros opcionales.

TenantBackfillStatusResult

Estado de reposición del inquilino

Alias de tipos

ActionType

Enumeración extensible. Indica el tipo de acción. "Interno" hace referencia a las acciones que son solo para las API internas.
KnownActionType se puede usar indistintamente con ActionType, esta enumeración contiene los valores conocidos que admite el servicio.

Valores conocidos admitidos por el servicio

Interno: las acciones son para API solo internas.

AzureSupportedClouds

Los valores admitidos para la configuración de nube como un tipo literal de cadena

ContinuablePage

Interfaz que describe una página de resultados.

CreatedByType

Tipo de entidad que creó el recurso.
KnownCreatedByType se puede usar indistintamente con CreatedByType, esta enumeración contiene los valores conocidos que admite el servicio.

Valores conocidos admitidos por el servicio

Usuario: un usuario creó la entidad.
Application: la entidad la creó una aplicación.
ManagedIdentity: la entidad se creó mediante una identidad administrada.
Key: la entidad se creó mediante una clave.

EntitySearchType

Tipo de TipoBúsquedaEntidad

EntityViewParameterType

Tipo de EntityViewParameterType

ManagementGroupChildType

El tipo de recurso infantil.

ManagementGroupExpandType

Tipo de GestiónGrupoExpandir

Origin

El ejecutor previsto de la operación, como en el control de acceso basado en recursos (RBAC) y en la experiencia de usuario de los registros de auditoría. El valor predeterminado es "usuario, sistema"
KnownOrigin se puede usar indistintamente con Origin, esta enumeración contiene los valores conocidos que admite el servicio.

Valores conocidos admitidos por el servicio

user: indica que la operación la inicia un usuario.
system: Indica que la operación es iniciada por un sistema.
user,system: Indica que la operación es iniciada por un usuario o sistema.

Permissions

Los permisos específicos de los usuarios para este artículo.

Reason

Obligatorio si nombreDisponible == falso. Inválido indica que el nombre proporcionado no coincide con los requisitos de nombre del proveedor de recursos (longitud incorrecta, caracteres no soportados, etc.) AlreadyExists indica que el nombre ya está en uso y, por tanto, no está disponible.

Status

Estado del relleno de inquilinos

Enumeraciones

AzureClouds

Una enumeración para describir los entornos de la nube de Azure.

KnownActionType

Enumeración extensible. Indica el tipo de acción. "Interno" hace referencia a las acciones que son solo para las API internas.

KnownCreatedByType

Tipo de entidad que creó el recurso.

KnownEntitySearchType

Valores conocidos de EntitySearchType que el servicio acepta.

KnownEntityViewParameterType

Valores conocidos de EntityViewParameterType que el servicio acepta.

KnownManagementGroupExpandType

Valores conocidos de ManagementGroupExpandType que el servicio acepta.

KnownOrigin

El ejecutor previsto de la operación, como en el control de acceso basado en recursos (RBAC) y en la experiencia de usuario de los registros de auditoría. El valor predeterminado es "usuario, sistema"

KnownVersions

Las versiones de API disponibles.

Funciones

isRestError(unknown)

Typeguard para RestError

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

Crea un sondeo a partir del estado serializado de otro sondeo. Esto puede ser útil cuando desea crear sondeos en un host diferente o un sondeo debe construirse después de que el original no esté en el ámbito.

Variables

RestError

Tipo de error personalizado para solicitudes de canalización con error.

Detalles de la función

isRestError(unknown)

Typeguard para RestError

function isRestError(e: unknown): e

Parámetros

e

unknown

Algo capturado por una cláusula catch.

Devoluciones

e

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

Crea un sondeo a partir del estado serializado de otro sondeo. Esto puede ser útil cuando desea crear sondeos en un host diferente o un sondeo debe construirse después de que el original no esté en el ámbito.

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

Parámetros

serializedState

string

sourceOperation

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

Devoluciones

PollerLike<OperationState<TResult>, TResult>

Detalles de variables

RestError

Tipo de error personalizado para solicitudes de canalización con error.

RestError: RestErrorConstructor

Tipo