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

@azure/arm-confluent package

接口

APIKeyOwnerEntity

API 密钥所有者详细信息,可以是用户或服务帐户

APIKeyProperties

API 密钥属性

APIKeyRecord

详细信息 API 密钥

APIKeyResourceEntity

API 密钥资源详细信息,可以是 kafka 集群或模式注册表集群

APIKeySpecEntity

API 密钥记录的规范

AccessCreateRoleBindingOptionalParams

可选参数。

AccessCreateRoleBindingRequestModel

创建角色绑定请求模型

AccessDeleteRoleBindingOptionalParams

可选参数。

AccessInviteUserAccountModel

邀请用户帐户模型

AccessInviteUserOptionalParams

可选参数。

AccessInvitedUserDetails

受邀用户的详细信息

AccessListClusterSuccessResponse

成功响应时返回的群集的详细信息

AccessListClustersOptionalParams

可选参数。

AccessListEnvironmentsOptionalParams

可选参数。

AccessListEnvironmentsSuccessResponse

成功响应时返回的环境的详细信息

AccessListInvitationsOptionalParams

可选参数。

AccessListInvitationsSuccessResponse

列出邀请成功响应

AccessListRoleBindingNameListOptionalParams

可选参数。

AccessListRoleBindingsOptionalParams

可选参数。

AccessListRoleBindingsSuccessResponse

成功响应时返回的角色绑定的详细信息

AccessListServiceAccountsOptionalParams

可选参数。

AccessListServiceAccountsSuccessResponse

列出服务帐户成功响应

AccessListUsersOptionalParams

可选参数。

AccessListUsersSuccessResponse

列出用户成功响应

AccessOperations

表示访问操作的接口。

AccessRoleBindingNameListSuccessResponse

成功响应时返回的角色绑定名称的详细信息

AzureBlobStorageSinkConnectorServiceInfo

auth_type时的身份验证信息为 azureBlobStorageSinkConnector

AzureBlobStorageSourceConnectorServiceInfo

连接器服务类型为 AzureBlobStorageSourceConnector

AzureCosmosDBSinkConnectorServiceInfo

auth_type时的身份验证信息是 AzureCosmosDBSinkConnector

AzureCosmosDBSourceConnectorServiceInfo

auth_type为 AzureCosmosDBSourceConnector 时的身份验证信息

AzureSynapseAnalyticsSinkConnectorServiceInfo

auth_type时的身份验证信息为 AzureSynapseAnalyticsSinkConnector

ClusterByokEntity

与此对象关联的网络

ClusterConfigEntity

Kafka 集群的配置

ClusterCreateOrUpdateOptionalParams

可选参数。

ClusterDeleteOptionalParams

可选参数。

ClusterEnvironmentEntity

集群所属的环境

ClusterNetworkEntity

与此对象关联的网络

ClusterOperations

代表集群操作的接口。

ClusterProperties

服务连接器集群属性

ClusterRecord

集群记录详情

ClusterSpecEntity

集群记录的规范

ClusterStatusEntity

集群记录的状态

ConfluentAgreementProperties

市场和汇流的术语。

ConfluentAgreementResource

协议条款定义

ConfluentListMetadata

列表的元数据

ConfluentManagementClientOptionalParams

客户端的可选参数。

ConnectorCreateOrUpdateOptionalParams

可选参数。

ConnectorDeleteOptionalParams

可选参数。

ConnectorGetOptionalParams

可选参数。

ConnectorInfoBase

连接器信息基础属性

ConnectorListOptionalParams

可选参数。

ConnectorOperations

接口表示连接器操作。

ConnectorResource

连接器记录的详细信息

ConnectorResourceProperties

连接器的资源属性

ConnectorServiceTypeInfoBase

连接器服务类型信息

CreateAPIKeyModel

创建 API 密钥模型

EnvironmentCreateOrUpdateOptionalParams

可选参数。

EnvironmentDeleteOptionalParams

可选参数。

EnvironmentOperations

表示环境操作的接口。

EnvironmentProperties

环境资源属性

EnvironmentRecord

有关环境名称、元数据和环境 ID 的详细信息

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

所有 Azure 资源管理器 API 的常见错误响应,以返回失败操作的错误详细信息。

ErrorResponseBody

错误响应正文

