@azure/arm-confluent package

Classes

ConfluentManagementClient

Interfaces

APIKeyOwnerEntity	API Key Owner details which can be a user or service account
APIKeyProperties	API Key Properties
APIKeyRecord	Details API key
APIKeyResourceEntity	API Key Resource details which can be kafka cluster or schema registry cluster
APIKeySpecEntity	Spec of the API Key record
AccessCreateRoleBindingOptionalParams	Optional parameters.
AccessCreateRoleBindingRequestModel	Create role binding request model
AccessDeleteRoleBindingOptionalParams	Optional parameters.
AccessInviteUserAccountModel	Invite User Account model
AccessInviteUserOptionalParams	Optional parameters.
AccessInvitedUserDetails	Details of the user being invited
AccessListClusterSuccessResponse	Details of the clusters returned on successful response
AccessListClustersOptionalParams	Optional parameters.
AccessListEnvironmentsOptionalParams	Optional parameters.
AccessListEnvironmentsSuccessResponse	Details of the environments returned on successful response
AccessListInvitationsOptionalParams	Optional parameters.
AccessListInvitationsSuccessResponse	List invitations success response
AccessListRoleBindingNameListOptionalParams	Optional parameters.
AccessListRoleBindingsOptionalParams	Optional parameters.
AccessListRoleBindingsSuccessResponse	Details of the role bindings returned on successful response
AccessListServiceAccountsOptionalParams	Optional parameters.
AccessListServiceAccountsSuccessResponse	List service accounts success response
AccessListUsersOptionalParams	Optional parameters.
AccessListUsersSuccessResponse	List users success response
AccessOperations	Interface representing a Access operations.
AccessRoleBindingNameListSuccessResponse	Details of the role binding names returned on successful response
AzureBlobStorageSinkConnectorServiceInfo	The authentication info when auth_type is azureBlobStorageSinkConnector
AzureBlobStorageSourceConnectorServiceInfo	The connector service type is AzureBlobStorageSourceConnector
AzureCosmosDBSinkConnectorServiceInfo	The authentication info when auth_type is AzureCosmosDBSinkConnector
AzureCosmosDBSourceConnectorServiceInfo	The authentication info when auth_type is AzureCosmosDBSourceConnector
AzureSynapseAnalyticsSinkConnectorServiceInfo	The authentication info when auth_type is AzureSynapseAnalyticsSinkConnector
ClusterByokEntity	The network associated with this object
ClusterConfigEntity	The configuration of the Kafka cluster
ClusterCreateOrUpdateOptionalParams	Optional parameters.
ClusterDeleteOptionalParams	Optional parameters.
ClusterEnvironmentEntity	The environment to which cluster belongs
ClusterNetworkEntity	The network associated with this object
ClusterOperations	Interface representing a Cluster operations.
ClusterProperties	Service Connector Cluster Properties
ClusterRecord	Details of cluster record
ClusterSpecEntity	Spec of the cluster record
ClusterStatusEntity	Status of the cluster record
ConfluentAgreementProperties	Terms properties for Marketplace and Confluent.
ConfluentAgreementResource	Agreement Terms definition
ConfluentListMetadata	Metadata of the list
ConfluentManagementClientOptionalParams	Optional parameters for the client.
ConnectorCreateOrUpdateOptionalParams	Optional parameters.
ConnectorDeleteOptionalParams	Optional parameters.
ConnectorGetOptionalParams	Optional parameters.
ConnectorInfoBase	Connector Info Base properties
ConnectorListOptionalParams	Optional parameters.
ConnectorOperations	Interface representing a Connector operations.
ConnectorResource	Details of connector record
ConnectorResourceProperties	The resource properties of the Connector
ConnectorServiceTypeInfoBase	The connector service type info
CreateAPIKeyModel	Create API Key model
EnvironmentCreateOrUpdateOptionalParams	Optional parameters.
EnvironmentDeleteOptionalParams	Optional parameters.
EnvironmentOperations	Interface representing a Environment operations.
EnvironmentProperties	Environment resource property
EnvironmentRecord	Details about environment name, metadata and environment id of an environment
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Common error response for all Azure Resource Manager APIs to return error details for failed operations.
ErrorResponseBody	Response body of Error
InvitationRecord	Record of the invitation
KafkaAzureBlobStorageSinkConnectorInfo	The partner connector type is KafkaAzureBlobStorageSink
KafkaAzureBlobStorageSourceConnectorInfo	The partner connector type is KafkaAzureBlobStorageSource
KafkaAzureCosmosDBSinkConnectorInfo	The partner connector type is KafkaAzureCosmosDBSink
KafkaAzureCosmosDBSourceConnectorInfo	The partner connector type is KafkaAzureCosmosDBSource
KafkaAzureSynapseAnalyticsSinkConnectorInfo	The partner connector type is KafkaAzureSynapseAnalyticsSink
LinkOrganization	Link an existing Confluent organization
ListAccessRequestModel	List Access Request Model
ListRegionsSuccessResponse	Result of POST request to list regions supported by confluent
MarketplaceAgreementsCreateOptionalParams	Optional parameters.
MarketplaceAgreementsListOptionalParams	Optional parameters.
MarketplaceAgreementsOperations	Interface representing a MarketplaceAgreements operations.
MetadataEntity	Metadata of the data record
OfferDetail	Confluent Offer detail
OperationDisplay	The object that represents the operation.
OperationResult	An Confluent REST API operation.
OrganizationCreateAPIKeyOptionalParams	Optional parameters.
OrganizationCreateOptionalParams	Optional parameters.
OrganizationDeleteClusterAPIKeyOptionalParams	Optional parameters.
OrganizationDeleteOptionalParams	Optional parameters.
OrganizationGetClusterAPIKeyOptionalParams	Optional parameters.
OrganizationGetClusterByIdOptionalParams	Optional parameters.
OrganizationGetEnvironmentByIdOptionalParams	Optional parameters.
OrganizationGetOptionalParams	Optional parameters.
OrganizationGetSchemaRegistryClusterByIdOptionalParams	Optional parameters.
OrganizationListByResourceGroupOptionalParams	Optional parameters.
OrganizationListBySubscriptionOptionalParams	Optional parameters.
OrganizationListClustersOptionalParams	Optional parameters.
OrganizationListEnvironmentsOptionalParams	Optional parameters.
OrganizationListRegionsOptionalParams	Optional parameters.
OrganizationListSchemaRegistryClustersOptionalParams	Optional parameters.
OrganizationOperations	Interface representing a Organization operations.
OrganizationOperationsListOptionalParams	Optional parameters.
OrganizationOperationsOperations	Interface representing a OrganizationOperations operations.
OrganizationResource	Organization resource.
OrganizationResourceProperties	Organization resource property
OrganizationResourceUpdate	Organization Resource update
OrganizationUpdateOptionalParams	Optional parameters.
PageSettings	Options for the byPage method
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
PartnerInfoBase	The partner info base
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
RegionProperties	Region Properties
RegionRecord	Details of region record
RegionSpecEntity	Region spec details
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
ResourceProviderDefaultErrorResponse	Default error response for resource provider
RestorePollerOptions
RoleBindingRecord	Details on principal, role name and crn pattern of a role binding
SCClusterByokEntity	The network associated with this object
SCClusterNetworkEnvironmentEntity	The environment or the network to which cluster belongs
SCClusterRecord	Details of cluster record
SCClusterSpecEntity	Spec of the cluster record
SCEnvironmentRecord	Details about environment name, metadata and environment id of an environment
SCMetadataEntity	Metadata of the data record
SchemaRegistryClusterEnvironmentRegionEntity	The environment associated with this object
SchemaRegistryClusterProperties	Schema Registry Cluster Properties
SchemaRegistryClusterRecord	Details of schema registry cluster record
SchemaRegistryClusterSpecEntity	Details of schema registry cluster spec
SchemaRegistryClusterStatusEntity	Status of the schema registry cluster record
ServiceAccountRecord	Record of the service account
SimplePollerLike	A simple poller that can be used to poll a long running operation.
StreamGovernanceConfig	Stream governance configuration
SystemData	Metadata pertaining to creation and last modification of the resource.
TopicMetadataEntity	Metadata of the data record
TopicProperties	Topic Properties
TopicRecord	Details of topic record
TopicsCreateOptionalParams	Optional parameters.
TopicsDeleteOptionalParams	Optional parameters.
TopicsGetOptionalParams	Optional parameters.
TopicsInputConfig	Topics input config
TopicsListOptionalParams	Optional parameters.
TopicsOperations	Interface representing a Topics operations.
TopicsRelatedLink	Partition Config spec of the topic record
TrackedResource	The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'
UserDetail	Subscriber detail
UserRecord	Record of the user
ValidationResponse	Validation response from the provider
ValidationsOperations	Interface representing a Validations operations.
ValidationsValidateOrganizationOptionalParams	Optional parameters.
ValidationsValidateOrganizationV2OptionalParams	Optional parameters.

