@azure/arm-programenrollment package

Interfaces

DomainGroup

Um grupo de domínios edu com escopo para um inquilino Entra.

EduEnrollment

Uma matrícula em um programa educacional que agrupa domínios Entra sob um único escopo de programa soberano/edu.

EduEnrollmentPatch

O tipo usado para operações de atualização do EduEnrollment.

EduEnrollmentProperties

Detalhes do Programa EduMatriculation.

EduEnrollmentsCreateOrUpdateOptionalParams

Parâmetros opcionais.

EduEnrollmentsDeleteOptionalParams

Parâmetros opcionais.

EduEnrollmentsGetOptionalParams

Parâmetros opcionais.

EduEnrollmentsListByResourceGroupOptionalParams

Parâmetros opcionais.

EduEnrollmentsListBySubscriptionOptionalParams

Parâmetros opcionais.

EduEnrollmentsOperations

Interface representando uma operação de EduEnrollments.

EduEnrollmentsUpdateOptionalParams

Parâmetros opcionais.

ErrorAdditionalInfo

Informações adicionais sobre o erro de gerenciamento de recursos.

ErrorDetail

O detalhe do erro.

ErrorResponse

Resposta comum de erro para todas as APIs do Azure Resource Manager devolver detalhes de erro em operações falhadas.

Operation

Detalhes de uma operação de API REST, retornada da API de Operações do Provedor de Recursos

OperationDisplay

Informações localizadas de exibição para uma operação.

OperationsListOptionalParams

Parâmetros opcionais.

OperationsOperations

Interface que representa operações de operações.

PageSettings

Opções para o método byPage

PagedAsyncIterableIterator

Uma interface que permite iteração assíncrona iterável tanto para conclusão quanto por página.

ProgramEnrollmentClientOptionalParams

Parâmetros opcionais para o cliente.

Resource

Campos comuns que são retornados na resposta para todos os recursos do Azure Resource Manager

RestorePollerOptions
SystemData

Metadados relativos à criação e última modificação do recurso.

TrackedResource

A definição do modelo de recurso para um recurso de nível superior rastreado pelo Azure Resource Manager que tem 'marcas' e um 'local'

Aliases de tipo

ActionType

Enumeração extensível. Indica o tipo de ação. "Interno" refere-se a ações que são apenas para APIs internas.
KnownActionType pode ser usado de forma intercambiável com ActionType, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

Interno: as ações são para APIs somente internas.

AzureSupportedClouds

Os valores com suporte para a configuração de nuvem como um tipo literal de cadeia de caracteres

ContinuablePage

Uma interface que descreve uma página de resultados.

CreatedByType

O tipo de entidade que criou o recurso.
KnownCreatedByType pode ser usado de forma intercambiável com CreatedByType, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

User: a entidade foi criada por um usuário.
Application: a entidade foi criada por um aplicativo.
ManagedIdentity: a entidade foi criada por uma identidade gerenciada.
Key: a entidade foi criada por uma chave.

DomainGroupState

O estado de avaliação de um grupo de domínio.
KnownDomainGroupState pode ser usado de forma intercambiável com DomainGroupState, esse enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos compatíveis com o serviço

Pendente: Avaliação pendente.
Ação Necessária: É necessária uma ação para concluir a avaliação.
Reprovou: Avaliação reprovou.
Bem-sucedido: Avaliação bem-sucedida.

Origin

O executor pretendido da operação; como no RBAC (Controle de Acesso Baseado em Recursos) e na experiência do usuário dos logs de auditoria. O valor padrão é "user,system"
KnownOrigin pode ser usado de forma intercambiável com a Origem, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

usuário: indica que a operação é iniciada por um usuário.
sistema: indica que a operação é iniciada por um sistema.
usuário,do sistema: indica que a operação é iniciada por um usuário ou sistema.

ProvisioningState

O status da operação atual.
KnownProvisioningState pode ser usado de forma intercambiável com ProvisioningState, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

bem-sucedido: o recurso foi criado.
falha no: falha na criação de recursos.
cancelou: a criação de recursos foi cancelada.
Provisionamento: Provisão inicial em andamento
Atualização: Atualização em andamento
Exclusão: Exclusão em andamento

Enumerações

AzureClouds

Um enum para descrever ambientes de nuvem Azure.

KnownActionType

Enumeração extensível. Indica o tipo de ação. "Interno" refere-se a ações que são apenas para APIs internas.

KnownCreatedByType

O tipo de entidade que criou o recurso.

KnownDomainGroupState

O estado de avaliação de um grupo de domínio.

KnownOrigin

O executor pretendido da operação; como no RBAC (Controle de Acesso Baseado em Recursos) e na experiência do usuário dos logs de auditoria. O valor padrão é "user,system"

KnownProvisioningState

O status da operação atual.

KnownVersions

Valores conhecidos de KnownVersions que o serviço aceita.

Funções

isRestError(unknown)

Typeguard para RestError

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

Cria um sondador do estado serializado de outro sondador. Isso pode ser útil quando você deseja criar sondadores em um host diferente ou um sondador precisa ser construído depois que o original não estiver no escopo.

Variáveis

RestError

Um tipo de erro personalizado para solicitações de pipeline com falha.

Detalhes da função

isRestError(unknown)

Typeguard para RestError

function isRestError(e: unknown): e

Parâmetros

e

unknown

Algo pego por uma cláusula catch.

Retornos

e

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

Cria um sondador do estado serializado de outro sondador. Isso pode ser útil quando você deseja criar sondadores em um host diferente ou um sondador precisa ser construído depois que o original não estiver no escopo.

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

Retornos

PollerLike<OperationState<TResult>, TResult>

Detalhes da variável

RestError

Um tipo de erro personalizado para solicitações de pipeline com falha.

RestError: RestErrorConstructor

Tipo