Microsoft.Confluent (stable:2024-07-01)

2024/12/24 • 43 new methods

MarketplaceAgreements_List (new)
Description :  List Confluent marketplace agreements in the subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Confluent/agreements
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Microsoft Azure subscription id ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of a list operation. ,
Required: False ,
}
[
{
id:
{
Description: The ARM id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the agreement. ,
Required: False ,
}
string ,
type:
{
Description: The type of the agreement. ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Represents the properties of the resource. ,
Required: False ,
}
{
publisher:
{
Description: Publisher identifier string. ,
Required: False ,
}
string ,
product:
{
Description: Product identifier string. ,
Required: False ,
}
string ,
plan:
{
Description: Plan identifier string. ,
Required: False ,
}
string ,
licenseTextLink:
{
Description: Link to HTML with Microsoft and Publisher terms. ,
Required: False ,
}
string ,
privacyPolicyLink:
{
Description: Link to the privacy policy of the publisher. ,
Required: False ,
}
string ,
retrieveDatetime:
{
Description: Date and time in UTC of when the terms were accepted. This is empty if Accepted is false. ,
Format: date-time ,
Required: False ,
}
string ,
signature:
{
Description: Terms signature. ,
Required: False ,
}
string ,
accepted:
{
Description: If any version of the terms have been accepted, otherwise false. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results, if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message ,
Required: False ,
}
string ,
target:
{
Description: Error target ,
Required: False ,
}
string ,
details:
{
Description: Error detail ,
Required: False ,
}
[
string ,
]
,
}
,
}
MarketplaceAgreements_Create (new)
Description :  Create Confluent Marketplace agreement in the subscription.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/providers/Microsoft.Confluent/agreements/default
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Microsoft Azure subscription id ,
Required: True ,
}
string ,
body:
{
Description: Confluent Marketplace Agreement resource ,
Required: False ,
}
{
id:
{
Description: The ARM id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the agreement. ,
Required: False ,
}
string ,
type:
{
Description: The type of the agreement. ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Represents the properties of the resource. ,
Required: False ,
}
{
publisher:
{
Description: Publisher identifier string. ,
Required: False ,
}
string ,
product:
{
Description: Product identifier string. ,
Required: False ,
}
string ,
plan:
{
Description: Plan identifier string. ,
Required: False ,
}
string ,
licenseTextLink:
{
Description: Link to HTML with Microsoft and Publisher terms. ,
Required: False ,
}
string ,
privacyPolicyLink:
{
Description: Link to the privacy policy of the publisher. ,
Required: False ,
}
string ,
retrieveDatetime:
{
Description: Date and time in UTC of when the terms were accepted. This is empty if Accepted is false. ,
Format: date-time ,
Required: False ,
}
string ,
signature:
{
Description: Terms signature. ,
Required: False ,
}
string ,
accepted:
{
Description: If any version of the terms have been accepted, otherwise false. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Description: The ARM id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the agreement. ,
Required: False ,
}
string ,
type:
{
Description: The type of the agreement. ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Represents the properties of the resource. ,
Required: False ,
}
{
publisher:
{
Description: Publisher identifier string. ,
Required: False ,
}
string ,
product:
{
Description: Product identifier string. ,
Required: False ,
}
string ,
plan:
{
Description: Plan identifier string. ,
Required: False ,
}
string ,
licenseTextLink:
{
Description: Link to HTML with Microsoft and Publisher terms. ,
Required: False ,
}
string ,
privacyPolicyLink:
{
Description: Link to the privacy policy of the publisher. ,
Required: False ,
}
string ,
retrieveDatetime:
{
Description: Date and time in UTC of when the terms were accepted. This is empty if Accepted is false. ,
Format: date-time ,
Required: False ,
}
string ,
signature:
{
Description: Terms signature. ,
Required: False ,
}
string ,
accepted:
{
Description: If any version of the terms have been accepted, otherwise false. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message ,
Required: False ,
}
string ,
target:
{
Description: Error target ,
Required: False ,
}
string ,
details:
{
Description: Error detail ,
Required: False ,
}
[
string ,
]
,
}
,
}
OrganizationOperations_List (new)
Description :  List all operations provided by Microsoft.Confluent.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Confluent/operations
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Confluent operations supported by the Microsoft.Confluent provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation} ,
Required: False ,
}
string ,
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
provider:
{
Description: Service provider: Microsoft.Confluent ,
Required: False ,
}
string ,
resource:
{
Description: Type on which the operation is performed, e.g., 'clusters'. ,
Required: False ,
}
string ,
operation:
{
Description: Operation type, e.g., read, write, delete, etc. ,
Required: False ,
}
string ,
description:
{
Description: Description of the operation, e.g., 'Write confluent'. ,
Required: False ,
}
string ,
}
,
isDataAction:
{
Description: Indicates whether the operation is a data action ,
Required: False ,
}
boolean ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message ,
Required: False ,
}
string ,
target:
{
Description: Error target ,
Required: False ,
}
string ,
details:
{
Description: Error detail ,
Required: False ,
}
[
string ,
]
,
}
,
}
Organization_ListBySubscription (new)
Description :  List all organizations under the specified subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Confluent/organizations
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Microsoft Azure subscription id ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Result of a list operation. ,
Required: False ,
}
[
{
id:
{
Description: The ARM id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Organization resource properties ,
Required: True ,
}
{
createdTime:
{
Description: The creation time of the resource. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provision states for confluent RP ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
organizationId:
{
Description: Id of the Confluent organization. ,
Required: False ,
}
string ,
ssoUrl:
{
Description: SSO url for the Confluent organization. ,
Required: False ,
}
string ,
offerDetail:
{
Description: Confluent offer detail ,
Required: True ,
}
{
publisherId:
{
Description: Publisher Id ,
Required: True ,
}
string ,
id:
{
Description: Offer Id ,
Required: True ,
}
string ,
planId:
{
Description: Offer Plan Id ,
Required: True ,
}
string ,
planName:
{
Description: Offer Plan Name ,
Required: True ,
}
string ,
termUnit:
{
Description: Offer Plan Term unit ,
Required: True ,
}
string ,
termId:
{
Description: Offer Plan Term Id ,
Required: False ,
}
string ,
privateOfferId:
{
Description: Private Offer Id ,
Required: False ,
}
string ,
privateOfferIds:
{
Description: Array of Private Offer Ids ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: SaaS Offer Status ,
Enum:
{
Started: No description available. ,
PendingFulfillmentStart: No description available. ,
InProgress: No description available. ,
Subscribed: No description available. ,
Suspended: No description available. ,
Reinstated: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Unsubscribed: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
userDetail:
{
Description: Subscriber detail ,
Required: True ,
}
{
firstName:
{
Description: First name ,
Required: False ,
}
string ,
lastName:
{
Description: Last name ,
Required: False ,
}
string ,
emailAddress:
{
Description: Email address ,
Required: True ,
}
string ,
userPrincipalName:
{
Description: User principal name ,
Required: False ,
}
string ,
aadEmail:
{
Description: AAD email address ,
Required: False ,
}
string ,
}
,
linkOrganization:
{
Description: Link an existing Confluent organization ,
Required: False ,
}
{
token:
{
Description: User auth token ,
Required: True ,
}
string ,
}
,
}
,
tags:
{
Description: Organization resource tags ,
Required: False ,
}
object ,
location:
{
Description: Location of Organization resource ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Link to the next set of results, if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message ,
Required: False ,
}
string ,
target:
{
Description: Error target ,
Required: False ,
}
string ,
details:
{
Description: Error detail ,
Required: False ,
}
[
string ,
]
,
}
,
}
Organization_ListByResourceGroup (new)
Description :  List all Organizations under the specified resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Microsoft Azure subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Result of a list operation. ,
Required: False ,
}
[
{
id:
{
Description: The ARM id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Organization resource properties ,
Required: True ,
}
{
createdTime:
{
Description: The creation time of the resource. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provision states for confluent RP ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
organizationId:
{
Description: Id of the Confluent organization. ,
Required: False ,
}
string ,
ssoUrl:
{
Description: SSO url for the Confluent organization. ,
Required: False ,
}
string ,
offerDetail:
{
Description: Confluent offer detail ,
Required: True ,
}
{
publisherId:
{
Description: Publisher Id ,
Required: True ,
}
string ,
id:
{
Description: Offer Id ,
Required: True ,
}
string ,
planId:
{
Description: Offer Plan Id ,
Required: True ,
}
string ,
planName:
{
Description: Offer Plan Name ,
Required: True ,
}
string ,
termUnit:
{
Description: Offer Plan Term unit ,
Required: True ,
}
string ,
termId:
{
Description: Offer Plan Term Id ,
Required: False ,
}
string ,
privateOfferId:
{
Description: Private Offer Id ,
Required: False ,
}
string ,
privateOfferIds:
{
Description: Array of Private Offer Ids ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: SaaS Offer Status ,
Enum:
{
Started: No description available. ,
PendingFulfillmentStart: No description available. ,
InProgress: No description available. ,
Subscribed: No description available. ,
Suspended: No description available. ,
Reinstated: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Unsubscribed: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
userDetail:
{
Description: Subscriber detail ,
Required: True ,
}
{
firstName:
{
Description: First name ,
Required: False ,
}
string ,
lastName:
{
Description: Last name ,
Required: False ,
}
string ,
emailAddress:
{
Description: Email address ,
Required: True ,
}
string ,
userPrincipalName:
{
Description: User principal name ,
Required: False ,
}
string ,
aadEmail:
{
Description: AAD email address ,
Required: False ,
}
string ,
}
,
linkOrganization:
{
Description: Link an existing Confluent organization ,
Required: False ,
}
{
token:
{
Description: User auth token ,
Required: True ,
}
string ,
}
,
}
,
tags:
{
Description: Organization resource tags ,
Required: False ,
}
object ,
location:
{
Description: Location of Organization resource ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Link to the next set of results, if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message ,
Required: False ,
}
string ,
target:
{
Description: Error target ,
Required: False ,
}
string ,
details:
{
Description: Error detail ,
Required: False ,
}
[
string ,
]
,
}
,
}
Organization_Get (new)
Description :  Get the properties of a specific Organization resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Microsoft Azure subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name ,
Required: True ,
}
string ,
organizationName:
{
Description: Organization resource name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ARM id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Organization resource properties ,
Required: True ,
}
{
createdTime:
{
Description: The creation time of the resource. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provision states for confluent RP ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
organizationId:
{
Description: Id of the Confluent organization. ,
Required: False ,
}
string ,
ssoUrl:
{
Description: SSO url for the Confluent organization. ,
Required: False ,
}
string ,
offerDetail:
{
Description: Confluent offer detail ,
Required: True ,
}
{
publisherId:
{
Description: Publisher Id ,
Required: True ,
}
string ,
id:
{
Description: Offer Id ,
Required: True ,
}
string ,
planId:
{
Description: Offer Plan Id ,
Required: True ,
}
string ,
planName:
{
Description: Offer Plan Name ,
Required: True ,
}
string ,
termUnit:
{
Description: Offer Plan Term unit ,
Required: True ,
}
string ,
termId:
{
Description: Offer Plan Term Id ,
Required: False ,
}
string ,
privateOfferId:
{
Description: Private Offer Id ,
Required: False ,
}
string ,
privateOfferIds:
{
Description: Array of Private Offer Ids ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: SaaS Offer Status ,
Enum:
{
Started: No description available. ,
PendingFulfillmentStart: No description available. ,
InProgress: No description available. ,
Subscribed: No description available. ,
Suspended: No description available. ,
Reinstated: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Unsubscribed: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
userDetail:
{
Description: Subscriber detail ,
Required: True ,
}
{
firstName:
{
Description: First name ,
Required: False ,
}
string ,
lastName:
{
Description: Last name ,
Required: False ,
}
string ,
emailAddress:
{
Description: Email address ,
Required: True ,
}
string ,
userPrincipalName:
{
Description: User principal name ,
Required: False ,
}
string ,
aadEmail:
{
Description: AAD email address ,
Required: False ,
}
string ,
}
,
linkOrganization:
{
Description: Link an existing Confluent organization ,
Required: False ,
}
{
token:
{
Description: User auth token ,
Required: True ,
}
string ,
}
,
}
,
tags:
{
Description: Organization resource tags ,
Required: False ,
}
object ,
location:
{
Description: Location of Organization resource ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message ,
Required: False ,
}
string ,
target:
{
Description: Error target ,
Required: False ,
}
string ,
details:
{
Description: Error detail ,
Required: False ,
}
[
string ,
]
,
}
,
}
Organization_Create (new)
Description :  Create Organization resource
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Microsoft Azure subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name ,
Required: True ,
}
string ,
organizationName:
{
Description: Organization resource name ,
Required: True ,
}
string ,
body:
{
Description: Organization resource model ,
Required: False ,
}
{
id:
{
Description: The ARM id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Organization resource properties ,
Required: True ,
}
{
createdTime:
{
Description: The creation time of the resource. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provision states for confluent RP ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
organizationId:
{
Description: Id of the Confluent organization. ,
Required: False ,
}
string ,
ssoUrl:
{
Description: SSO url for the Confluent organization. ,
Required: False ,
}
string ,
offerDetail:
{
Description: Confluent offer detail ,
Required: True ,
}
{
publisherId:
{
Description: Publisher Id ,
Required: True ,
}
string ,
id:
{
Description: Offer Id ,
Required: True ,
}
string ,
planId:
{
Description: Offer Plan Id ,
Required: True ,
}
string ,
planName:
{
Description: Offer Plan Name ,
Required: True ,
}
string ,
termUnit:
{
Description: Offer Plan Term unit ,
Required: True ,
}
string ,
termId:
{
Description: Offer Plan Term Id ,
Required: False ,
}
string ,
privateOfferId:
{
Description: Private Offer Id ,
Required: False ,
}
string ,
privateOfferIds:
{
Description: Array of Private Offer Ids ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: SaaS Offer Status ,
Enum:
{
Started: No description available. ,
PendingFulfillmentStart: No description available. ,
InProgress: No description available. ,
Subscribed: No description available. ,
Suspended: No description available. ,
Reinstated: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Unsubscribed: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
userDetail:
{
Description: Subscriber detail ,
Required: True ,
}
{
firstName:
{
Description: First name ,
Required: False ,
}
string ,
lastName:
{
Description: Last name ,
Required: False ,
}
string ,
emailAddress:
{
Description: Email address ,
Required: True ,
}
string ,
userPrincipalName:
{
Description: User principal name ,
Required: False ,
}
string ,
aadEmail:
{
Description: AAD email address ,
Required: False ,
}
string ,
}
,
linkOrganization:
{
Description: Link an existing Confluent organization ,
Required: False ,
}
{
token:
{
Description: User auth token ,
Required: True ,
}
string ,
}
,
}
,
tags:
{
Description: Organization resource tags ,
Required: False ,
}
object ,
location:
{
Description: Location of Organization resource ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
id:
{
Description: The ARM id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Organization resource properties ,
Required: True ,
}
{
createdTime:
{
Description: The creation time of the resource. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provision states for confluent RP ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
organizationId:
{
Description: Id of the Confluent organization. ,
Required: False ,
}
string ,
ssoUrl:
{
Description: SSO url for the Confluent organization. ,
Required: False ,
}
string ,
offerDetail:
{
Description: Confluent offer detail ,
Required: True ,
}
{
publisherId:
{
Description: Publisher Id ,
Required: True ,
}
string ,
id:
{
Description: Offer Id ,
Required: True ,
}
string ,
planId:
{
Description: Offer Plan Id ,
Required: True ,
}
string ,
planName:
{
Description: Offer Plan Name ,
Required: True ,
}
string ,
termUnit:
{
Description: Offer Plan Term unit ,
Required: True ,
}
string ,
termId:
{
Description: Offer Plan Term Id ,
Required: False ,
}
string ,
privateOfferId:
{
Description: Private Offer Id ,
Required: False ,
}
string ,
privateOfferIds:
{
Description: Array of Private Offer Ids ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: SaaS Offer Status ,
Enum:
{
Started: No description available. ,
PendingFulfillmentStart: No description available. ,
InProgress: No description available. ,
Subscribed: No description available. ,
Suspended: No description available. ,
Reinstated: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Unsubscribed: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
userDetail:
{
Description: Subscriber detail ,
Required: True ,
}
{
firstName:
{
Description: First name ,
Required: False ,
}
string ,
lastName:
{
Description: Last name ,
Required: False ,
}
string ,
emailAddress:
{
Description: Email address ,
Required: True ,
}
string ,
userPrincipalName:
{
Description: User principal name ,
Required: False ,
}
string ,
aadEmail:
{
Description: AAD email address ,
Required: False ,
}
string ,
}
,
linkOrganization:
{
Description: Link an existing Confluent organization ,
Required: False ,
}
{
token:
{
Description: User auth token ,
Required: True ,
}
string ,
}
,
}
,
tags:
{
Description: Organization resource tags ,
Required: False ,
}
object ,
location:
{
Description: Location of Organization resource ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
id:
{
Description: The ARM id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Organization resource properties ,
Required: True ,
}
{
createdTime:
{
Description: The creation time of the resource. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provision states for confluent RP ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
organizationId:
{
Description: Id of the Confluent organization. ,
Required: False ,
}
string ,
ssoUrl:
{
Description: SSO url for the Confluent organization. ,
Required: False ,
}
string ,
offerDetail:
{
Description: Confluent offer detail ,
Required: True ,
}
{
publisherId:
{
Description: Publisher Id ,
Required: True ,
}
string ,
id:
{
Description: Offer Id ,
Required: True ,
}
string ,
planId:
{
Description: Offer Plan Id ,
Required: True ,
}
string ,
planName:
{
Description: Offer Plan Name ,
Required: True ,
}
string ,
termUnit:
{
Description: Offer Plan Term unit ,
Required: True ,
}
string ,
termId:
{
Description: Offer Plan Term Id ,
Required: False ,
}
string ,
privateOfferId:
{
Description: Private Offer Id ,
Required: False ,
}
string ,
privateOfferIds:
{
Description: Array of Private Offer Ids ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: SaaS Offer Status ,
Enum:
{
Started: No description available. ,
PendingFulfillmentStart: No description available. ,
InProgress: No description available. ,
Subscribed: No description available. ,
Suspended: No description available. ,
Reinstated: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Unsubscribed: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
userDetail:
{
Description: Subscriber detail ,
Required: True ,
}
{
firstName:
{
Description: First name ,
Required: False ,
}
string ,
lastName:
{
Description: Last name ,
Required: False ,
}
string ,
emailAddress:
{
Description: Email address ,
Required: True ,
}
string ,
userPrincipalName:
{
Description: User principal name ,
Required: False ,
}
string ,
aadEmail:
{
Description: AAD email address ,
Required: False ,
}
string ,
}
,
linkOrganization:
{
Description: Link an existing Confluent organization ,
Required: False ,
}
{
token:
{
Description: User auth token ,
Required: True ,
}
string ,
}
,
}
,
tags:
{
Description: Organization resource tags ,
Required: False ,
}
object ,
location:
{
Description: Location of Organization resource ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message ,
Required: False ,
}
string ,
target:
{
Description: Error target ,
Required: False ,
}
string ,
details:
{
Description: Error detail ,
Required: False ,
}
[
string ,
]
,
}
,
}
Organization_Update (new)
Description :  Update Organization resource
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Microsoft Azure subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name ,
Required: True ,
}
string ,
organizationName:
{
Description: Organization resource name ,
Required: True ,
}
string ,
body:
{
Description: Updated Organization resource ,
Required: False ,
}
{
tags:
{
Description: ARM resource tags ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
id:
{
Description: The ARM id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Organization resource properties ,
Required: True ,
}
{
createdTime:
{
Description: The creation time of the resource. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provision states for confluent RP ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
organizationId:
{
Description: Id of the Confluent organization. ,
Required: False ,
}
string ,
ssoUrl:
{
Description: SSO url for the Confluent organization. ,
Required: False ,
}
string ,
offerDetail:
{
Description: Confluent offer detail ,
Required: True ,
}
{
publisherId:
{
Description: Publisher Id ,
Required: True ,
}
string ,
id:
{
Description: Offer Id ,
Required: True ,
}
string ,
planId:
{
Description: Offer Plan Id ,
Required: True ,
}
string ,
planName:
{
Description: Offer Plan Name ,
Required: True ,
}
string ,
termUnit:
{
Description: Offer Plan Term unit ,
Required: True ,
}
string ,
termId:
{
Description: Offer Plan Term Id ,
Required: False ,
}
string ,
privateOfferId:
{
Description: Private Offer Id ,
Required: False ,
}
string ,
privateOfferIds:
{
Description: Array of Private Offer Ids ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: SaaS Offer Status ,
Enum:
{
Started: No description available. ,
PendingFulfillmentStart: No description available. ,
InProgress: No description available. ,
Subscribed: No description available. ,
Suspended: No description available. ,
Reinstated: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Unsubscribed: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
userDetail:
{
Description: Subscriber detail ,
Required: True ,
}
{
firstName:
{
Description: First name ,
Required: False ,
}
string ,
lastName:
{
Description: Last name ,
Required: False ,
}
string ,
emailAddress:
{
Description: Email address ,
Required: True ,
}
string ,
userPrincipalName:
{
Description: User principal name ,
Required: False ,
}
string ,
aadEmail:
{
Description: AAD email address ,
Required: False ,
}
string ,
}
,
linkOrganization:
{
Description: Link an existing Confluent organization ,
Required: False ,
}
{
token:
{
Description: User auth token ,
Required: True ,
}
string ,
}
,
}
,
tags:
{
Description: Organization resource tags ,
Required: False ,
}
object ,
location:
{
Description: Location of Organization resource ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message ,
Required: False ,
}
string ,
target:
{
Description: Error target ,
Required: False ,
}
string ,
details:
{
Description: Error detail ,
Required: False ,
}
[
string ,
]
,
}
,
}
Organization_Delete (new)
Description :  Delete Organization resource
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Microsoft Azure subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name ,
Required: True ,
}
string ,
organizationName:
{
Description: Organization resource name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message ,
Required: False ,
}
string ,
target:
{
Description: Error target ,
Required: False ,
}
string ,
details:
{
Description: Error detail ,
Required: False ,
}
[
string ,
]
,
}
,
}
Validations_ValidateOrganization (new)
Description :  Organization Validate proxy resource
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/validations/{organizationName}/orgvalidate
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Microsoft Azure subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name ,
Required: True ,
}
string ,
organizationName:
{
Description: Organization resource name ,
Required: True ,
}
string ,
body:
{
Description: Organization resource model ,
Required: True ,
}
{
id:
{
Description: The ARM id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Organization resource properties ,
Required: True ,
}
{
createdTime:
{
Description: The creation time of the resource. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provision states for confluent RP ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
organizationId:
{
Description: Id of the Confluent organization. ,
Required: False ,
}
string ,
ssoUrl:
{
Description: SSO url for the Confluent organization. ,
Required: False ,
}
string ,
offerDetail:
{
Description: Confluent offer detail ,
Required: True ,
}
{
publisherId:
{
Description: Publisher Id ,
Required: True ,
}
string ,
id:
{
Description: Offer Id ,
Required: True ,
}
string ,
planId:
{
Description: Offer Plan Id ,
Required: True ,
}
string ,
planName:
{
Description: Offer Plan Name ,
Required: True ,
}
string ,
termUnit:
{
Description: Offer Plan Term unit ,
Required: True ,
}
string ,
termId:
{
Description: Offer Plan Term Id ,
Required: False ,
}
string ,
privateOfferId:
{
Description: Private Offer Id ,
Required: False ,
}
string ,
privateOfferIds:
{
Description: Array of Private Offer Ids ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: SaaS Offer Status ,
Enum:
{
Started: No description available. ,
PendingFulfillmentStart: No description available. ,
InProgress: No description available. ,
Subscribed: No description available. ,
Suspended: No description available. ,
Reinstated: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Unsubscribed: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
userDetail:
{
Description: Subscriber detail ,
Required: True ,
}
{
firstName:
{
Description: First name ,
Required: False ,
}
string ,
lastName:
{
Description: Last name ,
Required: False ,
}
string ,
emailAddress:
{
Description: Email address ,
Required: True ,
}
string ,
userPrincipalName:
{
Description: User principal name ,
Required: False ,
}
string ,
aadEmail:
{
Description: AAD email address ,
Required: False ,
}
string ,
}
,
linkOrganization:
{
Description: Link an existing Confluent organization ,
Required: False ,
}
{
token:
{
Description: User auth token ,
Required: True ,
}
string ,
}
,
}
,
tags:
{
Description: Organization resource tags ,
Required: False ,
}
object ,
location:
{
Description: Location of Organization resource ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
id:
{
Description: The ARM id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Organization resource properties ,
Required: True ,
}
{
createdTime:
{
Description: The creation time of the resource. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provision states for confluent RP ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
organizationId:
{
Description: Id of the Confluent organization. ,
Required: False ,
}
string ,
ssoUrl:
{
Description: SSO url for the Confluent organization. ,
Required: False ,
}
string ,
offerDetail:
{
Description: Confluent offer detail ,
Required: True ,
}
{
publisherId:
{
Description: Publisher Id ,
Required: True ,
}
string ,
id:
{
Description: Offer Id ,
Required: True ,
}
string ,
planId:
{
Description: Offer Plan Id ,
Required: True ,
}
string ,
planName:
{
Description: Offer Plan Name ,
Required: True ,
}
string ,
termUnit:
{
Description: Offer Plan Term unit ,
Required: True ,
}
string ,
termId:
{
Description: Offer Plan Term Id ,
Required: False ,
}
string ,
privateOfferId:
{
Description: Private Offer Id ,
Required: False ,
}
string ,
privateOfferIds:
{
Description: Array of Private Offer Ids ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: SaaS Offer Status ,
Enum:
{
Started: No description available. ,
PendingFulfillmentStart: No description available. ,
InProgress: No description available. ,
Subscribed: No description available. ,
Suspended: No description available. ,
Reinstated: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Unsubscribed: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
userDetail:
{
Description: Subscriber detail ,
Required: True ,
}
{
firstName:
{
Description: First name ,
Required: False ,
}
string ,
lastName:
{
Description: Last name ,
Required: False ,
}
string ,
emailAddress:
{
Description: Email address ,
Required: True ,
}
string ,
userPrincipalName:
{
Description: User principal name ,
Required: False ,
}
string ,
aadEmail:
{
Description: AAD email address ,
Required: False ,
}
string ,
}
,
linkOrganization:
{
Description: Link an existing Confluent organization ,
Required: False ,
}
{
token:
{
Description: User auth token ,
Required: True ,
}
string ,
}
,
}
,
tags:
{
Description: Organization resource tags ,
Required: False ,
}
object ,
location:
{
Description: Location of Organization resource ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message ,
Required: False ,
}
string ,
target:
{
Description: Error target ,
Required: False ,
}
string ,
details:
{
Description: Error detail ,
Required: False ,
}
[
string ,
]
,
}
,
}
Validations_ValidateOrganizationV2 (new)
Description :  Organization Validate proxy resource
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/validations/{organizationName}/orgvalidateV2
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Microsoft Azure subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name ,
Required: True ,
}
string ,
organizationName:
{
Description: Organization resource name ,
Required: True ,
}
string ,
body:
{
Description: Organization resource model ,
Required: True ,
}
{
id:
{
Description: The ARM id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Organization resource properties ,
Required: True ,
}
{
createdTime:
{
Description: The creation time of the resource. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provision states for confluent RP ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
organizationId:
{
Description: Id of the Confluent organization. ,
Required: False ,
}
string ,
ssoUrl:
{
Description: SSO url for the Confluent organization. ,
Required: False ,
}
string ,
offerDetail:
{
Description: Confluent offer detail ,
Required: True ,
}
{
publisherId:
{
Description: Publisher Id ,
Required: True ,
}
string ,
id:
{
Description: Offer Id ,
Required: True ,
}
string ,
planId:
{
Description: Offer Plan Id ,
Required: True ,
}
string ,
planName:
{
Description: Offer Plan Name ,
Required: True ,
}
string ,
termUnit:
{
Description: Offer Plan Term unit ,
Required: True ,
}
string ,
termId:
{
Description: Offer Plan Term Id ,
Required: False ,
}
string ,
privateOfferId:
{
Description: Private Offer Id ,
Required: False ,
}
string ,
privateOfferIds:
{
Description: Array of Private Offer Ids ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: SaaS Offer Status ,
Enum:
{
Started: No description available. ,
PendingFulfillmentStart: No description available. ,
InProgress: No description available. ,
Subscribed: No description available. ,
Suspended: No description available. ,
Reinstated: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Unsubscribed: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
userDetail:
{
Description: Subscriber detail ,
Required: True ,
}
{
firstName:
{
Description: First name ,
Required: False ,
}
string ,
lastName:
{
Description: Last name ,
Required: False ,
}
string ,
emailAddress:
{
Description: Email address ,
Required: True ,
}
string ,
userPrincipalName:
{
Description: User principal name ,
Required: False ,
}
string ,
aadEmail:
{
Description: AAD email address ,
Required: False ,
}
string ,
}
,
linkOrganization:
{
Description: Link an existing Confluent organization ,
Required: False ,
}
{
token:
{
Description: User auth token ,
Required: True ,
}
string ,
}
,
}
,
tags:
{
Description: Organization resource tags ,
Required: False ,
}
object ,
location:
{
Description: Location of Organization resource ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
info:
{
Description: Info from the response ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message ,
Required: False ,
}
string ,
target:
{
Description: Error target ,
Required: False ,
}
string ,
details:
{
Description: Error detail ,
Required: False ,
}
[
string ,
]
,
}
,
}
Access_ListUsers (new)
Description :  Organization users details
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/access/default/listUsers
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Microsoft Azure subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name ,
Required: True ,
}
string ,
organizationName:
{
Description: Organization resource name ,
Required: True ,
}
string ,
body:
{
Description: List Access Request Model ,
Required: True ,
}
{
searchFilters:
{
Description: Search filters for the request ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
kind:
{
Description: Type of response ,
Required: False ,
}
string ,
metadata:
{
Description: Metadata of the list ,
Required: False ,
}
{
first:
{
Description: First page of the list ,
Required: False ,
}
string ,
last:
{
Description: Last page of the list ,
Required: False ,
}
string ,
prev:
{
Description: Previous page of the list ,
Required: False ,
}
string ,
next:
{
Description: Next page of the list ,
Required: False ,
}
string ,
total_size:
{
Description: Total size of the list ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
data:
{
Description: Data of the users list ,
Required: False ,
}
[
{
kind:
{
Description: Type of account ,
Required: False ,
}
string ,
id:
{
Description: Id of the user ,
Required: False ,
}
string ,
metadata:
{
Description: Metadata of the record ,
Required: False ,
}
{
self:
{
Description: Self lookup url ,
Required: False ,
}
string ,
resource_name:
{
Description: Resource name of the record ,
Required: False ,
}
string ,
created_at:
{
Description: Created Date Time ,
Required: False ,
}
string ,
updated_at:
{
Description: Updated Date time ,
Required: False ,
}
string ,
deleted_at:
{
Description: Deleted Date time ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email of the user ,
Required: False ,
}
string ,
full_name:
{
Description: Name of the user ,
Required: False ,
}
string ,
auth_type:
{
Description: Auth type of the user ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message ,
Required: False ,
}
string ,
target:
{
Description: Error target ,
Required: False ,
}
string ,
details:
{
Description: Error detail ,
Required: False ,
}
[
string ,
]
,
}
,
}
Access_ListServiceAccounts (new)
Description :  Organization service accounts details
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/access/default/listServiceAccounts
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Microsoft Azure subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name ,
Required: True ,
}
string ,
organizationName:
{
Description: Organization resource name ,
Required: True ,
}
string ,
body:
{
Description: List Access Request Model ,
Required: True ,
}
{
searchFilters:
{
Description: Search filters for the request ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
kind:
{
Description: Type of response ,
Required: False ,
}
string ,
metadata:
{
Description: Metadata of the list ,
Required: False ,
}
{
first:
{
Description: First page of the list ,
Required: False ,
}
string ,
last:
{
Description: Last page of the list ,
Required: False ,
}
string ,
prev:
{
Description: Previous page of the list ,
Required: False ,
}
string ,
next:
{
Description: Next page of the list ,
Required: False ,
}
string ,
total_size:
{
Description: Total size of the list ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
data:
{
Description: Data of the service accounts list ,
Required: False ,
}
[
{
kind:
{
Description: Type of account ,
Required: False ,
}
string ,
id:
{
Description: Id of the service account ,
Required: False ,
}
string ,
metadata:
{
Description: Metadata of the record ,
Required: False ,
}
{
self:
{
Description: Self lookup url ,
Required: False ,
}
string ,
resource_name:
{
Description: Resource name of the record ,
Required: False ,
}
string ,
created_at:
{
Description: Created Date Time ,
Required: False ,
}
string ,
updated_at:
{
Description: Updated Date time ,
Required: False ,
}
string ,
deleted_at:
{
Description: Deleted Date time ,
Required: False ,
}
string ,
}
,
display_name:
{
Description: Name of the service account ,
Required: False ,
}
string ,
description:
{
Description: Description of the service account ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message ,
Required: False ,
}
string ,
target:
{
Description: Error target ,
Required: False ,
}
string ,
details:
{
Description: Error detail ,
Required: False ,
}
[
string ,
]
,
}
,
}
Access_ListInvitations (new)
Description :  Organization accounts invitation details
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/access/default/listInvitations
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Microsoft Azure subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name ,
Required: True ,
}
string ,
organizationName:
{
Description: Organization resource name ,
Required: True ,
}
string ,
body:
{
Description: List Access Request Model ,
Required: True ,
}
{
searchFilters:
{
Description: Search filters for the request ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
kind:
{
Description: Type of response ,
Required: False ,
}
string ,
metadata:
{
Description: Metadata of the list ,
Required: False ,
}
{
first:
{
Description: First page of the list ,
Required: False ,
}
string ,
last:
{
Description: Last page of the list ,
Required: False ,
}
string ,
prev:
{
Description: Previous page of the list ,
Required: False ,
}
string ,
next:
{
Description: Next page of the list ,
Required: False ,
}
string ,
total_size:
{
Description: Total size of the list ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
data:
{
Description: Data of the invitations list ,
Required: False ,
}
[
{
kind:
{
Description: Type of account ,
Required: False ,
}
string ,
id:
{
Description: Id of the invitation ,
Required: False ,
}
string ,
metadata:
{
Description: Metadata of the record ,
Required: False ,
}
{
self:
{
Description: Self lookup url ,
Required: False ,
}
string ,
resource_name:
{
Description: Resource name of the record ,
Required: False ,
}
string ,
created_at:
{
Description: Created Date Time ,
Required: False ,
}
string ,
updated_at:
{
Description: Updated Date time ,
Required: False ,
}
string ,
deleted_at:
{
Description: Deleted Date time ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email of the user ,
Required: False ,
}
string ,
auth_type:
{
Description: Auth type of the user ,
Required: False ,
}
string ,
status:
{
Description: Status of the invitation ,
Required: False ,
}
string ,
accepted_at:
{
Description: Accepted date time of the invitation ,
Required: False ,
}
string ,
expires_at:
{
Description: Expiration date time of the invitation ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message ,
Required: False ,
}
string ,
target:
{
Description: Error target ,
Required: False ,
}
string ,
details:
{
Description: Error detail ,
Required: False ,
}
[
string ,
]
,
}
,
}
Access_InviteUser (new)
Description :  Invite user to the organization
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/access/default/createInvitation
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Microsoft Azure subscription id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name ,
Required: True ,
}
string ,
organizationName:
{
Description: Organization resource name ,
Required: True ,
}
string ,
body:
{
Description: Invite user account model ,
Required: True ,
}
{
organizationId:
{
Description: Id of the organization ,
Required: False ,
}
string ,
email:
{
Description: Email of the logged in user ,
Required: False ,
}
string ,
upn:
{
Description: Upn of the logged in user ,
Required: False ,
}
string ,
invitedUserDetails:
{
Description: Details of the user who is being invited ,
Required: False ,
}
{
invitedEmail:
{
Description: UPN/Email of the user who is being invited ,
Required: False ,
}
string ,
auth_type:
{
Description: Auth type of the user ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
kind:
{
Description: Type of account ,
Required: False ,
}
string ,
id:
{
Description: Id of the invitation ,
Required: False ,
}
string ,
metadata:
{
Description: Metadata of the record ,
Required: False ,
}
{
self:
{
Description: Self lookup url ,
Required: False ,
}
string ,
resource_name:
{
Description: Resource name of the record ,
Required: False ,
}
string ,
created_at:
{
Description: Created Date Time ,
Required: False ,
}
string ,
updated_at:
{
Description: Updated Date time ,
Required: False ,
}
string ,
deleted_at:
{
Description: Deleted Date time ,
Required: False ,
}
string ,
}
,
email:
{
Description: Email of the user ,
Required: False ,
}
string ,
auth_type:
{
Description: Auth type of the user ,
Required: False ,
}
string ,
status:
{
Description: Status of the invitation ,
Required: False ,
}
string ,
accepted_at:
{
Description: Accepted date time of the invitation ,
Required: False ,
}
string ,
expires_at:
{
Description: Expiration date time of the invitation ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message ,
Required: False ,
}
string ,
target:
{
Description: Error target ,
Required: False ,
}
string ,
details:
{
Description: Error detail ,
Required: False ,
}
[
string ,
]
,
}
,
}
Access_ListEnvironments (new)
Description :  Environment list of an organization
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/access/default/listEnvironments
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
organizationName:
{
Description: Organization resource name ,
Required: True ,
}
string ,
body:
{
Description: List Access Request Model ,
Required: True ,
}
{
searchFilters:
{
Description: Search filters for the request ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
kind:
{
Description: Type of response ,
Required: False ,
}
string ,
metadata:
{
Description: Metadata of the environment list ,
Required: False ,
}
{
first:
{
Description: First page of the list ,
Required: False ,
}
string ,
last:
{
Description: Last page of the list ,
Required: False ,
}
string ,
prev:
{
Description: Previous page of the list ,
Required: False ,
}
string ,
next:
{
Description: Next page of the list ,
Required: False ,
}
string ,
total_size:
{
Description: Total size of the list ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
data:
{
Description: Environment list data ,
Required: False ,
}
[
{
kind:
{
Description: Type of environment ,
Required: False ,
}
string ,
id:
{
Description: Id of the environment ,
Required: False ,
}
string ,
metadata:
{
Description: Metadata of the record ,
Required: False ,
}
{
self:
{
Description: Self lookup url ,
Required: False ,
}
string ,
resource_name:
{
Description: Resource name of the record ,
Required: False ,
}
string ,
created_at:
{
Description: Created Date Time ,
Required: False ,
}
string ,
updated_at:
{
Description: Updated Date time ,
Required: False ,
}
string ,
deleted_at:
{
Description: Deleted Date time ,
Required: False ,
}
string ,
}
,
display_name:
{
Description: Display name of the user ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message ,
Required: False ,
}
string ,
target:
{
Description: Error target ,
Required: False ,
}
string ,
details:
{
Description: Error detail ,
Required: False ,
}
[
string ,
]
,
}
,
}
Access_ListClusters (new)
Description :  Cluster details
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/access/default/listClusters
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
organizationName:
{
Description: Organization resource name ,
Required: True ,
}
string ,
body:
{
Description: List Access Request Model ,
Required: True ,
}
{
searchFilters:
{
Description: Search filters for the request ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
kind:
{
Description: Type of response ,
Required: False ,
}
string ,
metadata:
{
Description: Metadata of the list ,
Required: False ,
}
{
first:
{
Description: First page of the list ,
Required: False ,
}
string ,
last:
{
Description: Last page of the list ,
Required: False ,
}
string ,
prev:
{
Description: Previous page of the list ,
Required: False ,
}
string ,
next:
{
Description: Next page of the list ,
Required: False ,
}
string ,
total_size:
{
Description: Total size of the list ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
data:
{
Description: List of clusters ,
Required: False ,
}
[
{
kind:
{
Description: Type of cluster ,
Required: False ,
}
string ,
id:
{
Description: Id of the cluster ,
Required: False ,
}
string ,
metadata:
{
Description: Metadata of the record ,
Required: False ,
}
{
self:
{
Description: Self lookup url ,
Required: False ,
}
string ,
resource_name:
{
Description: Resource name of the record ,
Required: False ,
}
string ,
created_at:
{
Description: Created Date Time ,
Required: False ,
}
string ,
updated_at:
{
Description: Updated Date time ,
Required: False ,
}
string ,
deleted_at:
{
Description: Deleted Date time ,
Required: False ,
}
string ,
}
,
display_name:
{
Description: Display name of the cluster ,
Required: False ,
}
string ,
spec:
{
Description: Specification of the cluster ,
Required: False ,
}
{
display_name:
{
Description: The name of the cluster ,
Required: False ,
}
string ,
availability:
{
Description: The availability zone configuration of the cluster ,
Required: False ,
}
string ,
cloud:
{
Description: The cloud service provider ,
Required: False ,
}
string ,
zone:
{
Description: type of zone availability ,
Required: False ,
}
string ,
region:
{
Description: The cloud service provider region ,
Required: False ,
}
string ,
kafka_bootstrap_endpoint:
{
Description: The bootstrap endpoint used by Kafka clients to connect to the cluster ,
Required: False ,
}
string ,
http_endpoint:
{
Description: The cluster HTTP request URL. ,
Required: False ,
}
string ,
api_endpoint:
{
Description: The Kafka API cluster endpoint ,
Required: False ,
}
string ,
config:
{
Description: Specification of the cluster ,
Required: False ,
}
{
kind:
{
Description: The lifecycle phase of the cluster ,
Required: False ,
}
string ,
}
,
environment:
{
Description: Specification of the cluster ,
Required: False ,
}
{
id:
{
Description: ID of the referred resource ,
Required: False ,
}
string ,
environment:
{
Description: Environment of the referred resource ,
Required: False ,
}
string ,
related:
{
Description: API URL for accessing or modifying the referred object ,
Required: False ,
}
string ,
resource_name:
{
Description: CRN reference to the referred resource ,
Required: False ,
}
string ,
}
,
network:
{
Description: Specification of the cluster ,
Required: False ,
}
{
id:
{
Description: ID of the referred resource ,
Required: False ,
}
string ,
environment:
{
Description: Environment of the referred resource ,
Required: False ,
}
string ,
related:
{
Description: API URL for accessing or modifying the referred object ,
Required: False ,
}
string ,
resource_name:
{
Description: CRN reference to the referred resource ,
Required: False ,
}
string ,
}
,
byok:
{
Description: Specification of the cluster ,
Required: False ,
}
{
id:
{
Description: ID of the referred resource ,
Required: False ,
}
string ,
related:
{
Description: API URL for accessing or modifying the referred object ,
Required: False ,
}
string ,
resource_name:
{
Description: CRN reference to the referred resource ,
Required: False ,
}
string ,
}
,
}
,
status:
{
Description: Specification of the cluster ,
Required: False ,
}
{
phase:
{
Description: The lifecycle phase of the cluster ,
Required: False ,
}
string ,
cku:
{
Description: The number of Confluent Kafka Units ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message ,
Required: False ,
}
string ,
target:
{
Description: Error target ,
Required: False ,
}
string ,
details:
{
Description: Error detail ,
Required: False ,
}
[
string ,
]
,
}
,
}
Access_ListRoleBindings (new)
Description :  Organization role bindings
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/access/default/listRoleBindings
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
organizationName:
{
Description: Organization resource name ,
Required: True ,
}
string ,
body:
{
Description: List Access Request Model ,
Required: True ,
}
{
searchFilters:
{
Description: Search filters for the request ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
kind:
{
Description: Type of response ,
Required: False ,
}
string ,
metadata:
{
Description: Metadata of the list ,
Required: False ,
}
{
first:
{
Description: First page of the list ,
Required: False ,
}
string ,
last:
{
Description: Last page of the list ,
Required: False ,
}
string ,
prev:
{
Description: Previous page of the list ,
Required: False ,
}
string ,
next:
{
Description: Next page of the list ,
Required: False ,
}
string ,
total_size:
{
Description: Total size of the list ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
data:
{
Description: List of role binding ,
Required: False ,
}
[
{
kind:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
id:
{
Description: Id of the role binding ,
Required: False ,
}
string ,
metadata:
{
Description: Metadata of the record ,
Required: False ,
}
{
self:
{
Description: Self lookup url ,
Required: False ,
}
string ,
resource_name:
{
Description: Resource name of the record ,
Required: False ,
}
string ,
created_at:
{
Description: Created Date Time ,
Required: False ,
}
string ,
updated_at:
{
Description: Updated Date time ,
Required: False ,
}
string ,
deleted_at:
{
Description: Deleted Date time ,
Required: False ,
}
string ,
}
,
principal:
{
Description: The principal User or Group to bind the role to ,
Required: False ,
}
string ,
role_name:
{
Description: The name of the role to bind to the principal ,
Required: False ,
}
string ,
crn_pattern:
{
Description: A CRN that specifies the scope and resource patterns necessary for the role to bind ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message ,
Required: False ,
}
string ,
target:
{
Description: Error target ,
Required: False ,
}
string ,
details:
{
Description: Error detail ,
Required: False ,
}
[
string ,
]
,
}
,
}
Access_CreateRoleBinding (new)
Description :  Organization role bindings
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/access/default/createRoleBinding
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
organizationName:
{
Description: Organization resource name ,
Required: True ,
}
string ,
body:
{
Description: Create role binding Request Model ,
Required: True ,
}
{
principal:
{
Description: The principal User or Group to bind the role to ,
Required: False ,
}
string ,
role_name:
{
Description: The name of the role to bind to the principal ,
Required: False ,
}
string ,
crn_pattern:
{
Description: A CRN that specifies the scope and resource patterns necessary for the role to bind ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
kind:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
id:
{
Description: Id of the role binding ,
Required: False ,
}
string ,
metadata:
{
Description: Metadata of the record ,
Required: False ,
}
{
self:
{
Description: Self lookup url ,
Required: False ,
}
string ,
resource_name:
{
Description: Resource name of the record ,
Required: False ,
}
string ,
created_at:
{
Description: Created Date Time ,
Required: False ,
}
string ,
updated_at:
{
Description: Updated Date time ,
Required: False ,
}
string ,
deleted_at:
{
Description: Deleted Date time ,
Required: False ,
}
string ,
}
,
principal:
{
Description: The principal User or Group to bind the role to ,
Required: False ,
}
string ,
role_name:
{
Description: The name of the role to bind to the principal ,
Required: False ,
}
string ,
crn_pattern:
{
Description: A CRN that specifies the scope and resource patterns necessary for the role to bind ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message ,
Required: False ,
}
string ,
target:
{
Description: Error target ,
Required: False ,
}
string ,
details:
{
Description: Error detail ,
Required: False ,
}
[
string ,
]
,
}
,
}
Access_DeleteRoleBinding (new)
Description :  Organization role bindings
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/access/default/deleteRoleBinding/{roleBindingId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
organizationName:
{
Description: Organization resource name ,
Required: True ,
}
string ,
roleBindingId:
{
Description: Confluent Role binding id ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message ,
Required: False ,
}
string ,
target:
{
Description: Error target ,
Required: False ,
}
string ,
details:
{
Description: Error detail ,
Required: False ,
}
[
string ,
]
,
}
,
}
Access_ListRoleBindingNameList (new)
Description :  Organization role bindings
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/access/default/listRoleBindingNameList
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
organizationName:
{
Description: Organization resource name ,
Required: True ,
}
string ,
body:
{
Description: List Access Request Model ,
Required: True ,
}
{
searchFilters:
{
Description: Search filters for the request ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
kind:
{
Description: Type of response ,
Required: False ,
}
string ,
metadata:
{
Description: Metadata of the list ,
Required: False ,
}
{
first:
{
Description: First page of the list ,
Required: False ,
}
string ,
last:
{
Description: Last page of the list ,
Required: False ,
}
string ,
prev:
{
Description: Previous page of the list ,
Required: False ,
}
string ,
next:
{
Description: Next page of the list ,
Required: False ,
}
string ,
total_size:
{
Description: Total size of the list ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
data:
{
Description: List of role binding names ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message ,
Required: False ,
}
string ,
target:
{
Description: Error target ,
Required: False ,
}
string ,
details:
{
Description: Error detail ,
Required: False ,
}
[
string ,
]
,
}
,
}
Organization_ListEnvironments (new)
Description :  Lists of all the environments in a organization
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/environments
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
organizationName:
{
Description: Organization resource name ,
Required: True ,
}
string ,
pageSize:
{
Description: Pagination size ,
Format: int32 ,
Required: False ,
}
integer ,
pageToken:
{
Description: An opaque pagination token to fetch the next set of records ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of environments in a confluent organization ,
Required: False ,
}
[
{
kind:
{
Description: Type of environment ,
Required: False ,
}
string ,
id:
{
Description: Id of the environment ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource ,
Required: False ,
}
string ,
properties:
{
Description: Environment properties ,
Required: False ,
}
{
streamGovernanceConfig:
{
Description: Stream governance configuration ,
Required: False ,
}
{
package:
{
Description: Stream governance configuration ,
Enum:
{
ESSENTIALS: No description available. ,
ADVANCED: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: Metadata of the record ,
Required: False ,
}
{
self:
{
Description: Self lookup url ,
Required: False ,
}
string ,
resourceName:
{
Description: Resource name of the record ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Created Date Time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Updated Date time ,
Required: False ,
}
string ,
deletedTimestamp:
{
Description: Deleted Date time ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: Display name of the environment ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of environment records if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message ,
Required: False ,
}
string ,
target:
{
Description: Error target ,
Required: False ,
}
string ,
details:
{
Description: Error detail ,
Required: False ,
}
[
string ,
]
,
}
,
}
Organization_GetEnvironmentById (new)
Description :  Get Environment details by environment Id
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/environments/{environmentId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
organizationName:
{
Description: Organization resource name ,
Required: True ,
}
string ,
environmentId:
{
Description: Confluent environment id ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: Type of environment ,
Required: False ,
}
string ,
id:
{
Description: Id of the environment ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource ,
Required: False ,
}
string ,
properties:
{
Description: Environment properties ,
Required: False ,
}
{
streamGovernanceConfig:
{
Description: Stream governance configuration ,
Required: False ,
}
{
package:
{
Description: Stream governance configuration ,
Enum:
{
ESSENTIALS: No description available. ,
ADVANCED: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: Metadata of the record ,
Required: False ,
}
{
self:
{
Description: Self lookup url ,
Required: False ,
}
string ,
resourceName:
{
Description: Resource name of the record ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Created Date Time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Updated Date time ,
Required: False ,
}
string ,
deletedTimestamp:
{
Description: Deleted Date time ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: Display name of the environment ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message ,
Required: False ,
}
string ,
target:
{
Description: Error target ,
Required: False ,
}
string ,
details:
{
Description: Error detail ,
Required: False ,
}
[
string ,
]
,
}
,
}
Environment_CreateOrUpdate (new)
Description :  Create confluent environment
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/environments/{environmentId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
organizationName:
{
Description: Organization resource name ,
Required: True ,
}
string ,
environmentId:
{
Description: Confluent environment id ,
Required: True ,
}
string ,
body:
{
Description: Confluent Environment resource model ,
Required: False ,
}
{
kind:
{
Description: Type of environment ,
Required: False ,
}
string ,
id:
{
Description: Id of the environment ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource ,
Required: False ,
}
string ,
properties:
{
Description: Environment properties ,
Required: False ,
}
{
streamGovernanceConfig:
{
Description: Stream governance configuration ,
Required: False ,
}
{
package:
{
Description: Stream governance configuration ,
Enum:
{
ESSENTIALS: No description available. ,
ADVANCED: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: Metadata of the record ,
Required: False ,
}
{
self:
{
Description: Self lookup url ,
Required: False ,
}
string ,
resourceName:
{
Description: Resource name of the record ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Created Date Time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Updated Date time ,
Required: False ,
}
string ,
deletedTimestamp:
{
Description: Deleted Date time ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: Display name of the environment ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
kind:
{
Description: Type of environment ,
Required: False ,
}
string ,
id:
{
Description: Id of the environment ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource ,
Required: False ,
}
string ,
properties:
{
Description: Environment properties ,
Required: False ,
}
{
streamGovernanceConfig:
{
Description: Stream governance configuration ,
Required: False ,
}
{
package:
{
Description: Stream governance configuration ,
Enum:
{
ESSENTIALS: No description available. ,
ADVANCED: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: Metadata of the record ,
Required: False ,
}
{
self:
{
Description: Self lookup url ,
Required: False ,
}
string ,
resourceName:
{
Description: Resource name of the record ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Created Date Time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Updated Date time ,
Required: False ,
}
string ,
deletedTimestamp:
{
Description: Deleted Date time ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: Display name of the environment ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
kind:
{
Description: Type of environment ,
Required: False ,
}
string ,
id:
{
Description: Id of the environment ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource ,
Required: False ,
}
string ,
properties:
{
Description: Environment properties ,
Required: False ,
}
{
streamGovernanceConfig:
{
Description: Stream governance configuration ,
Required: False ,
}
{
package:
{
Description: Stream governance configuration ,
Enum:
{
ESSENTIALS: No description available. ,
ADVANCED: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: Metadata of the record ,
Required: False ,
}
{
self:
{
Description: Self lookup url ,
Required: False ,
}
string ,
resourceName:
{
Description: Resource name of the record ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Created Date Time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Updated Date time ,
Required: False ,
}
string ,
deletedTimestamp:
{
Description: Deleted Date time ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: Display name of the environment ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message ,
Required: False ,
}
string ,
target:
{
Description: Error target ,
Required: False ,
}
string ,
details:
{
Description: Error detail ,
Required: False ,
}
[
string ,
]
,
}
,
}
Environment_Delete (new)
Description :  Delete confluent environment by id
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/environments/{environmentId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
organizationName:
{
Description: Organization resource name ,
Required: True ,
}
string ,
environmentId:
{
Description: Confluent environment id ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
}

⚐ Response (204)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Organization_ListClusters (new)
Description :  Lists of all the clusters in a environment
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/environments/{environmentId}/clusters
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
organizationName:
{
Description: Organization resource name ,
Required: True ,
}
string ,
environmentId:
{
Description: Confluent environment id ,
Required: True ,
}
string ,
pageSize:
{
Description: Pagination size ,
Format: int32 ,
Required: False ,
}
integer ,
pageToken:
{
Description: An opaque pagination token to fetch the next set of records ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of clusters in an environment of a confluent organization ,
Required: False ,
}
[
{
kind:
{
Description: Type of cluster ,
Required: False ,
}
string ,
id:
{
Description: Id of the cluster ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource ,
Required: False ,
}
string ,
properties:
{
Description: Cluster Properties ,
Required: False ,
}
{
metadata:
{
Description: Metadata of the record ,
Required: False ,
}
{
self:
{
Description: Self lookup url ,
Required: False ,
}
string ,
resourceName:
{
Description: Resource name of the record ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Created Date Time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Updated Date time ,
Required: False ,
}
string ,
deletedTimestamp:
{
Description: Deleted Date time ,
Required: False ,
}
string ,
}
,
spec:
{
Description: Specification of the cluster ,
Required: False ,
}
{
name:
{
Description: The name of the cluster ,
Required: False ,
}
string ,
availability:
{
Description: The availability zone configuration of the cluster ,
Required: False ,
}
string ,
cloud:
{
Description: The cloud service provider ,
Required: False ,
}
string ,
zone:
{
Description: type of zone availability ,
Required: False ,
}
string ,
package:
{
Description: Stream governance configuration ,
Enum:
{
ESSENTIALS: No description available. ,
ADVANCED: No description available. ,
}
,
Required: False ,
}
enum ,
region:
{
Description: The cloud service provider region ,
Required: False ,
}
string ,
kafkaBootstrapEndpoint:
{
Description: The bootstrap endpoint used by Kafka clients to connect to the cluster ,
Required: False ,
}
string ,
httpEndpoint:
{
Description: The cluster HTTP request URL. ,
Required: False ,
}
string ,
apiEndpoint:
{
Description: The Kafka API cluster endpoint ,
Required: False ,
}
string ,
config:
{
Description: Specification of the cluster configuration ,
Required: False ,
}
{
kind:
{
Description: The lifecycle phase of the cluster ,
Required: False ,
}
string ,
}
,
environment:
{
Description: Specification of the cluster environment ,
Required: False ,
}
{
id:
{
Description: ID of the referred resource ,
Required: False ,
}
string ,
environment:
{
Description: Environment of the referred resource ,
Required: False ,
}
string ,
related:
{
Description: API URL for accessing or modifying the referred object ,
Required: False ,
}
string ,
resourceName:
{
Description: CRN reference to the referred resource ,
Required: False ,
}
string ,
}
,
network:
{
Description: Specification of the cluster network ,
Required: False ,
}
{
id:
{
Description: ID of the referred resource ,
Required: False ,
}
string ,
environment:
{
Description: Environment of the referred resource ,
Required: False ,
}
string ,
related:
{
Description: API URL for accessing or modifying the referred object ,
Required: False ,
}
string ,
resourceName:
{
Description: CRN reference to the referred resource ,
Required: False ,
}
string ,
}
,
byok:
{
Description: Specification of the cluster byok ,
Required: False ,
}
{
id:
{
Description: ID of the referred resource ,
Required: False ,
}
string ,
related:
{
Description: API URL for accessing or modifying the referred object ,
Required: False ,
}
string ,
resourceName:
{
Description: CRN reference to the referred resource ,
Required: False ,
}
string ,
}
,
}
,
status:
{
Description: Specification of the cluster status ,
Required: False ,
}
{
phase:
{
Description: The lifecycle phase of the cluster ,
Required: False ,
}
string ,
cku:
{
Description: The number of Confluent Kafka Units ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
name:
{
Description: Display name of the cluster ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of cluster records if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message ,
Required: False ,
}
string ,
target:
{
Description: Error target ,
Required: False ,
}
string ,
details:
{
Description: Error detail ,
Required: False ,
}
[
string ,
]
,
}
,
}
Organization_ListSchemaRegistryClusters (new)
Description :  Get schema registry clusters
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/environments/{environmentId}/schemaRegistryClusters
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
organizationName:
{
Description: Organization resource name ,
Required: True ,
}
string ,
environmentId:
{
Description: Confluent environment id ,
Required: True ,
}
string ,
pageSize:
{
Description: Pagination size ,
Format: int32 ,
Required: False ,
}
integer ,
pageToken:
{
Description: An opaque pagination token to fetch the next set of records ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of schema registry clusters in an environment of a confluent organization ,
Required: False ,
}
[
{
kind:
{
Description: Kind of the cluster ,
Required: False ,
}
string ,
id:
{
Description: Id of the cluster ,
Required: False ,
}
string ,
properties:
{
Description: Schema Registry Cluster Properties ,
Required: False ,
}
{
metadata:
{
Description: Metadata of the record ,
Required: False ,
}
{
self:
{
Description: Self lookup url ,
Required: False ,
}
string ,
resourceName:
{
Description: Resource name of the record ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Created Date Time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Updated Date time ,
Required: False ,
}
string ,
deletedTimestamp:
{
Description: Deleted Date time ,
Required: False ,
}
string ,
}
,
spec:
{
Description: Specification of the schema registry cluster ,
Required: False ,
}
{
name:
{
Description: Name of the schema registry cluster ,
Required: False ,
}
string ,
httpEndpoint:
{
Description: Http endpoint of the cluster ,
Required: False ,
}
string ,
package:
{
Description: Type of the cluster package Advanced, essentials ,
Required: False ,
}
string ,
region:
{
Description: Region details of the schema registry cluster ,
Required: False ,
}
{
id:
{
Description: ID of the referred resource ,
Required: False ,
}
string ,
related:
{
Description: API URL for accessing or modifying the referred object ,
Required: False ,
}
string ,
resourceName:
{
Description: CRN reference to the referred resource ,
Required: False ,
}
string ,
}
,
environment:
{
Description: Environment details of the schema registry cluster ,
Required: False ,
}
{
id:
{
Description: ID of the referred resource ,
Required: False ,
}
string ,
related:
{
Description: API URL for accessing or modifying the referred object ,
Required: False ,
}
string ,
resourceName:
{
Description: CRN reference to the referred resource ,
Required: False ,
}
string ,
}
,
cloud:
{
Description: The cloud service provider ,
Required: False ,
}
string ,
}
,
status:
{
Description: Specification of the cluster status ,
Required: False ,
}
{
phase:
{
Description: The lifecycle phase of the cluster ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of schema registry cluster records if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message ,
Required: False ,
}
string ,
target:
{
Description: Error target ,
Required: False ,
}
string ,
details:
{
Description: Error detail ,
Required: False ,
}
[
string ,
]
,
}
,
}
Organization_ListRegions (new)
Description :  cloud provider regions available for creating Schema Registry clusters.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/listRegions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
organizationName:
{
Description: Organization resource name ,
Required: True ,
}
string ,
body:
{
Description: List Access Request Model ,
Required: True ,
}
{
searchFilters:
{
Description: Search filters for the request ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
data:
{
Description: List of regions supported by confluent ,
Required: False ,
}
[
{
kind:
{
Description: Kind of the cluster ,
Required: False ,
}
string ,
id:
{
Description: Id of the cluster ,
Required: False ,
}
string ,
properties:
{
Description: Region Properties ,
Required: False ,
}
{
metadata:
{
Description: Metadata of the record ,
Required: False ,
}
{
self:
{
Description: Self lookup url ,
Required: False ,
}
string ,
resourceName:
{
Description: Resource name of the record ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Created Date Time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Updated Date time ,
Required: False ,
}
string ,
deletedTimestamp:
{
Description: Deleted Date time ,
Required: False ,
}
string ,
}
,
spec:
{
Description: Specification of the region ,
Required: False ,
}
{
name:
{
Description: Display Name of the region ,
Required: False ,
}
string ,
cloud:
{
Description: Cloud provider name ,
Required: False ,
}
string ,
regionName:
{
Description: Region name ,
Required: False ,
}
string ,
packages:
{
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message ,
Required: False ,
}
string ,
target:
{
Description: Error target ,
Required: False ,
}
string ,
details:
{
Description: Error detail ,
Required: False ,
}
[
string ,
]
,
}
,
}
Organization_CreateAPIKey (new)
Description :  Creates API key for a schema registry Cluster ID or Kafka Cluster ID under a environment
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/environments/{environmentId}/clusters/{clusterId}/createAPIKey
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
organizationName:
{
Description: Organization resource name ,
Required: True ,
}
string ,
environmentId:
{
Description: Confluent environment id ,
Required: True ,
}
string ,
clusterId:
{
Description: Confluent kafka or schema registry cluster id ,
Required: True ,
}
string ,
body:
{
Description: Request payload for get creating API Key for schema registry Cluster ID or Kafka Cluster ID under a environment ,
Required: True ,
}
{
name:
{
Description: Name of the API Key ,
Required: False ,
}
string ,
description:
{
Description: Description of the API Key ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
kind:
{
Description: Type of api key ,
Required: False ,
}
string ,
id:
{
Description: Id of the api key ,
Required: False ,
}
string ,
properties:
{
Description: API Key Properties ,
Required: False ,
}
{
metadata:
{
Description: Metadata of the record ,
Required: False ,
}
{
self:
{
Description: Self lookup url ,
Required: False ,
}
string ,
resourceName:
{
Description: Resource name of the record ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Created Date Time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Updated Date time ,
Required: False ,
}
string ,
deletedTimestamp:
{
Description: Deleted Date time ,
Required: False ,
}
string ,
}
,
spec:
{
Description: Specification of the API Key ,
Required: False ,
}
{
description:
{
Description: The description of the API Key ,
Required: False ,
}
string ,
name:
{
Description: The name of the API Key ,
Required: False ,
}
string ,
secret:
{
Description: API Key Secret ,
Required: False ,
}
string ,
resource:
{
Description: Specification of the cluster ,
Required: False ,
}
{
id:
{
Description: Id of the resource ,
Required: False ,
}
string ,
environment:
{
Description: The environment of the api key ,
Required: False ,
}
string ,
related:
{
Description: API URL for accessing or modifying the api key resource object ,
Required: False ,
}
string ,
resourceName:
{
Description: CRN reference to the referred resource ,
Required: False ,
}
string ,
kind:
{
Description: Type of the owner which can be service or user account ,
Required: False ,
}
string ,
}
,
owner:
{
Description: Specification of the cluster ,
Required: False ,
}
{
id:
{
Description: API Key owner id ,
Required: False ,
}
string ,
related:
{
Description: API URL for accessing or modifying the referred object ,
Required: False ,
}
string ,
resourceName:
{
Description: CRN reference to the referred resource ,
Required: False ,
}
string ,
kind:
{
Description: Type of the owner service or user account ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message ,
Required: False ,
}
string ,
target:
{
Description: Error target ,
Required: False ,
}
string ,
details:
{
Description: Error detail ,
Required: False ,
}
[
string ,
]
,
}
,
}
Organization_DeleteClusterAPIKey (new)
Description :  Deletes API key of a kafka or schema registry cluster
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/apiKeys/{apiKeyId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
organizationName:
{
Description: Organization resource name ,
Required: True ,
}
string ,
apiKeyId:
{
Description: Confluent API Key id ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message ,
Required: False ,
}
string ,
target:
{
Description: Error target ,
Required: False ,
}
string ,
details:
{
Description: Error detail ,
Required: False ,
}
[
string ,
]
,
}
,
}
Organization_GetClusterAPIKey (new)
Description :  Get API key details of a kafka or schema registry cluster
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/apiKeys/{apiKeyId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
organizationName:
{
Description: Organization resource name ,
Required: True ,
}
string ,
apiKeyId:
{
Description: Confluent API Key id ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: Type of api key ,
Required: False ,
}
string ,
id:
{
Description: Id of the api key ,
Required: False ,
}
string ,
properties:
{
Description: API Key Properties ,
Required: False ,
}
{
metadata:
{
Description: Metadata of the record ,
Required: False ,
}
{
self:
{
Description: Self lookup url ,
Required: False ,
}
string ,
resourceName:
{
Description: Resource name of the record ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Created Date Time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Updated Date time ,
Required: False ,
}
string ,
deletedTimestamp:
{
Description: Deleted Date time ,
Required: False ,
}
string ,
}
,
spec:
{
Description: Specification of the API Key ,
Required: False ,
}
{
description:
{
Description: The description of the API Key ,
Required: False ,
}
string ,
name:
{
Description: The name of the API Key ,
Required: False ,
}
string ,
secret:
{
Description: API Key Secret ,
Required: False ,
}
string ,
resource:
{
Description: Specification of the cluster ,
Required: False ,
}
{
id:
{
Description: Id of the resource ,
Required: False ,
}
string ,
environment:
{
Description: The environment of the api key ,
Required: False ,
}
string ,
related:
{
Description: API URL for accessing or modifying the api key resource object ,
Required: False ,
}
string ,
resourceName:
{
Description: CRN reference to the referred resource ,
Required: False ,
}
string ,
kind:
{
Description: Type of the owner which can be service or user account ,
Required: False ,
}
string ,
}
,
owner:
{
Description: Specification of the cluster ,
Required: False ,
}
{
id:
{
Description: API Key owner id ,
Required: False ,
}
string ,
related:
{
Description: API URL for accessing or modifying the referred object ,
Required: False ,
}
string ,
resourceName:
{
Description: CRN reference to the referred resource ,
Required: False ,
}
string ,
kind:
{
Description: Type of the owner service or user account ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message ,
Required: False ,
}
string ,
target:
{
Description: Error target ,
Required: False ,
}
string ,
details:
{
Description: Error detail ,
Required: False ,
}
[
string ,
]
,
}
,
}
Organization_GetSchemaRegistryClusterById (new)
Description :  Get schema registry cluster by Id
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/environments/{environmentId}/schemaRegistryClusters/{clusterId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
organizationName:
{
Description: Organization resource name ,
Required: True ,
}
string ,
environmentId:
{
Description: Confluent environment id ,
Required: True ,
}
string ,
clusterId:
{
Description: Confluent kafka or schema registry cluster id ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: Kind of the cluster ,
Required: False ,
}
string ,
id:
{
Description: Id of the cluster ,
Required: False ,
}
string ,
properties:
{
Description: Schema Registry Cluster Properties ,
Required: False ,
}
{
metadata:
{
Description: Metadata of the record ,
Required: False ,
}
{
self:
{
Description: Self lookup url ,
Required: False ,
}
string ,
resourceName:
{
Description: Resource name of the record ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Created Date Time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Updated Date time ,
Required: False ,
}
string ,
deletedTimestamp:
{
Description: Deleted Date time ,
Required: False ,
}
string ,
}
,
spec:
{
Description: Specification of the schema registry cluster ,
Required: False ,
}
{
name:
{
Description: Name of the schema registry cluster ,
Required: False ,
}
string ,
httpEndpoint:
{
Description: Http endpoint of the cluster ,
Required: False ,
}
string ,
package:
{
Description: Type of the cluster package Advanced, essentials ,
Required: False ,
}
string ,
region:
{
Description: Region details of the schema registry cluster ,
Required: False ,
}
{
id:
{
Description: ID of the referred resource ,
Required: False ,
}
string ,
related:
{
Description: API URL for accessing or modifying the referred object ,
Required: False ,
}
string ,
resourceName:
{
Description: CRN reference to the referred resource ,
Required: False ,
}
string ,
}
,
environment:
{
Description: Environment details of the schema registry cluster ,
Required: False ,
}
{
id:
{
Description: ID of the referred resource ,
Required: False ,
}
string ,
related:
{
Description: API URL for accessing or modifying the referred object ,
Required: False ,
}
string ,
resourceName:
{
Description: CRN reference to the referred resource ,
Required: False ,
}
string ,
}
,
cloud:
{
Description: The cloud service provider ,
Required: False ,
}
string ,
}
,
status:
{
Description: Specification of the cluster status ,
Required: False ,
}
{
phase:
{
Description: The lifecycle phase of the cluster ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message ,
Required: False ,
}
string ,
target:
{
Description: Error target ,
Required: False ,
}
string ,
details:
{
Description: Error detail ,
Required: False ,
}
[
string ,
]
,
}
,
}
Organization_GetClusterById (new)
Description :  Get cluster by Id
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/environments/{environmentId}/clusters/{clusterId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
organizationName:
{
Description: Organization resource name ,
Required: True ,
}
string ,
environmentId:
{
Description: Confluent environment id ,
Required: True ,
}
string ,
clusterId:
{
Description: Confluent kafka or schema registry cluster id ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: Type of cluster ,
Required: False ,
}
string ,
id:
{
Description: Id of the cluster ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource ,
Required: False ,
}
string ,
properties:
{
Description: Cluster Properties ,
Required: False ,
}
{
metadata:
{
Description: Metadata of the record ,
Required: False ,
}
{
self:
{
Description: Self lookup url ,
Required: False ,
}
string ,
resourceName:
{
Description: Resource name of the record ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Created Date Time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Updated Date time ,
Required: False ,
}
string ,
deletedTimestamp:
{
Description: Deleted Date time ,
Required: False ,
}
string ,
}
,
spec:
{
Description: Specification of the cluster ,
Required: False ,
}
{
name:
{
Description: The name of the cluster ,
Required: False ,
}
string ,
availability:
{
Description: The availability zone configuration of the cluster ,
Required: False ,
}
string ,
cloud:
{
Description: The cloud service provider ,
Required: False ,
}
string ,
zone:
{
Description: type of zone availability ,
Required: False ,
}
string ,
package:
{
Description: Stream governance configuration ,
Enum:
{
ESSENTIALS: No description available. ,
ADVANCED: No description available. ,
}
,
Required: False ,
}
enum ,
region:
{
Description: The cloud service provider region ,
Required: False ,
}
string ,
kafkaBootstrapEndpoint:
{
Description: The bootstrap endpoint used by Kafka clients to connect to the cluster ,
Required: False ,
}
string ,
httpEndpoint:
{
Description: The cluster HTTP request URL. ,
Required: False ,
}
string ,
apiEndpoint:
{
Description: The Kafka API cluster endpoint ,
Required: False ,
}
string ,
config:
{
Description: Specification of the cluster configuration ,
Required: False ,
}
{
kind:
{
Description: The lifecycle phase of the cluster ,
Required: False ,
}
string ,
}
,
environment:
{
Description: Specification of the cluster environment ,
Required: False ,
}
{
id:
{
Description: ID of the referred resource ,
Required: False ,
}
string ,
environment:
{
Description: Environment of the referred resource ,
Required: False ,
}
string ,
related:
{
Description: API URL for accessing or modifying the referred object ,
Required: False ,
}
string ,
resourceName:
{
Description: CRN reference to the referred resource ,
Required: False ,
}
string ,
}
,
network:
{
Description: Specification of the cluster network ,
Required: False ,
}
{
id:
{
Description: ID of the referred resource ,
Required: False ,
}
string ,
environment:
{
Description: Environment of the referred resource ,
Required: False ,
}
string ,
related:
{
Description: API URL for accessing or modifying the referred object ,
Required: False ,
}
string ,
resourceName:
{
Description: CRN reference to the referred resource ,
Required: False ,
}
string ,
}
,
byok:
{
Description: Specification of the cluster byok ,
Required: False ,
}
{
id:
{
Description: ID of the referred resource ,
Required: False ,
}
string ,
related:
{
Description: API URL for accessing or modifying the referred object ,
Required: False ,
}
string ,
resourceName:
{
Description: CRN reference to the referred resource ,
Required: False ,
}
string ,
}
,
}
,
status:
{
Description: Specification of the cluster status ,
Required: False ,
}
{
phase:
{
Description: The lifecycle phase of the cluster ,
Required: False ,
}
string ,
cku:
{
Description: The number of Confluent Kafka Units ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
name:
{
Description: Display name of the cluster ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message ,
Required: False ,
}
string ,
target:
{
Description: Error target ,
Required: False ,
}
string ,
details:
{
Description: Error detail ,
Required: False ,
}
[
string ,
]
,
}
,
}
Cluster_CreateOrUpdate (new)
Description :  Create confluent clusters
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/environments/{environmentId}/clusters/{clusterId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
organizationName:
{
Description: Organization resource name ,
Required: True ,
}
string ,
environmentId:
{
Description: Confluent environment id ,
Required: True ,
}
string ,
clusterId:
{
Description: Confluent kafka or schema registry cluster id ,
Required: True ,
}
string ,
body:
{
Description: Confluent Cluster resource model ,
Required: False ,
}
{
kind:
{
Description: Type of cluster ,
Required: False ,
}
string ,
id:
{
Description: Id of the cluster ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource ,
Required: False ,
}
string ,
properties:
{
Description: Cluster Properties ,
Required: False ,
}
{
metadata:
{
Description: Metadata of the record ,
Required: False ,
}
{
self:
{
Description: Self lookup url ,
Required: False ,
}
string ,
resourceName:
{
Description: Resource name of the record ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Created Date Time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Updated Date time ,
Required: False ,
}
string ,
deletedTimestamp:
{
Description: Deleted Date time ,
Required: False ,
}
string ,
}
,
spec:
{
Description: Specification of the cluster ,
Required: False ,
}
{
name:
{
Description: The name of the cluster ,
Required: False ,
}
string ,
availability:
{
Description: The availability zone configuration of the cluster ,
Required: False ,
}
string ,
cloud:
{
Description: The cloud service provider ,
Required: False ,
}
string ,
zone:
{
Description: type of zone availability ,
Required: False ,
}
string ,
package:
{
Description: Stream governance configuration ,
Enum:
{
ESSENTIALS: No description available. ,
ADVANCED: No description available. ,
}
,
Required: False ,
}
enum ,
region:
{
Description: The cloud service provider region ,
Required: False ,
}
string ,
kafkaBootstrapEndpoint:
{
Description: The bootstrap endpoint used by Kafka clients to connect to the cluster ,
Required: False ,
}
string ,
httpEndpoint:
{
Description: The cluster HTTP request URL. ,
Required: False ,
}
string ,
apiEndpoint:
{
Description: The Kafka API cluster endpoint ,
Required: False ,
}
string ,
config:
{
Description: Specification of the cluster configuration ,
Required: False ,
}
{
kind:
{
Description: The lifecycle phase of the cluster ,
Required: False ,
}
string ,
}
,
environment:
{
Description: Specification of the cluster environment ,
Required: False ,
}
{
id:
{
Description: ID of the referred resource ,
Required: False ,
}
string ,
environment:
{
Description: Environment of the referred resource ,
Required: False ,
}
string ,
related:
{
Description: API URL for accessing or modifying the referred object ,
Required: False ,
}
string ,
resourceName:
{
Description: CRN reference to the referred resource ,
Required: False ,
}
string ,
}
,
network:
{
Description: Specification of the cluster network ,
Required: False ,
}
{
id:
{
Description: ID of the referred resource ,
Required: False ,
}
string ,
environment:
{
Description: Environment of the referred resource ,
Required: False ,
}
string ,
related:
{
Description: API URL for accessing or modifying the referred object ,
Required: False ,
}
string ,
resourceName:
{
Description: CRN reference to the referred resource ,
Required: False ,
}
string ,
}
,
byok:
{
Description: Specification of the cluster byok ,
Required: False ,
}
{
id:
{
Description: ID of the referred resource ,
Required: False ,
}
string ,
related:
{
Description: API URL for accessing or modifying the referred object ,
Required: False ,
}
string ,
resourceName:
{
Description: CRN reference to the referred resource ,
Required: False ,
}
string ,
}
,
}
,
status:
{
Description: Specification of the cluster status ,
Required: False ,
}
{
phase:
{
Description: The lifecycle phase of the cluster ,
Required: False ,
}
string ,
cku:
{
Description: The number of Confluent Kafka Units ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
name:
{
Description: Display name of the cluster ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
kind:
{
Description: Type of cluster ,
Required: False ,
}
string ,
id:
{
Description: Id of the cluster ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource ,
Required: False ,
}
string ,
properties:
{
Description: Cluster Properties ,
Required: False ,
}
{
metadata:
{
Description: Metadata of the record ,
Required: False ,
}
{
self:
{
Description: Self lookup url ,
Required: False ,
}
string ,
resourceName:
{
Description: Resource name of the record ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Created Date Time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Updated Date time ,
Required: False ,
}
string ,
deletedTimestamp:
{
Description: Deleted Date time ,
Required: False ,
}
string ,
}
,
spec:
{
Description: Specification of the cluster ,
Required: False ,
}
{
name:
{
Description: The name of the cluster ,
Required: False ,
}
string ,
availability:
{
Description: The availability zone configuration of the cluster ,
Required: False ,
}
string ,
cloud:
{
Description: The cloud service provider ,
Required: False ,
}
string ,
zone:
{
Description: type of zone availability ,
Required: False ,
}
string ,
package:
{
Description: Stream governance configuration ,
Enum:
{
ESSENTIALS: No description available. ,
ADVANCED: No description available. ,
}
,
Required: False ,
}
enum ,
region:
{
Description: The cloud service provider region ,
Required: False ,
}
string ,
kafkaBootstrapEndpoint:
{
Description: The bootstrap endpoint used by Kafka clients to connect to the cluster ,
Required: False ,
}
string ,
httpEndpoint:
{
Description: The cluster HTTP request URL. ,
Required: False ,
}
string ,
apiEndpoint:
{
Description: The Kafka API cluster endpoint ,
Required: False ,
}
string ,
config:
{
Description: Specification of the cluster configuration ,
Required: False ,
}
{
kind:
{
Description: The lifecycle phase of the cluster ,
Required: False ,
}
string ,
}
,
environment:
{
Description: Specification of the cluster environment ,
Required: False ,
}
{
id:
{
Description: ID of the referred resource ,
Required: False ,
}
string ,
environment:
{
Description: Environment of the referred resource ,
Required: False ,
}
string ,
related:
{
Description: API URL for accessing or modifying the referred object ,
Required: False ,
}
string ,
resourceName:
{
Description: CRN reference to the referred resource ,
Required: False ,
}
string ,
}
,
network:
{
Description: Specification of the cluster network ,
Required: False ,
}
{
id:
{
Description: ID of the referred resource ,
Required: False ,
}
string ,
environment:
{
Description: Environment of the referred resource ,
Required: False ,
}
string ,
related:
{
Description: API URL for accessing or modifying the referred object ,
Required: False ,
}
string ,
resourceName:
{
Description: CRN reference to the referred resource ,
Required: False ,
}
string ,
}
,
byok:
{
Description: Specification of the cluster byok ,
Required: False ,
}
{
id:
{
Description: ID of the referred resource ,
Required: False ,
}
string ,
related:
{
Description: API URL for accessing or modifying the referred object ,
Required: False ,
}
string ,
resourceName:
{
Description: CRN reference to the referred resource ,
Required: False ,
}
string ,
}
,
}
,
status:
{
Description: Specification of the cluster status ,
Required: False ,
}
{
phase:
{
Description: The lifecycle phase of the cluster ,
Required: False ,
}
string ,
cku:
{
Description: The number of Confluent Kafka Units ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
name:
{
Description: Display name of the cluster ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
kind:
{
Description: Type of cluster ,
Required: False ,
}
string ,
id:
{
Description: Id of the cluster ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource ,
Required: False ,
}
string ,
properties:
{
Description: Cluster Properties ,
Required: False ,
}
{
metadata:
{
Description: Metadata of the record ,
Required: False ,
}
{
self:
{
Description: Self lookup url ,
Required: False ,
}
string ,
resourceName:
{
Description: Resource name of the record ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: Created Date Time ,
Required: False ,
}
string ,
updatedTimestamp:
{
Description: Updated Date time ,
Required: False ,
}
string ,
deletedTimestamp:
{
Description: Deleted Date time ,
Required: False ,
}
string ,
}
,
spec:
{
Description: Specification of the cluster ,
Required: False ,
}
{
name:
{
Description: The name of the cluster ,
Required: False ,
}
string ,
availability:
{
Description: The availability zone configuration of the cluster ,
Required: False ,
}
string ,
cloud:
{
Description: The cloud service provider ,
Required: False ,
}
string ,
zone:
{
Description: type of zone availability ,
Required: False ,
}
string ,
package:
{
Description: Stream governance configuration ,
Enum:
{
ESSENTIALS: No description available. ,
ADVANCED: No description available. ,
}
,
Required: False ,
}
enum ,
region:
{
Description: The cloud service provider region ,
Required: False ,
}
string ,
kafkaBootstrapEndpoint:
{
Description: The bootstrap endpoint used by Kafka clients to connect to the cluster ,
Required: False ,
}
string ,
httpEndpoint:
{
Description: The cluster HTTP request URL. ,
Required: False ,
}
string ,
apiEndpoint:
{
Description: The Kafka API cluster endpoint ,
Required: False ,
}
string ,
config:
{
Description: Specification of the cluster configuration ,
Required: False ,
}
{
kind:
{
Description: The lifecycle phase of the cluster ,
Required: False ,
}
string ,
}
,
environment:
{
Description: Specification of the cluster environment ,
Required: False ,
}
{
id:
{
Description: ID of the referred resource ,
Required: False ,
}
string ,
environment:
{
Description: Environment of the referred resource ,
Required: False ,
}
string ,
related:
{
Description: API URL for accessing or modifying the referred object ,
Required: False ,
}
string ,
resourceName:
{
Description: CRN reference to the referred resource ,
Required: False ,
}
string ,
}
,
network:
{
Description: Specification of the cluster network ,
Required: False ,
}
{
id:
{
Description: ID of the referred resource ,
Required: False ,
}
string ,
environment:
{
Description: Environment of the referred resource ,
Required: False ,
}
string ,
related:
{
Description: API URL for accessing or modifying the referred object ,
Required: False ,
}
string ,
resourceName:
{
Description: CRN reference to the referred resource ,
Required: False ,
}
string ,
}
,
byok:
{
Description: Specification of the cluster byok ,
Required: False ,
}
{
id:
{
Description: ID of the referred resource ,
Required: False ,
}
string ,
related:
{
Description: API URL for accessing or modifying the referred object ,
Required: False ,
}
string ,
resourceName:
{
Description: CRN reference to the referred resource ,
Required: False ,
}
string ,
}
,
}
,
status:
{
Description: Specification of the cluster status ,
Required: False ,
}
{
phase:
{
Description: The lifecycle phase of the cluster ,
Required: False ,
}
string ,
cku:
{
Description: The number of Confluent Kafka Units ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
name:
{
Description: Display name of the cluster ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message ,
Required: False ,
}
string ,
target:
{
Description: Error target ,
Required: False ,
}
string ,
details:
{
Description: Error detail ,
Required: False ,
}
[
string ,
]
,
}
,
}
Cluster_Delete (new)
Description :  Delete confluent cluster by id
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/environments/{environmentId}/clusters/{clusterId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
organizationName:
{
Description: Organization resource name ,
Required: True ,
}
string ,
environmentId:
{
Description: Confluent environment id ,
Required: True ,
}
string ,
clusterId:
{
Description: Confluent kafka or schema registry cluster id ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
}

⚐ Response (204)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Connector_Get (new)
Description :  Get confluent connector by Name
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/environments/{environmentId}/clusters/{clusterId}/connectors/{connectorName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
organizationName:
{
Description: Organization resource name ,
Required: True ,
}
string ,
environmentId:
{
Description: Confluent environment id ,
Required: True ,
}
string ,
clusterId:
{
Description: Confluent kafka or schema registry cluster id ,
Required: True ,
}
string ,
connectorName:
{
Description: Confluent connector name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: Display name of the connector ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the Connector ,
Required: True ,
}
{
connectorBasicInfo:
{
Description: Connector Info Base ,
Required: False ,
}
{
connectorType:
{
Description: Connector Type ,
Enum:
{
SINK: No description available. ,
SOURCE: No description available. ,
}
,
Required: False ,
}
enum ,
connectorClass:
{
Description: Connector Class ,
Enum:
{
AZUREBLOBSOURCE: No description available. ,
AZUREBLOBSINK: No description available. ,
}
,
Required: False ,
}
enum ,
connectorName:
{
Description: Connector Name ,
Required: False ,
}
string ,
connectorId:
{
Description: Connector Id ,
Required: False ,
}
string ,
connectorState:
{
Description: Connector Status ,
Enum:
{
PROVISIONING: No description available. ,
RUNNING: No description available. ,
PAUSED: No description available. ,
FAILED: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
connectorServiceTypeInfo:
{
Description: Connector Service type info base properties. ,
Required: False ,
}
{
connectorServiceType:
{
Description: The connector service type. ,
Enum:
{
AzureBlobStorageSinkConnector: No description available. ,
AzureBlobStorageSourceConnector: No description available. ,
AzureCosmosDBSinkConnector: No description available. ,
AzureCosmosDBSourceConnector: No description available. ,
AzureSynapseAnalyticsSinkConnector: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
partnerConnectorInfo:
{
Description: The connection information consumed by applications. ,
Required: False ,
}
{
partnerConnectorType:
{
Description: The partner connector type. ,
Enum:
{
KafkaAzureBlobStorageSource: No description available. ,
KafkaAzureBlobStorageSink: No description available. ,
KafkaAzureCosmosDBSource: No description available. ,
KafkaAzureCosmosDBSink: No description available. ,
KafkaAzureSynapseAnalyticsSink: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message ,
Required: False ,
}
string ,
target:
{
Description: Error target ,
Required: False ,
}
string ,
details:
{
Description: Error detail ,
Required: False ,
}
[
string ,
]
,
}
,
}
Connector_CreateOrUpdate (new)
Description :  Create confluent connector by Name
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/environments/{environmentId}/clusters/{clusterId}/connectors/{connectorName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
organizationName:
{
Description: Organization resource name ,
Required: True ,
}
string ,
environmentId:
{
Description: Confluent environment id ,
Required: True ,
}
string ,
clusterId:
{
Description: Confluent kafka or schema registry cluster id ,
Required: True ,
}
string ,
connectorName:
{
Description: Confluent connector name ,
Required: True ,
}
string ,
body:
{
Description: Confluent Connector resource model ,
Required: False ,
}
{
name:
{
Description: Display name of the connector ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the Connector ,
Required: True ,
}
{
connectorBasicInfo:
{
Description: Connector Info Base ,
Required: False ,
}
{
connectorType:
{
Description: Connector Type ,
Enum:
{
SINK: No description available. ,
SOURCE: No description available. ,
}
,
Required: False ,
}
enum ,
connectorClass:
{
Description: Connector Class ,
Enum:
{
AZUREBLOBSOURCE: No description available. ,
AZUREBLOBSINK: No description available. ,
}
,
Required: False ,
}
enum ,
connectorName:
{
Description: Connector Name ,
Required: False ,
}
string ,
connectorId:
{
Description: Connector Id ,
Required: False ,
}
string ,
connectorState:
{
Description: Connector Status ,
Enum:
{
PROVISIONING: No description available. ,
RUNNING: No description available. ,
PAUSED: No description available. ,
FAILED: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
connectorServiceTypeInfo:
{
Description: Connector Service type info base properties. ,
Required: False ,
}
{
connectorServiceType:
{
Description: The connector service type. ,
Enum:
{
AzureBlobStorageSinkConnector: No description available. ,
AzureBlobStorageSourceConnector: No description available. ,
AzureCosmosDBSinkConnector: No description available. ,
AzureCosmosDBSourceConnector: No description available. ,
AzureSynapseAnalyticsSinkConnector: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
partnerConnectorInfo:
{
Description: The connection information consumed by applications. ,
Required: False ,
}
{
partnerConnectorType:
{
Description: The partner connector type. ,
Enum:
{
KafkaAzureBlobStorageSource: No description available. ,
KafkaAzureBlobStorageSink: No description available. ,
KafkaAzureCosmosDBSource: No description available. ,
KafkaAzureCosmosDBSink: No description available. ,
KafkaAzureSynapseAnalyticsSink: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
}

⚐ Response (200)

{
name:
{
Description: Display name of the connector ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the Connector ,
Required: True ,
}
{
connectorBasicInfo:
{
Description: Connector Info Base ,
Required: False ,
}
{
connectorType:
{
Description: Connector Type ,
Enum:
{
SINK: No description available. ,
SOURCE: No description available. ,
}
,
Required: False ,
}
enum ,
connectorClass:
{
Description: Connector Class ,
Enum:
{
AZUREBLOBSOURCE: No description available. ,
AZUREBLOBSINK: No description available. ,
}
,
Required: False ,
}
enum ,
connectorName:
{
Description: Connector Name ,
Required: False ,
}
string ,
connectorId:
{
Description: Connector Id ,
Required: False ,
}
string ,
connectorState:
{
Description: Connector Status ,
Enum:
{
PROVISIONING: No description available. ,
RUNNING: No description available. ,
PAUSED: No description available. ,
FAILED: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
connectorServiceTypeInfo:
{
Description: Connector Service type info base properties. ,
Required: False ,
}
{
connectorServiceType:
{
Description: The connector service type. ,
Enum:
{
AzureBlobStorageSinkConnector: No description available. ,
AzureBlobStorageSourceConnector: No description available. ,
AzureCosmosDBSinkConnector: No description available. ,
AzureCosmosDBSourceConnector: No description available. ,
AzureSynapseAnalyticsSinkConnector: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
partnerConnectorInfo:
{
Description: The connection information consumed by applications. ,
Required: False ,
}
{
partnerConnectorType:
{
Description: The partner connector type. ,
Enum:
{
KafkaAzureBlobStorageSource: No description available. ,
KafkaAzureBlobStorageSink: No description available. ,
KafkaAzureCosmosDBSource: No description available. ,
KafkaAzureCosmosDBSink: No description available. ,
KafkaAzureSynapseAnalyticsSink: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (201)

{
name:
{
Description: Display name of the connector ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the Connector ,
Required: True ,
}
{
connectorBasicInfo:
{
Description: Connector Info Base ,
Required: False ,
}
{
connectorType:
{
Description: Connector Type ,
Enum:
{
SINK: No description available. ,
SOURCE: No description available. ,
}
,
Required: False ,
}
enum ,
connectorClass:
{
Description: Connector Class ,
Enum:
{
AZUREBLOBSOURCE: No description available. ,
AZUREBLOBSINK: No description available. ,
}
,
Required: False ,
}
enum ,
connectorName:
{
Description: Connector Name ,
Required: False ,
}
string ,
connectorId:
{
Description: Connector Id ,
Required: False ,
}
string ,
connectorState:
{
Description: Connector Status ,
Enum:
{
PROVISIONING: No description available. ,
RUNNING: No description available. ,
PAUSED: No description available. ,
FAILED: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
connectorServiceTypeInfo:
{
Description: Connector Service type info base properties. ,
Required: False ,
}
{
connectorServiceType:
{
Description: The connector service type. ,
Enum:
{
AzureBlobStorageSinkConnector: No description available. ,
AzureBlobStorageSourceConnector: No description available. ,
AzureCosmosDBSinkConnector: No description available. ,
AzureCosmosDBSourceConnector: No description available. ,
AzureSynapseAnalyticsSinkConnector: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
partnerConnectorInfo:
{
Description: The connection information consumed by applications. ,
Required: False ,
}
{
partnerConnectorType:
{
Description: The partner connector type. ,
Enum:
{
KafkaAzureBlobStorageSource: No description available. ,
KafkaAzureBlobStorageSink: No description available. ,
KafkaAzureCosmosDBSource: No description available. ,
KafkaAzureCosmosDBSink: No description available. ,
KafkaAzureSynapseAnalyticsSink: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message ,
Required: False ,
}
string ,
target:
{
Description: Error target ,
Required: False ,
}
string ,
details:
{
Description: Error detail ,
Required: False ,
}
[
string ,
]
,
}
,
}
Connector_Delete (new)
Description :  Delete confluent connector by name
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/environments/{environmentId}/clusters/{clusterId}/connectors/{connectorName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
organizationName:
{
Description: Organization resource name ,
Required: True ,
}
string ,
environmentId:
{
Description: Confluent environment id ,
Required: True ,
}
string ,
clusterId:
{
Description: Confluent kafka or schema registry cluster id ,
Required: True ,
}
string ,
connectorName:
{
Description: Confluent connector name ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
}

⚐ Response (204)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Connector_List (new)
Description :  Lists all the connectors in a cluster
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/environments/{environmentId}/clusters/{clusterId}/connectors
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
organizationName:
{
Description: Organization resource name ,
Required: True ,
}
string ,
environmentId:
{
Description: Confluent environment id ,
Required: True ,
}
string ,
clusterId:
{
Description: Confluent kafka or schema registry cluster id ,
Required: True ,
}
string ,
pageSize:
{
Description: Pagination size ,
Format: int32 ,
Required: False ,
}
integer ,
pageToken:
{
Description: An opaque pagination token to fetch the next set of records ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of connectors in a cluster of a confluent organization ,
Required: False ,
}
[
{
name:
{
Description: Display name of the connector ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the Connector ,
Required: True ,
}
{
connectorBasicInfo:
{
Description: Connector Info Base ,
Required: False ,
}
{
connectorType:
{
Description: Connector Type ,
Enum:
{
SINK: No description available. ,
SOURCE: No description available. ,
}
,
Required: False ,
}
enum ,
connectorClass:
{
Description: Connector Class ,
Enum:
{
AZUREBLOBSOURCE: No description available. ,
AZUREBLOBSINK: No description available. ,
}
,
Required: False ,
}
enum ,
connectorName:
{
Description: Connector Name ,
Required: False ,
}
string ,
connectorId:
{
Description: Connector Id ,
Required: False ,
}
string ,
connectorState:
{
Description: Connector Status ,
Enum:
{
PROVISIONING: No description available. ,
RUNNING: No description available. ,
PAUSED: No description available. ,
FAILED: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
connectorServiceTypeInfo:
{
Description: Connector Service type info base properties. ,
Required: False ,
}
{
connectorServiceType:
{
Description: The connector service type. ,
Enum:
{
AzureBlobStorageSinkConnector: No description available. ,
AzureBlobStorageSourceConnector: No description available. ,
AzureCosmosDBSinkConnector: No description available. ,
AzureCosmosDBSourceConnector: No description available. ,
AzureSynapseAnalyticsSinkConnector: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
partnerConnectorInfo:
{
Description: The connection information consumed by applications. ,
Required: False ,
}
{
partnerConnectorType:
{
Description: The partner connector type. ,
Enum:
{
KafkaAzureBlobStorageSource: No description available. ,
KafkaAzureBlobStorageSink: No description available. ,
KafkaAzureCosmosDBSource: No description available. ,
KafkaAzureCosmosDBSink: No description available. ,
KafkaAzureSynapseAnalyticsSink: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of connectors records if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message ,
Required: False ,
}
string ,
target:
{
Description: Error target ,
Required: False ,
}
string ,
details:
{
Description: Error detail ,
Required: False ,
}
[
string ,
]
,
}
,
}
Topics_List (new)
Description :  Lists of all the topics in a clusters
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/environments/{environmentId}/clusters/{clusterId}/topics
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
organizationName:
{
Description: Organization resource name ,
Required: True ,
}
string ,
environmentId:
{
Description: Confluent environment id ,
Required: True ,
}
string ,
clusterId:
{
Description: Confluent kafka or schema registry cluster id ,
Required: True ,
}
string ,
pageSize:
{
Description: Pagination size ,
Format: int32 ,
Required: False ,
}
integer ,
pageToken:
{
Description: An opaque pagination token to fetch the next set of records ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of topics in a cluster of a confluent organization ,
Required: False ,
}
[
{
id:
{
Description: The ARM Resource Id of the Topic ,
Required: False ,
}
string ,
name:
{
Description: Display name of the topic ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
properties:
{
Description: Topic Properties ,
Required: False ,
}
{
kind:
{
Description: Type of topic ,
Required: False ,
}
string ,
topicId:
{
Description: Topic Id returned by Confluent ,
Required: False ,
}
string ,
metadata:
{
Description: Metadata of the record ,
Required: False ,
}
{
self:
{
Description: Self lookup url ,
Required: False ,
}
string ,
resourceName:
{
Description: Resource name of the record ,
Required: False ,
}
string ,
}
,
partitions:
{
Description: Partition Specification of the topic ,
Required: False ,
}
{
related:
{
Description: Relationship of the topic ,
Required: False ,
}
string ,
}
,
configs:
{
Description: Config Specification of the topic ,
Required: False ,
}
{
related:
{
Description: Relationship of the topic ,
Required: False ,
}
string ,
}
,
inputConfigs:
{
Description: Input Config Specification of the topic ,
Required: False ,
}
[
{
name:
{
Description: Name of the topic input config ,
Required: False ,
}
string ,
value:
{
Description: Value of the topic input config ,
Required: False ,
}
string ,
}
,
]
,
partitionsReassignments:
{
Description: Partition Reassignment Specification of the topic ,
Required: False ,
}
{
related:
{
Description: Relationship of the topic ,
Required: False ,
}
string ,
}
,
partitionsCount:
{
Description: Partition count of the topic ,
Required: False ,
}
string ,
replicationFactor:
{
Description: Replication factor of the topic ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of topics records if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message ,
Required: False ,
}
string ,
target:
{
Description: Error target ,
Required: False ,
}
string ,
details:
{
Description: Error detail ,
Required: False ,
}
[
string ,
]
,
}
,
}
Topics_Get (new)
Description :  Get confluent topic by Name
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/environments/{environmentId}/clusters/{clusterId}/topics/{topicName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
organizationName:
{
Description: Organization resource name ,
Required: True ,
}
string ,
environmentId:
{
Description: Confluent environment id ,
Required: True ,
}
string ,
clusterId:
{
Description: Confluent kafka or schema registry cluster id ,
Required: True ,
}
string ,
topicName:
{
Description: Confluent kafka or schema registry topic name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ARM Resource Id of the Topic ,
Required: False ,
}
string ,
name:
{
Description: Display name of the topic ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
properties:
{
Description: Topic Properties ,
Required: False ,
}
{
kind:
{
Description: Type of topic ,
Required: False ,
}
string ,
topicId:
{
Description: Topic Id returned by Confluent ,
Required: False ,
}
string ,
metadata:
{
Description: Metadata of the record ,
Required: False ,
}
{
self:
{
Description: Self lookup url ,
Required: False ,
}
string ,
resourceName:
{
Description: Resource name of the record ,
Required: False ,
}
string ,
}
,
partitions:
{
Description: Partition Specification of the topic ,
Required: False ,
}
{
related:
{
Description: Relationship of the topic ,
Required: False ,
}
string ,
}
,
configs:
{
Description: Config Specification of the topic ,
Required: False ,
}
{
related:
{
Description: Relationship of the topic ,
Required: False ,
}
string ,
}
,
inputConfigs:
{
Description: Input Config Specification of the topic ,
Required: False ,
}
[
{
name:
{
Description: Name of the topic input config ,
Required: False ,
}
string ,
value:
{
Description: Value of the topic input config ,
Required: False ,
}
string ,
}
,
]
,
partitionsReassignments:
{
Description: Partition Reassignment Specification of the topic ,
Required: False ,
}
{
related:
{
Description: Relationship of the topic ,
Required: False ,
}
string ,
}
,
partitionsCount:
{
Description: Partition count of the topic ,
Required: False ,
}
string ,
replicationFactor:
{
Description: Replication factor of the topic ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message ,
Required: False ,
}
string ,
target:
{
Description: Error target ,
Required: False ,
}
string ,
details:
{
Description: Error detail ,
Required: False ,
}
[
string ,
]
,
}
,
}
Topics_Create (new)
Description :  Create confluent topics by Name
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/environments/{environmentId}/clusters/{clusterId}/topics/{topicName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
organizationName:
{
Description: Organization resource name ,
Required: True ,
}
string ,
environmentId:
{
Description: Confluent environment id ,
Required: True ,
}
string ,
clusterId:
{
Description: Confluent kafka or schema registry cluster id ,
Required: True ,
}
string ,
topicName:
{
Description: Confluent kafka or schema registry topic name ,
Required: True ,
}
string ,
body:
{
Description: Confluent Topics resource model ,
Required: False ,
}
{
id:
{
Description: The ARM Resource Id of the Topic ,
Required: False ,
}
string ,
name:
{
Description: Display name of the topic ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
properties:
{
Description: Topic Properties ,
Required: False ,
}
{
kind:
{
Description: Type of topic ,
Required: False ,
}
string ,
topicId:
{
Description: Topic Id returned by Confluent ,
Required: False ,
}
string ,
metadata:
{
Description: Metadata of the record ,
Required: False ,
}
{
self:
{
Description: Self lookup url ,
Required: False ,
}
string ,
resourceName:
{
Description: Resource name of the record ,
Required: False ,
}
string ,
}
,
partitions:
{
Description: Partition Specification of the topic ,
Required: False ,
}
{
related:
{
Description: Relationship of the topic ,
Required: False ,
}
string ,
}
,
configs:
{
Description: Config Specification of the topic ,
Required: False ,
}
{
related:
{
Description: Relationship of the topic ,
Required: False ,
}
string ,
}
,
inputConfigs:
{
Description: Input Config Specification of the topic ,
Required: False ,
}
[
{
name:
{
Description: Name of the topic input config ,
Required: False ,
}
string ,
value:
{
Description: Value of the topic input config ,
Required: False ,
}
string ,
}
,
]
,
partitionsReassignments:
{
Description: Partition Reassignment Specification of the topic ,
Required: False ,
}
{
related:
{
Description: Relationship of the topic ,
Required: False ,
}
string ,
}
,
partitionsCount:
{
Description: Partition count of the topic ,
Required: False ,
}
string ,
replicationFactor:
{
Description: Replication factor of the topic ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Description: The ARM Resource Id of the Topic ,
Required: False ,
}
string ,
name:
{
Description: Display name of the topic ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
properties:
{
Description: Topic Properties ,
Required: False ,
}
{
kind:
{
Description: Type of topic ,
Required: False ,
}
string ,
topicId:
{
Description: Topic Id returned by Confluent ,
Required: False ,
}
string ,
metadata:
{
Description: Metadata of the record ,
Required: False ,
}
{
self:
{
Description: Self lookup url ,
Required: False ,
}
string ,
resourceName:
{
Description: Resource name of the record ,
Required: False ,
}
string ,
}
,
partitions:
{
Description: Partition Specification of the topic ,
Required: False ,
}
{
related:
{
Description: Relationship of the topic ,
Required: False ,
}
string ,
}
,
configs:
{
Description: Config Specification of the topic ,
Required: False ,
}
{
related:
{
Description: Relationship of the topic ,
Required: False ,
}
string ,
}
,
inputConfigs:
{
Description: Input Config Specification of the topic ,
Required: False ,
}
[
{
name:
{
Description: Name of the topic input config ,
Required: False ,
}
string ,
value:
{
Description: Value of the topic input config ,
Required: False ,
}
string ,
}
,
]
,
partitionsReassignments:
{
Description: Partition Reassignment Specification of the topic ,
Required: False ,
}
{
related:
{
Description: Relationship of the topic ,
Required: False ,
}
string ,
}
,
partitionsCount:
{
Description: Partition count of the topic ,
Required: False ,
}
string ,
replicationFactor:
{
Description: Replication factor of the topic ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
id:
{
Description: The ARM Resource Id of the Topic ,
Required: False ,
}
string ,
name:
{
Description: Display name of the topic ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
properties:
{
Description: Topic Properties ,
Required: False ,
}
{
kind:
{
Description: Type of topic ,
Required: False ,
}
string ,
topicId:
{
Description: Topic Id returned by Confluent ,
Required: False ,
}
string ,
metadata:
{
Description: Metadata of the record ,
Required: False ,
}
{
self:
{
Description: Self lookup url ,
Required: False ,
}
string ,
resourceName:
{
Description: Resource name of the record ,
Required: False ,
}
string ,
}
,
partitions:
{
Description: Partition Specification of the topic ,
Required: False ,
}
{
related:
{
Description: Relationship of the topic ,
Required: False ,
}
string ,
}
,
configs:
{
Description: Config Specification of the topic ,
Required: False ,
}
{
related:
{
Description: Relationship of the topic ,
Required: False ,
}
string ,
}
,
inputConfigs:
{
Description: Input Config Specification of the topic ,
Required: False ,
}
[
{
name:
{
Description: Name of the topic input config ,
Required: False ,
}
string ,
value:
{
Description: Value of the topic input config ,
Required: False ,
}
string ,
}
,
]
,
partitionsReassignments:
{
Description: Partition Reassignment Specification of the topic ,
Required: False ,
}
{
related:
{
Description: Relationship of the topic ,
Required: False ,
}
string ,
}
,
partitionsCount:
{
Description: Partition count of the topic ,
Required: False ,
}
string ,
replicationFactor:
{
Description: Replication factor of the topic ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message ,
Required: False ,
}
string ,
target:
{
Description: Error target ,
Required: False ,
}
string ,
details:
{
Description: Error detail ,
Required: False ,
}
[
string ,
]
,
}
,
}
Topics_Delete (new)
Description :  Delete confluent topic by name
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/environments/{environmentId}/clusters/{clusterId}/topics/{topicName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
organizationName:
{
Description: Organization resource name ,
Required: True ,
}
string ,
environmentId:
{
Description: Confluent environment id ,
Required: True ,
}
string ,
clusterId:
{
Description: Confluent kafka or schema registry cluster id ,
Required: True ,
}
string ,
topicName:
{
Description: Confluent kafka or schema registry topic name ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
}

⚐ Response (204)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}