@azure/arm-programenrollment package

Interfaces

DomainGroup

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

EduEnrollment

Uma inscrição em programas educativos que agrupa domínios Entra sob um único âmbito de programa soberano/edu.

EduEnrollmentPatch

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

EduEnrollmentProperties

Detalhes do programa EduEnrollment.

EduEnrollmentsCreateOrUpdateOptionalParams

Parâmetros opcionais.

EduEnrollmentsDeleteOptionalParams

Parâmetros opcionais.

EduEnrollmentsGetOptionalParams

Parâmetros opcionais.

EduEnrollmentsListByResourceGroupOptionalParams

Parâmetros opcionais.

EduEnrollmentsListBySubscriptionOptionalParams

Parâmetros opcionais.

EduEnrollmentsOperations

Interface que representa uma operação de EduEnrollments.

EduEnrollmentsUpdateOptionalParams

Parâmetros opcionais.

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

ErrorDetail

O detalhe do erro.

ErrorResponse

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

Operation

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

OperationDisplay

Informação de visualização localizada para uma operação.

OperationsListOptionalParams

Parâmetros opcionais.

OperationsOperations

Interface que representa uma operação de Operações.

PageSettings

Opções para o método byPage

PagedAsyncIterableIterator

Uma interface que permite iteração assíncrona iterável até a conclusão e 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 referentes à criação e última modificação do recurso.

TrackedResource

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

Aliases de Tipo

ActionType

Enum 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, este enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

interno: As ações são apenas para APIs internas.

AzureSupportedClouds

Os valores suportados 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, esse enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo 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, este enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

Pendente: A avaliação está pendente.
Ação Necessária: É necessária uma ação para completar a avaliação.
Falhou: Avaliação falhou.
Sucesso: Avaliação bem-sucedida.

Origin

O executor pretendido da operação; como no Controle de Acesso Baseado em Recursos (RBAC) e na UX de logs de auditoria. O valor padrão é "user,system"
KnownOrigin pode ser usado de forma intercambiável com Origin, este enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo 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, 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, esse enum contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

Successful: O recurso foi criado.
Falha: Falha na criação de recursos.
cancelado: A criação de recursos foi cancelada.
Provisionamento: Provisionamento inicial em curso
Atualização: Atualização em curso
Eliminação: Eliminação em curso

Enumerações

AzureClouds

Um enum para descrever ambientes Azure Cloud.

KnownActionType

Enum 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 Controle de Acesso Baseado em Recursos (RBAC) e na UX de 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 poller a partir do estado serializado de outro poller. Isso pode ser útil quando você deseja criar pollers em um host diferente ou um poller precisa ser construído depois que o original não está no escopo.

Variáveis

RestError

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

Detalhes de Função

isRestError(unknown)

Typeguard para RestError

function isRestError(e: unknown): e

Parâmetros

e

unknown

Algo apanhado por uma cláusula de captura.

Devoluções

e

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

Cria um poller a partir do estado serializado de outro poller. Isso pode ser útil quando você deseja criar pollers em um host diferente ou um poller precisa ser construído depois que o original não está 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>

Devoluções

PollerLike<OperationState<TResult>, TResult>

Detalhes das variáveis

RestError

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

RestError: RestErrorConstructor

Tipo