@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 的操作。 服务支持的已知值内部:操作适用于仅限内部的 API。 |
| AzureSupportedClouds |
云设置为字符串文字类型的支持值 |
| ContinuablePage |
描述结果页的接口。 |
| CreatedByType |
创建资源的实体类型。 服务支持的已知值
用户:实体是由用户创建的。 |
| DomainGroupState |
域组的评估状态。 服务支持的已知值
待定:评估尚未完成。 |
| Origin |
操作的预期执行者;例如在基于资源的访问控制(RBAC)和审核日志的用户体验中。 默认值为“user,system” 服务支持的已知值
用户:指示操作是由用户启动的。 |
| ProvisioningState |
当前作的状态。 服务支持的已知值
已成功:已创建资源。 |
枚举
| AzureClouds |
一个用来描述Azure云环境的enum。 |
| KnownActionType |
可扩展枚举。 指示操作类型。 “内部”是指仅适用于内部 API 的操作。 |
| KnownCreatedByType |
创建资源的实体类型。 |
| KnownDomainGroupState |
域组的评估状态。 |
| KnownOrigin |
操作的预期执行者;例如在基于资源的访问控制(RBAC)和审核日志的用户体验中。 默认值为“user,system” |
| KnownProvisioningState |
当前作的状态。 |
| KnownVersions |
服务的已知 KnownVersions 值。 |
函数
| is |
RestError 的 Typeguard |
| restore |
从另一轮询程序的序列化状态创建轮询器。 如果要在不同的主机上创建轮询器,或者在原始轮询器不在范围内后构造轮询器,这非常有用。 |
变量
| Rest |
失败管道请求的自定义错误类型。 |
函数详细信息
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>
参数
- client
- ProgramEnrollmentClient
- serializedState
-
string
- sourceOperation
-
(args: any[]) => PollerLike<OperationState<TResult>, TResult>
- options
-
RestorePollerOptions<TResult, PathUncheckedResponse>
返回
PollerLike<OperationState<TResult>, TResult>