Type Aliases

AuthType	Kafka Connector Auth Type KnownAuthType can be used interchangeably with AuthType, this enum contains the known values that the service supports. Known values supported by the service SERVICE_ACCOUNT KAFKA_API_KEY
AzureSupportedClouds	The supported values for cloud setting as a string literal type
ConnectorClass	Connector Class KnownConnectorClass can be used interchangeably with ConnectorClass, this enum contains the known values that the service supports. Known values supported by the service AZUREBLOBSOURCE AZUREBLOBSINK AZURECOSMOSV2SINK AZURECOSMOSV2SOURCE
ConnectorServiceType	The connector service type. KnownConnectorServiceType can be used interchangeably with ConnectorServiceType, this enum contains the known values that the service supports. Known values supported by the service AzureBlobStorageSinkConnector AzureBlobStorageSourceConnector AzureCosmosDBSinkConnector AzureCosmosDBSourceConnector AzureSynapseAnalyticsSinkConnector
ConnectorServiceTypeInfoBaseUnion	Alias for ConnectorServiceTypeInfoBaseUnion
ConnectorStatus	Connector Status KnownConnectorStatus can be used interchangeably with ConnectorStatus, this enum contains the known values that the service supports. Known values supported by the service PROVISIONING RUNNING PAUSED FAILED
ConnectorType	Connector Type KnownConnectorType can be used interchangeably with ConnectorType, this enum contains the known values that the service supports. Known values supported by the service SINK SOURCE
ContinuablePage	An interface that describes a page of results.
CreatedByType	The kind of entity that created the resource. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User: The entity was created by a user. Application: The entity was created by an application. ManagedIdentity: The entity was created by a managed identity. Key: The entity was created by a key.
DataFormatType	Data Format Type KnownDataFormatType can be used interchangeably with DataFormatType, this enum contains the known values that the service supports. Known values supported by the service AVRO JSON STRING BYTES PROTOBUF
Package	Stream Governance Package. Supported values are ESSENTIALS and ADVANCED KnownPackage can be used interchangeably with Package, this enum contains the known values that the service supports. Known values supported by the service ESSENTIALS ADVANCED
PartnerConnectorType	Partner Connector type. KnownPartnerConnectorType can be used interchangeably with PartnerConnectorType, this enum contains the known values that the service supports. Known values supported by the service KafkaAzureBlobStorageSource KafkaAzureBlobStorageSink KafkaAzureCosmosDBSource KafkaAzureCosmosDBSink KafkaAzureSynapseAnalyticsSink
PartnerInfoBaseUnion	Alias for PartnerInfoBaseUnion
ProvisionState	Provision states for confluent RP KnownProvisionState can be used interchangeably with ProvisionState, this enum contains the known values that the service supports. Known values supported by the service Accepted Creating Updating Deleting Succeeded Failed Canceled Deleted NotSpecified
SaaSOfferStatus	SaaS Offer Status for confluent RP KnownSaaSOfferStatus can be used interchangeably with SaaSOfferStatus, this enum contains the known values that the service supports. Known values supported by the service Started PendingFulfillmentStart InProgress Subscribed Suspended Reinstated Succeeded Failed Unsubscribed Updating

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownAuthType	Kafka Connector Auth Type
KnownConnectorClass	Connector Class
KnownConnectorServiceType	The connector service type.
KnownConnectorStatus	Connector Status
KnownConnectorType	Connector Type
KnownCreatedByType	The kind of entity that created the resource.
KnownDataFormatType	Data Format Type
KnownPackage	Stream Governance Package. Supported values are ESSENTIALS and ADVANCED
KnownPartnerConnectorType	Partner Connector type.
KnownProvisionState	Provision states for confluent RP
KnownSaaSOfferStatus	SaaS Offer Status for confluent RP
KnownVersions	The available API versions.

Functions

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

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

Function Details

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

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

function restorePoller<TResponse, TResult>(client: ConfluentManagementClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

client

ConfluentManagementClient

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

options

RestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>