@azure/arm-confluent package
Classes
| ConfluentManagementClient |
Interfaces
| APIKeyOwnerEntity |
API Key Owner details which can be a user or service account |
| 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 |
| Access |
Interface representing a Access. |
| 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 |
| AccessRoleBindingNameListSuccessResponse |
Details of the role binding names returned on successful response |
| ClusterByokEntity |
The network associated with this object |
| ClusterConfigEntity |
The configuration of the Kafka cluster |
| ClusterEnvironmentEntity |
The environment to which cluster belongs |
| ClusterNetworkEntity |
The network associated with this object |
| ClusterRecord |
Details of cluster record |
| ClusterSpecEntity |
Spec of the cluster record |
| ClusterStatusEntity |
Status of the cluster record |
| ConfluentAgreementResource |
Agreement Terms definition |
| ConfluentAgreementResourceListResponse |
Response of a list operation. |
| ConfluentListMetadata |
Metadata of the list |
| ConfluentManagementClientOptionalParams |
Optional parameters. |
| CreateAPIKeyModel |
Create API Key model |
| EnvironmentRecord |
Details about environment name, metadata and environment id of an environment |
| ErrorResponseBody |
Response body of Error |
| GetEnvironmentsResponse |
Result of GET request to list Confluent operations. |
| InvitationRecord |
Record of the invitation |
| LinkOrganization |
Link an existing Confluent organization |
| ListAccessRequestModel |
List Access Request Model |
| ListClustersSuccessResponse |
Result of GET request to list clusters in the environment of a confluent organization |
| ListRegionsSuccessResponse |
Result of POST request to list regions supported by confluent |
| ListSchemaRegistryClustersResponse |
Result of GET request to list schema registry clusters in the environment of a confluent organization |
| MarketplaceAgreements |
Interface representing a MarketplaceAgreements. |
| MarketplaceAgreementsCreateOptionalParams |
Optional parameters. |
| MarketplaceAgreementsListNextOptionalParams |
Optional parameters. |
| MarketplaceAgreementsListOptionalParams |
Optional parameters. |
| MetadataEntity |
Metadata of the data record |
| OfferDetail |
Confluent Offer detail |
| OperationDisplay |
The object that represents the operation. |
| OperationListResult |
Result of GET request to list Confluent operations. |
| OperationResult |
An Confluent REST API operation. |
| Organization |
Interface representing a Organization. |
| 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. |
| OrganizationListByResourceGroupNextOptionalParams |
Optional parameters. |
| OrganizationListByResourceGroupOptionalParams |
Optional parameters. |
| OrganizationListBySubscriptionNextOptionalParams |
Optional parameters. |
| OrganizationListBySubscriptionOptionalParams |
Optional parameters. |
| OrganizationListClustersNextOptionalParams |
Optional parameters. |
| OrganizationListClustersOptionalParams |
Optional parameters. |
| OrganizationListEnvironmentsNextOptionalParams |
Optional parameters. |
| OrganizationListEnvironmentsOptionalParams |
Optional parameters. |
| OrganizationListRegionsOptionalParams |
Optional parameters. |
| OrganizationListSchemaRegistryClustersNextOptionalParams |
Optional parameters. |
| OrganizationListSchemaRegistryClustersOptionalParams |
Optional parameters. |
| OrganizationOperations |
Interface representing a OrganizationOperations. |
| OrganizationOperationsListNextOptionalParams |
Optional parameters. |
| OrganizationOperationsListOptionalParams |
Optional parameters. |
| OrganizationResource |
Organization resource. |
| OrganizationResourceListResult |
The response of a list operation. |
| OrganizationResourceUpdate |
Organization Resource update |
| OrganizationUpdateOptionalParams |
Optional parameters. |
| RegionRecord |
Details of region record |
| RegionSpecEntity |
Region spec details |
| ResourceProviderDefaultErrorResponse |
Default error response for resource provider |
| 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 |
| SCConfluentListMetadata |
Metadata of the list |
| 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 |
| 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 |
| SystemData |
Metadata pertaining to creation and last modification of the resource. |
| UserDetail |
Subscriber detail |
| UserRecord |
Record of the user |
| ValidationResponse |
Validation response from the provider |
| Validations |
Interface representing a Validations. |
| ValidationsValidateOrganizationOptionalParams |
Optional parameters. |
| ValidationsValidateOrganizationV2OptionalParams |
Optional parameters. |
Type Aliases
| AccessCreateRoleBindingResponse |
Contains response data for the createRoleBinding operation. |
| AccessInviteUserResponse |
Contains response data for the inviteUser operation. |
| AccessListClustersResponse |
Contains response data for the listClusters operation. |
| AccessListEnvironmentsResponse |
Contains response data for the listEnvironments operation. |
| AccessListInvitationsResponse |
Contains response data for the listInvitations operation. |
| AccessListRoleBindingNameListResponse |
Contains response data for the listRoleBindingNameList operation. |
| AccessListRoleBindingsResponse |
Contains response data for the listRoleBindings operation. |
| AccessListServiceAccountsResponse |
Contains response data for the listServiceAccounts operation. |
| AccessListUsersResponse |
Contains response data for the listUsers operation. |
| CreatedByType |
Defines values for CreatedByType. Known values supported by the serviceUser |
| MarketplaceAgreementsCreateResponse |
Contains response data for the create operation. |
| MarketplaceAgreementsListNextResponse |
Contains response data for the listNext operation. |
| MarketplaceAgreementsListResponse |
Contains response data for the list operation. |
| OrganizationCreateAPIKeyResponse |
Contains response data for the createAPIKey operation. |
| OrganizationCreateResponse |
Contains response data for the create operation. |
| OrganizationGetClusterAPIKeyResponse |
Contains response data for the getClusterAPIKey operation. |
| OrganizationGetClusterByIdResponse |
Contains response data for the getClusterById operation. |
| OrganizationGetEnvironmentByIdResponse |
Contains response data for the getEnvironmentById operation. |
| OrganizationGetResponse |
Contains response data for the get operation. |
| OrganizationGetSchemaRegistryClusterByIdResponse |
Contains response data for the getSchemaRegistryClusterById operation. |
| OrganizationListByResourceGroupNextResponse |
Contains response data for the listByResourceGroupNext operation. |
| OrganizationListByResourceGroupResponse |
Contains response data for the listByResourceGroup operation. |
| OrganizationListBySubscriptionNextResponse |
Contains response data for the listBySubscriptionNext operation. |
| OrganizationListBySubscriptionResponse |
Contains response data for the listBySubscription operation. |
| OrganizationListClustersNextResponse |
Contains response data for the listClustersNext operation. |
| OrganizationListClustersResponse |
Contains response data for the listClusters operation. |
| OrganizationListEnvironmentsNextResponse |
Contains response data for the listEnvironmentsNext operation. |
| OrganizationListEnvironmentsResponse |
Contains response data for the listEnvironments operation. |
| OrganizationListRegionsResponse |
Contains response data for the listRegions operation. |
| OrganizationListSchemaRegistryClustersNextResponse |
Contains response data for the listSchemaRegistryClustersNext operation. |
| OrganizationListSchemaRegistryClustersResponse |
Contains response data for the listSchemaRegistryClusters operation. |
| OrganizationOperationsListNextResponse |
Contains response data for the listNext operation. |
| OrganizationOperationsListResponse |
Contains response data for the list operation. |
| OrganizationUpdateResponse |
Contains response data for the update operation. |
| ProvisionState |
Defines values for ProvisionState. Known values supported by the serviceAccepted |
| SaaSOfferStatus |
Defines values for SaaSOfferStatus. Known values supported by the serviceStarted |
| ValidationsValidateOrganizationResponse |
Contains response data for the validateOrganization operation. |
| ValidationsValidateOrganizationV2Response |
Contains response data for the validateOrganizationV2 operation. |
Enums
| KnownCreatedByType |
Known values of CreatedByType that the service accepts. |
| KnownProvisionState |
Known values of ProvisionState that the service accepts. |
| KnownSaaSOfferStatus |
Known values of SaaSOfferStatus that the service accepts. |
Functions
| get |
Given the last |
Function Details
getContinuationToken(unknown)
Given the last .value produced by the byPage iterator,
returns a continuation token that can be used to begin paging from
that point later.
function getContinuationToken(page: unknown): string | undefinedParameters
- page
-
unknown
An object from accessing value on the IteratorResult from a byPage iterator.
Returns
string | undefined
The continuation token that can be passed into byPage() during future calls.