你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

@azure/arm-programenrollment package

接口

DomainGroup

一组针对Entra租户的教育领域。

EduEnrollment

这是一个将Entra域名归入单一主权/教育项目范围的教育项目注册。

EduEnrollmentPatch

用于EduEnrollment更新操作的类型。

EduEnrollmentProperties

项目详情 教育注册。

EduEnrollmentsCreateOrUpdateOptionalParams

可选参数。

EduEnrollmentsDeleteOptionalParams

可选参数。

EduEnrollmentsGetOptionalParams

可选参数。

EduEnrollmentsListByResourceGroupOptionalParams

可选参数。

EduEnrollmentsListBySubscriptionOptionalParams

可选参数。

EduEnrollmentsOperations

表示 EduEnrollments 操作的接口。

EduEnrollmentsUpdateOptionalParams

可选参数。

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详情

ErrorResponse

所有 Azure 资源管理器 API 的通用错误响应,用于返回失败操作的错误细节。

Operation

从资源提供程序作 API 返回的 REST API作的详细信息

OperationDisplay

作的局部显示信息。

OperationsListOptionalParams

可选参数。

OperationsOperations

表示操作操作的接口。

PageSettings

byPage 方法的选项

PagedAsyncIterableIterator

允许异步迭代到完成和逐页迭代的接口。

ProgramEnrollmentClientOptionalParams

客户端的可选参数。

Resource

所有 Azure 资源管理器资源的响应中返回的常见字段

RestorePollerOptions
SystemData

与创建和上次修改资源相关的元数据。

TrackedResource

Azure 资源管理器的资源模型定义跟踪了具有“标记”和“位置”的顶级资源

类型别名

ActionType

可扩展枚举。 指示操作类型。 “内部”是指仅适用于内部 API 的操作。
KnownActionType 可与 ActionType 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

内部:操作适用于仅限内部的 API。

AzureSupportedClouds

云设置为字符串文字类型的支持值

ContinuablePage

描述结果页的接口。

CreatedByType

创建资源的实体类型。
KnownCreatedByType 可与 CreatedByType 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

用户:实体是由用户创建的。
应用程序:实体是由应用程序创建的。
ManagedIdentity:实体是由托管标识创建的。
密钥:实体是由密钥创建的。

DomainGroupState

域组的评估状态。
KnownDomainGroupState 可以与 DomainGroupState 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

定:评估尚未完成。
需要行动:完成评估需要采取行动。
未通过:评估未通过。
成功:评估成功。

Origin

操作的预期执行者;例如在基于资源的访问控制(RBAC)和审核日志的用户体验中。 默认值为“user,system”
KnownOrigin 可与 Origin 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

用户:指示操作是由用户启动的。
系统:指示操作是由系统启动的。
用户,系统:指示操作是由用户或系统启动的。

ProvisioningState

当前作的状态。
KnownProvisioningState 可与 ProvisioningState 互换,此枚举包含服务支持的已知值。

服务支持的已知值

已成功:已创建资源。
失败:资源创建失败。
已取消:资源创建已取消。
配置:初始配置正在进行中
更新:更新进行中
删除中:正在删除

枚举

AzureClouds

一个用来描述Azure云环境的enum。

KnownActionType

可扩展枚举。 指示操作类型。 “内部”是指仅适用于内部 API 的操作。

KnownCreatedByType

创建资源的实体类型。

KnownDomainGroupState

域组的评估状态。

KnownOrigin

操作的预期执行者;例如在基于资源的访问控制(RBAC)和审核日志的用户体验中。 默认值为“user,system”

KnownProvisioningState

当前作的状态。

KnownVersions

服务的已知 KnownVersions 值。

函数

isRestError(unknown)

RestError 的 Typeguard

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

从另一轮询程序的序列化状态创建轮询器。 如果要在不同的主机上创建轮询器,或者在原始轮询器不在范围内后构造轮询器,这非常有用。

变量

RestError

失败管道请求的自定义错误类型。

函数详细信息

isRestError(unknown)

RestError 的 Typeguard

function isRestError(e: unknown): e

参数

e

unknown

catch 子句捕获的内容。

返回

e

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

从另一轮询程序的序列化状态创建轮询器。 如果要在不同的主机上创建轮询器,或者在原始轮询器不在范围内后构造轮询器,这非常有用。

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

类型