InvitationRecord

邀请记录

KafkaAzureBlobStorageSinkConnectorInfo

合作伙伴连接器类型为 KafkaAzureBlobStorageSink

KafkaAzureBlobStorageSourceConnectorInfo

合作伙伴连接器类型为 KafkaAzureBlobStorageSource

KafkaAzureCosmosDBSinkConnectorInfo

合作伙伴连接器类型为 KafkaAzureCosmosDBSink

KafkaAzureCosmosDBSourceConnectorInfo

合作伙伴连接器类型为 KafkaAzureCosmosDBSource

KafkaAzureSynapseAnalyticsSinkConnectorInfo

合作伙伴连接器类型为 KafkaAzureSynapseAnalyticsSink

LinkOrganization

链接现有 Confluent 组织

ListAccessRequestModel

列表访问请求模型

ListRegionsSuccessResponse

列出 confluent 支持的区域的 POST 请求的结果

MarketplaceAgreementsCreateOptionalParams

可选参数。

MarketplaceAgreementsListOptionalParams

可选参数。

MarketplaceAgreementsOperations

代表MarketplaceAgreements操作的接口。

MetadataEntity

数据记录的元数据

OfferDetail

Confluent 产品/服务详细信息

OperationDisplay

表示作的对象。

OperationResult

Confluent REST API作。

OrganizationCreateAPIKeyOptionalParams

可选参数。

OrganizationCreateOptionalParams

可选参数。

OrganizationDeleteClusterAPIKeyOptionalParams

可选参数。

OrganizationDeleteOptionalParams

可选参数。

OrganizationGetClusterAPIKeyOptionalParams

可选参数。

OrganizationGetClusterByIdOptionalParams

可选参数。

OrganizationGetEnvironmentByIdOptionalParams

可选参数。

OrganizationGetOptionalParams

可选参数。

OrganizationGetSchemaRegistryClusterByIdOptionalParams

可选参数。

OrganizationListByResourceGroupOptionalParams

可选参数。

OrganizationListBySubscriptionOptionalParams

可选参数。

OrganizationListClustersOptionalParams

可选参数。

OrganizationListEnvironmentsOptionalParams

可选参数。

OrganizationListRegionsOptionalParams

可选参数。

OrganizationListSchemaRegistryClustersOptionalParams

可选参数。

OrganizationOperations

代表组织运营的接口。

OrganizationOperationsListOptionalParams

可选参数。

OrganizationOperationsOperations

代表组织运营的接口。

OrganizationResource

组织资源。

OrganizationResourceProperties

组织资源属性

OrganizationResourceUpdate

组织资源更新

OrganizationUpdateOptionalParams

可选参数。

PageSettings

byPage 方法的选项

PagedAsyncIterableIterator

一个允许异步可迭代的接口,以完成和按页面进行迭代。

PartnerInfoBase

合作伙伴信息库

ProxyResource

Azure 资源管理器代理资源的资源模型定义。 它不具有标记和位置

RegionProperties

区域属性

RegionRecord

地区记录详情

RegionSpecEntity

区域规范详细信息

Resource

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

ResourceProviderDefaultErrorResponse

资源提供程序的默认错误响应

RestorePollerOptions
RoleBindingRecord

有关角色绑定的主体、角色名称和 crn 模式的详细信息

SCClusterByokEntity

与此对象关联的网络

SCClusterNetworkEnvironmentEntity

集群所属的环境或网络

SCClusterRecord

集群记录详情

SCClusterSpecEntity

集群记录的规范

SCEnvironmentRecord

有关环境名称、元数据和环境 ID 的详细信息

SCMetadataEntity

数据记录的元数据

SchemaRegistryClusterEnvironmentRegionEntity

与此对象关联的环境

SchemaRegistryClusterProperties

模式注册表集群属性

SchemaRegistryClusterRecord

架构注册表集群记录的详细信息

SchemaRegistryClusterSpecEntity

架构注册表集群规范的详细信息

SchemaRegistryClusterStatusEntity

架构注册表群集记录的状态

ServiceAccountRecord

服务帐户记录

SimplePollerLike

可用于轮询长时间运行的操作的简单轮询程序。

StreamGovernanceConfig

流治理配置

SystemData

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

TopicMetadataEntity

数据记录的元数据

TopicProperties

主题属性

TopicRecord

主题记录详情

TopicsCreateOptionalParams

可选参数。

TopicsDeleteOptionalParams

可选参数。

TopicsGetOptionalParams

可选参数。

TopicsInputConfig

主题输入配置

TopicsListOptionalParams

可选参数。

TopicsOperations

表示主题操作的接口。

TopicsRelatedLink

主题记录的分区配置规范

TrackedResource

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

UserDetail

订阅者详细信息

UserRecord

用户记录

ValidationResponse

来自提供商的验证响应

ValidationsOperations

表示验证操作的接口。

ValidationsValidateOrganizationOptionalParams

可选参数。

ValidationsValidateOrganizationV2OptionalParams

可选参数。

类型别名

AuthType

Kafka 连接器认证类型
KnownAuthType 可与 AuthType 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

SERVICE_ACCOUNT
KAFKA_API_KEY

AzureSupportedClouds

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

ConnectorClass

连接型
KnownConnectorClass 可以与 ConnectorClass 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

AZUREBLOBSOURCE
AZUREBLOBSINK
AZURECOSMOSV2SINK
AZURECOSMOSV2SOURCE

ConnectorServiceType

连接器服务类型。
KnownConnectorServiceType 可以与 ConnectorServiceType 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

AzureBlobStorageSinkConnector
AzureBlobStorageSourceConnector
AzureCosmosDBSinkConnector
AzureCosmosDBSourceConnector
AzureSynapseAnalyticsSinkConnector

ConnectorServiceTypeInfoBaseUnion

Alias for ConnectorServiceTypeInfoBaseUnion

ConnectorStatus

连接状态
KnownConnectorStatus 可以与 ConnectorStatus 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

配置
运行
暂停
失败

ConnectorType

连接器类型
KnownConnectorType 可以与ConnectorType互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

沉没
资料来源

ContinuablePage

描述结果页面的接口。

CreatedByType

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

服务支持的已知值

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

DataFormatType

数据格式类型
KnownDataFormatType 可以与 DataFormatType 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

阿弗罗
JSON
字符串
字节
普罗托布夫

Package

流治理包。 支持的值有ESSENTIALS和ADVANCED(高级)
KnownPackage 可以与 Package 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

基础
高级

PartnerConnectorType

合作伙伴连接器类型。
KnownPartnerConnectorType 可以与 PartnerConnectorType 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

KafkaAzureBlobStorageSource
KafkaAzureBlobStorageSink
KafkaAzureCosmosDBSource
KafkaAzureCosmosDBSink
KafkaAzureSynapseAnalyticsSink

PartnerInfoBaseUnion

PartnerInfoBaseUnion 的别名

ProvisionState

对汇流RP的规定
KnownProvisionState 可与 ProvisionState 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

已接受
创建
更新
删除
成功
失败
已取消
已删除
NotSpecified

SaaSOfferStatus

Confluent RP 的 SaaS Offer Status
KnownSaaSOfferStatus 可与 SaaSOfferStatus 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

已启动
PendingFulfillmentStart
InProgress
订阅
暂停
恢复
成功
失败
未订阅
更新

枚举

AzureClouds

用于描述 Azure 云环境的枚举。

KnownAuthType

Kafka 连接器身份验证类型

KnownConnectorClass

连接器类

KnownConnectorServiceType

连接器服务类型。

KnownConnectorStatus

连接器状态

KnownConnectorType

“连接器类型”

KnownCreatedByType

创建资源的实体类型。

KnownDataFormatType

数据格式类型

KnownPackage

流治理包。 支持的值为 ESSENTIALS 和 ADVANCED

KnownPartnerConnectorType

合作伙伴连接器类型。

KnownProvisionState

Confluent RP 的预置状态

KnownSaaSOfferStatus

Confluent RP 的 SaaS 产品/服务状态

KnownVersions

可用的 API 版本。

函数

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

从另一个轮询器的序列化状态创建轮询器。 当您想要在不同的主机上创建轮询器或需要在原始轮询器不在作用域内后构造轮询器时,这会很有用。

函数详细信息

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

从另一个轮询器的序列化状态创建轮询器。 当您想要在不同的主机上创建轮询器或需要在原始轮询器不在作用域内后构造轮询器时,这会很有用。

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