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

2025/07/07 • 36 updated methods

OrganizationOperations_List (updated)
Description :  List the operations for the provider
Reference :  Link ¶

⚶ Changes

{
  "#id": "OrganizationOperations_List",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Required": {
            "new": true,
            "old": false
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /providers/Microsoft.Confluent/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Confluent operations supported by the Microsoft.Confluent provider. ,
Required: True ,
}
[
{
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 ,
]
,
}
,
}
MarketplaceAgreements_List (updated)
Description :  List Confluent marketplace agreements in the subscription.
Reference :  Link ¶

⚶ Changes

{
  "#id": "MarketplaceAgreements_List",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "Microsoft Azure subscription id"
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The ConfluentAgreementResource items on this page",
            "old": "Results of a list operation."
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Link to the next set of results, if any."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Confluent/agreements
{
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 ,
}

⚐ Response (200)

{
value:
{
Description: The ConfluentAgreementResource items on this page ,
Required: True ,
}
[
{
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: The link to the next page of items ,
Format: uri ,
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 (updated)
Description :  Create Confluent Marketplace agreement in the subscription.
Reference :  Link ¶

⚶ Changes

{
  "#id": "MarketplaceAgreements_Create",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "Microsoft Azure subscription id"
      }
    },
    {
      "#name": "body",
      "Description": {
        "new": "The request body",
        "old": "Confluent Marketplace Agreement resource"
      }
    }
  ]
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/providers/Microsoft.Confluent/agreements/default
{
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 ,
body:
{
Description: The request body ,
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 ,
]
,
}
,
}
Organization_ListBySubscription (updated)
Description :  List all organizations under the specified subscription.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Organization_ListBySubscription",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "Microsoft Azure subscription id"
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "The response of a OrganizationResource list operation.",
        "old": "The response of a list operation."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The OrganizationResource items on this page",
            "old": "Result of a list operation."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "@removed_f7090e7ff7454fcc97c8237d6c7e0153": {
                "#name": "id",
                "Description": "The ARM id of the resource.",
                "Required": false,
                "Type": "string"
              },
              "@removed_b4fe27106aec42a6a8f861aea6b0ccbd": {
                "#name": "name",
                "Description": "The name of the resource.",
                "Required": false,
                "Type": "string"
              },
              "@removed_8e4e55b0457045e6b91c7e511bd7d3bb": {
                "#name": "type",
                "Description": "The type of the resource.",
                "Required": false,
                "Type": "string"
              },
              "@removed_26245de8b7f2485188dd4fbd9ce09d95": {
                "#name": "systemData",
                "Description": "Metadata pertaining to creation and last modification of the resource",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "createdBy",
                    "Description": "The identity that created the resource.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "createdByType",
                    "Description": "The type of identity that created the resource.",
                    "Enum": [
                      [
                        "User",
                        ""
                      ],
                      [
                        "Application",
                        ""
                      ],
                      [
                        "ManagedIdentity",
                        ""
                      ],
                      [
                        "Key",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "createdAt",
                    "Description": "The timestamp of resource creation (UTC).",
                    "Format": "date-time",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "lastModifiedBy",
                    "Description": "The identity that last modified the resource.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "lastModifiedByType",
                    "Description": "The type of identity that last modified the resource.",
                    "Enum": [
                      [
                        "User",
                        ""
                      ],
                      [
                        "Application",
                        ""
                      ],
                      [
                        "ManagedIdentity",
                        ""
                      ],
                      [
                        "Key",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "lastModifiedAt",
                    "Description": "The timestamp of resource last modification (UTC)",
                    "Format": "date-time",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              },
              "@removed_3a77e288ac1c44db9206f83b3f7809bf": {
                "#name": "tags",
                "Description": "Organization resource tags",
                "Required": false,
                "Type": "object"
              },
              "@removed_6533d24fd414436eaad8c261d9541ede": {
                "#name": "location",
                "Description": "Location of Organization resource",
                "Required": false,
                "Type": "string"
              }
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Link to the next set of results, if any."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Confluent/organizations
{
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 ,
}

⚐ Response (200)

{
value:
{
Description: The OrganizationResource items on this page ,
Required: True ,
}
[
{
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 ,
Format: password ,
Required: True ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 (updated)
Description :  List all Organizations under the specified resource group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Organization_ListByResourceGroup",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "Microsoft Azure subscription id"
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "Resource group name"
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "The response of a OrganizationResource list operation.",
        "old": "The response of a list operation."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The OrganizationResource items on this page",
            "old": "Result of a list operation."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "@removed_907fd566b2af45df8e4378d66593d339": {
                "#name": "id",
                "Description": "The ARM id of the resource.",
                "Required": false,
                "Type": "string"
              },
              "@removed_9b9dbd988fbe4a6b92b7c191fb5b7778": {
                "#name": "name",
                "Description": "The name of the resource.",
                "Required": false,
                "Type": "string"
              },
              "@removed_9a71cd2a1e674e8a875467b2cbb3252f": {
                "#name": "type",
                "Description": "The type of the resource.",
                "Required": false,
                "Type": "string"
              },
              "@removed_db3c3a798a654e58a39d1d39ef6b7238": {
                "#name": "systemData",
                "Description": "Metadata pertaining to creation and last modification of the resource",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "createdBy",
                    "Description": "The identity that created the resource.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "createdByType",
                    "Description": "The type of identity that created the resource.",
                    "Enum": [
                      [
                        "User",
                        ""
                      ],
                      [
                        "Application",
                        ""
                      ],
                      [
                        "ManagedIdentity",
                        ""
                      ],
                      [
                        "Key",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "createdAt",
                    "Description": "The timestamp of resource creation (UTC).",
                    "Format": "date-time",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "lastModifiedBy",
                    "Description": "The identity that last modified the resource.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "lastModifiedByType",
                    "Description": "The type of identity that last modified the resource.",
                    "Enum": [
                      [
                        "User",
                        ""
                      ],
                      [
                        "Application",
                        ""
                      ],
                      [
                        "ManagedIdentity",
                        ""
                      ],
                      [
                        "Key",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "lastModifiedAt",
                    "Description": "The timestamp of resource last modification (UTC)",
                    "Format": "date-time",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              },
              "@removed_7cac8356da0c44a88e0b8c67e3cd924d": {
                "#name": "tags",
                "Description": "Organization resource tags",
                "Required": false,
                "Type": "object"
              },
              "@removed_b70571f7a7124f7697b4201afe9e7951": {
                "#name": "location",
                "Description": "Location of Organization resource",
                "Required": false,
                "Type": "string"
              }
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Link to the next set of results, if any."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations
{
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 ,
}

⚐ Response (200)

{
value:
{
Description: The OrganizationResource items on this page ,
Required: True ,
}
[
{
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 ,
Format: password ,
Required: True ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 (updated)
Description :  Get the properties of a specific Organization resource.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Organization_Get",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "Microsoft Azure subscription id"
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "Resource group name"
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@removed_7c0d17d15c1c42efac4ff31eba601190": {
          "#name": "id",
          "Description": "The ARM id of the resource.",
          "Required": false,
          "Type": "string"
        },
        "@removed_7bd7ea1f2e894ae2a9f9a237e7c26789": {
          "#name": "name",
          "Description": "The name of the resource.",
          "Required": false,
          "Type": "string"
        },
        "@removed_401c2f6afead49b389232859e7c2b2d4": {
          "#name": "type",
          "Description": "The type of the resource.",
          "Required": false,
          "Type": "string"
        },
        "@removed_7d6f966096f1479cb84f9e461d218166": {
          "#name": "systemData",
          "Description": "Metadata pertaining to creation and last modification of the resource",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "createdBy",
              "Description": "The identity that created the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdByType",
              "Description": "The type of identity that created the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdAt",
              "Description": "The timestamp of resource creation (UTC).",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedBy",
              "Description": "The identity that last modified the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedByType",
              "Description": "The type of identity that last modified the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedAt",
              "Description": "The timestamp of resource last modification (UTC)",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            }
          ]
        },
        "@removed_bc7bd124639a40408514fe520b13ddc4": {
          "#name": "tags",
          "Description": "Organization resource tags",
          "Required": false,
          "Type": "object"
        },
        "@removed_76d1707b658f4bcfb2c1a64fc409c395": {
          "#name": "location",
          "Description": "Location of Organization resource",
          "Required": false,
          "Type": "string"
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}
{
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 ,
}

⚐ Response (200)

{
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 ,
Format: password ,
Required: True ,
}
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 (updated)
Description :  Create Organization resource
Reference :  Link ¶

⚶ Changes

{
  "#id": "Organization_Create",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "Microsoft Azure subscription id"
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "Resource group name"
      }
    },
    {
      "body": {
        "$properties": {
          "@removed_cad60df7027845c180d479620901ad6c": {
            "#name": "id",
            "Description": "The ARM id of the resource.",
            "Required": false,
            "Type": "string"
          },
          "@removed_48f76649aa6c4b6db0d4fdcf7e16571c": {
            "#name": "name",
            "Description": "The name of the resource.",
            "Required": false,
            "Type": "string"
          },
          "@removed_fef4e071670b4ba8a54168e2c9375177": {
            "#name": "type",
            "Description": "The type of the resource.",
            "Required": false,
            "Type": "string"
          },
          "@removed_6f64271cd5954474af45cc9b097c60ab": {
            "#name": "systemData",
            "Description": "Metadata pertaining to creation and last modification of the resource",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "createdBy",
                "Description": "The identity that created the resource.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "createdByType",
                "Description": "The type of identity that created the resource.",
                "Enum": [
                  [
                    "User",
                    ""
                  ],
                  [
                    "Application",
                    ""
                  ],
                  [
                    "ManagedIdentity",
                    ""
                  ],
                  [
                    "Key",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "createdAt",
                "Description": "The timestamp of resource creation (UTC).",
                "Format": "date-time",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "lastModifiedBy",
                "Description": "The identity that last modified the resource.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "lastModifiedByType",
                "Description": "The type of identity that last modified the resource.",
                "Enum": [
                  [
                    "User",
                    ""
                  ],
                  [
                    "Application",
                    ""
                  ],
                  [
                    "ManagedIdentity",
                    ""
                  ],
                  [
                    "Key",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "lastModifiedAt",
                "Description": "The timestamp of resource last modification (UTC)",
                "Format": "date-time",
                "Required": false,
                "Type": "string"
              }
            ]
          },
          "@removed_f9a3f0da81b7445ea248767bc633c132": {
            "#name": "tags",
            "Description": "Organization resource tags",
            "Required": false,
            "Type": "object"
          },
          "@removed_ac5c7fab3ca94047a684891ea0165c8d": {
            "#name": "location",
            "Description": "Location of Organization resource",
            "Required": false,
            "Type": "string"
          }
        }
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@removed_58a0827c7d5d42bfa27aede314f2c375": {
          "#name": "id",
          "Description": "The ARM id of the resource.",
          "Required": false,
          "Type": "string"
        },
        "@removed_728b3e1264cc4412ba08ad0014cf9b65": {
          "#name": "name",
          "Description": "The name of the resource.",
          "Required": false,
          "Type": "string"
        },
        "@removed_06e308fee36040da8e2effaacf3af609": {
          "#name": "type",
          "Description": "The type of the resource.",
          "Required": false,
          "Type": "string"
        },
        "@removed_645af3e0a4ca46a49121f2b4448ec4f6": {
          "#name": "systemData",
          "Description": "Metadata pertaining to creation and last modification of the resource",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "createdBy",
              "Description": "The identity that created the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdByType",
              "Description": "The type of identity that created the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdAt",
              "Description": "The timestamp of resource creation (UTC).",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedBy",
              "Description": "The identity that last modified the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedByType",
              "Description": "The type of identity that last modified the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedAt",
              "Description": "The timestamp of resource last modification (UTC)",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            }
          ]
        },
        "@removed_fff0eac1cd2d43249ef50e83d34b751b": {
          "#name": "tags",
          "Description": "Organization resource tags",
          "Required": false,
          "Type": "object"
        },
        "@removed_a911fa50ed3a4d70b17e610a3c996f5d": {
          "#name": "location",
          "Description": "Location of Organization resource",
          "Required": false,
          "Type": "string"
        }
      }
    },
    "201": {
      "$properties": {
        "@removed_0045796e506f4187832249b55f10234a": {
          "#name": "id",
          "Description": "The ARM id of the resource.",
          "Required": false,
          "Type": "string"
        },
        "@removed_363fbb42cf3146b39ee43459be4b7926": {
          "#name": "name",
          "Description": "The name of the resource.",
          "Required": false,
          "Type": "string"
        },
        "@removed_76f0cdea4b8e4515b5203cee374699b9": {
          "#name": "type",
          "Description": "The type of the resource.",
          "Required": false,
          "Type": "string"
        },
        "@removed_0fa3cf84a1d742c3bc2342c5da678f46": {
          "#name": "systemData",
          "Description": "Metadata pertaining to creation and last modification of the resource",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "createdBy",
              "Description": "The identity that created the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdByType",
              "Description": "The type of identity that created the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdAt",
              "Description": "The timestamp of resource creation (UTC).",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedBy",
              "Description": "The identity that last modified the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedByType",
              "Description": "The type of identity that last modified the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedAt",
              "Description": "The timestamp of resource last modification (UTC)",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            }
          ]
        },
        "@removed_429fbd8d79594f1b849774f2f105774a": {
          "#name": "tags",
          "Description": "Organization resource tags",
          "Required": false,
          "Type": "object"
        },
        "@removed_6faf0c4899d549f1808248fddfae1959": {
          "#name": "location",
          "Description": "Location of Organization resource",
          "Required": false,
          "Type": "string"
        }
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}
{
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: Organization resource model ,
Required: False ,
}
{
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 ,
Format: password ,
Required: True ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
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 ,
Format: password ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Organization resource. ,
}
{
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 ,
Format: password ,
Required: True ,
}
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 (updated)
Description :  Update Organization resource
Reference :  Link ¶

⚶ Changes

{
  "#id": "Organization_Update",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "Microsoft Azure subscription id"
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "Resource group name"
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@removed_64a0803a3b224d4cadf1ccf4382dd9f0": {
          "#name": "id",
          "Description": "The ARM id of the resource.",
          "Required": false,
          "Type": "string"
        },
        "@removed_7bca9c25e5c74d7ca0c125efcb0d91a1": {
          "#name": "name",
          "Description": "The name of the resource.",
          "Required": false,
          "Type": "string"
        },
        "@removed_0ca7ab1bcec44529970ee874d76cc90a": {
          "#name": "type",
          "Description": "The type of the resource.",
          "Required": false,
          "Type": "string"
        },
        "@removed_7749a1295e204e15b7499f55f46c2f11": {
          "#name": "systemData",
          "Description": "Metadata pertaining to creation and last modification of the resource",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "createdBy",
              "Description": "The identity that created the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdByType",
              "Description": "The type of identity that created the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdAt",
              "Description": "The timestamp of resource creation (UTC).",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedBy",
              "Description": "The identity that last modified the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedByType",
              "Description": "The type of identity that last modified the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedAt",
              "Description": "The timestamp of resource last modification (UTC)",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            }
          ]
        },
        "@removed_446ecb8974b14c6f8f35e2e3bbeb6f51": {
          "#name": "tags",
          "Description": "Organization resource tags",
          "Required": false,
          "Type": "object"
        },
        "@removed_842cc146c1bb48eeb65a53838fe5a4a0": {
          "#name": "location",
          "Description": "Location of Organization resource",
          "Required": false,
          "Type": "string"
        }
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}
{
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: Updated Organization resource ,
Required: False ,
}
{
tags:
{
Description: ARM resource tags ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
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 ,
Format: password ,
Required: True ,
}
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 (updated)
Description :  Delete Organization resource
Reference :  Link ¶

⚶ Changes

{
  "#id": "Organization_Delete",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "Microsoft Azure subscription id"
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "Resource group name"
      }
    }
  ]
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}
{
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 ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ 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_InviteUser (updated)
Description :  Invite user to the organization
Reference :  Link ¶

⚶ Changes

{
  "#id": "Access_InviteUser",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "Microsoft Azure subscription id"
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "Resource group name"
      }
    }
  ]
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/access/default/createInvitation
{
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: 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_ListClusters (updated)
Description :  Cluster details
Reference :  Link ¶

⚶ Changes

{
  "#id": "Access_ListClusters",
  "$responses": {
    "200": {
      "$properties": {
        "data": {
          "$properties": {
            "spec": [
              {
                "#name": "cloud",
                "Description": {
                  "new": "The cloud service provider",
                  "old": "The cloud service provider "
                }
              }
            ],
            "status": [
              {
                "#name": "cku",
                "Description": {
                  "new": "The number of Confluent Kafka Units",
                  "old": "The number of Confluent Kafka Units "
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ 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_ListInvitations (updated)
Description :  Organization accounts invitation details
Reference :  Link ¶

⚶ Changes

{
  "#id": "Access_ListInvitations",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "Microsoft Azure subscription id"
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "Resource group name"
      }
    }
  ]
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/access/default/listInvitations
{
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: 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_ListServiceAccounts (updated)
Description :  Organization service accounts details
Reference :  Link ¶

⚶ Changes

{
  "#id": "Access_ListServiceAccounts",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "Microsoft Azure subscription id"
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "Resource group name"
      }
    }
  ]
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/access/default/listServiceAccounts
{
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: 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_ListUsers (updated)
Description :  Organization users details
Reference :  Link ¶

⚶ Changes

{
  "#id": "Access_ListUsers",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "Microsoft Azure subscription id"
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "Resource group name"
      }
    }
  ]
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/access/default/listUsers
{
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: 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 ,
]
,
}
,
}
Organization_GetClusterAPIKey (updated)
Description :  Get API key details of a kafka or schema registry cluster
Reference :  Link ¶

⚶ Changes

{
  "#id": "Organization_GetClusterAPIKey",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "spec": [
              {
                "#name": "secret",
                "Description": {
                  "new": "API Key Secret",
                  "old": "API Key Secret "
                }
              },
              {
                "resource": [
                  {
                    "#name": "related",
                    "Description": {
                      "new": "API URL for accessing or modifying the api key resource object",
                      "old": "API URL for accessing or modifying the api key resource object "
                    }
                  }
                ]
              },
              {
                "owner": [
                  {
                    "#name": "related",
                    "Description": {
                      "new": "API URL for accessing or modifying the referred object",
                      "old": "API URL for accessing or modifying the referred object "
                    }
                  }
                ]
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ 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 ,
Format: password ,
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_ListEnvironments (updated)
Description :  Lists of all the environments in a organization
Reference :  Link ¶

⚶ Changes

{
  "#id": "Organization_ListEnvironments",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The SCEnvironmentRecord items on this page",
            "old": "List of environments in a confluent organization"
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "@removed_f7b93908067248c38a973d52570058a4": {
                "#name": "id",
                "Description": "Id of the environment",
                "Required": false,
                "Type": "string"
              },
              "@removed_1d383f1da9e443e78df86ea605f1b51a": {
                "#name": "type",
                "Description": "Type of the resource",
                "Required": false,
                "Type": "string"
              },
              "@removed_62a3fe8cd28d499db2c1790b3aaea2b7": {
                "#name": "name",
                "Description": "Display name of the environment",
                "Required": false,
                "Type": "string"
              }
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "URL to get the next set of environment records if there are any."
          }
        }
      ]
    }
  }
}

⚼ 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: The SCEnvironmentRecord items on this page ,
Required: True ,
}
[
{
kind:
{
Description: Type of environment ,
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 ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 (updated)
Description :  Get Environment details by environment Id
Reference :  Link ¶

⚶ Changes

{
  "#id": "Organization_GetEnvironmentById",
  "$responses": {
    "200": {
      "$properties": {
        "@removed_7a885ced9e394e4baa580798e9ddf2fe": {
          "#name": "id",
          "Description": "Id of the environment",
          "Required": false,
          "Type": "string"
        },
        "@removed_a75aea3546ab4872939f30dba2699e43": {
          "#name": "type",
          "Description": "Type of the resource",
          "Required": false,
          "Type": "string"
        },
        "@removed_e737949421f8436bb4662966561b9ba6": {
          "#name": "name",
          "Description": "Display name of the environment",
          "Required": false,
          "Type": "string"
        }
      }
    }
  }
}

⚼ 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 ,
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 ,
}
,
}
,
}

⚐ 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 (updated)
Description :  Create confluent environment
Reference :  Link ¶

⚶ Changes

{
  "#id": "Environment_CreateOrUpdate",
  "$parameters": {
    "body": {
      "$properties": {
        "@removed_277ddb97a369430b97d5160223ca6e5d": {
          "#name": "id",
          "Description": "Id of the environment",
          "Required": false,
          "Type": "string"
        },
        "@removed_e601bad8cb864ca38ceba2dfa748683a": {
          "#name": "type",
          "Description": "Type of the resource",
          "Required": false,
          "Type": "string"
        },
        "@removed_1737d37b4014442ca1182fb4a14eb1b0": {
          "#name": "name",
          "Description": "Display name of the environment",
          "Required": false,
          "Type": "string"
        }
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "@removed_5e008b68876943d4a69b5078251e38db": {
          "#name": "id",
          "Description": "Id of the environment",
          "Required": false,
          "Type": "string"
        },
        "@removed_81ae4d977b134898be6af14dd125a99f": {
          "#name": "type",
          "Description": "Type of the resource",
          "Required": false,
          "Type": "string"
        },
        "@removed_4e87ab23935d431d90ffaff223a2cba0": {
          "#name": "name",
          "Description": "Display name of the environment",
          "Required": false,
          "Type": "string"
        }
      }
    },
    "201": {
      "$properties": {
        "@removed_a390e068f5c4408bab5a1ab173488d20": {
          "#name": "id",
          "Description": "Id of the environment",
          "Required": false,
          "Type": "string"
        },
        "@removed_3a96556696b24796a55175768175e6fd": {
          "#name": "type",
          "Description": "Type of the resource",
          "Required": false,
          "Type": "string"
        },
        "@removed_d56ec67b605a407fa71fa85ec8e4c3f3": {
          "#name": "name",
          "Description": "Display name of the environment",
          "Required": false,
          "Type": "string"
        }
      }
    }
  }
}

⚼ 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 ,
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 ,
}
,
}
,
}
,
}

⚐ Response (200)

{
kind:
{
Description: Type of environment ,
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 ,
}
,
}
,
}

⚐ Response (201)

{
kind:
{
Description: Type of environment ,
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 ,
}
,
}
,
}

⚐ 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 (updated)
Description :  Delete confluent environment by id
Reference :  Link ¶

⚶ Changes

{
  "#id": "Environment_Delete",
  "$responses": {
    "202": [
      {
        "@added_bfb1067fef1741f6a7aed98f537444d8": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ 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 ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ 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 (updated)
Description :  Lists of all the clusters in a environment
Reference :  Link ¶

⚶ Changes

{
  "#id": "Organization_ListClusters",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The SCClusterRecord items on this page",
            "old": "List of clusters in an environment of a confluent organization"
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "properties": [
                {
                  "spec": [
                    {
                      "#name": "cloud",
                      "Description": {
                        "new": "The cloud service provider",
                        "old": "The cloud service provider "
                      }
                    }
                  ]
                },
                {
                  "status": [
                    {
                      "#name": "cku",
                      "Description": {
                        "new": "The number of Confluent Kafka Units",
                        "old": "The number of Confluent Kafka Units "
                      }
                    }
                  ]
                }
              ],
              "@removed_799ba82c4b7a4f32b035157e311b9a11": {
                "#name": "id",
                "Description": "Id of the cluster",
                "Required": false,
                "Type": "string"
              },
              "@removed_6f3ede5e5919419bae1143f718735eed": {
                "#name": "type",
                "Description": "Type of the resource",
                "Required": false,
                "Type": "string"
              },
              "@removed_a99d7a5c6de049f08404951dd64d3b25": {
                "#name": "name",
                "Description": "Display name of the cluster",
                "Required": false,
                "Type": "string"
              }
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "URL to get the next set of cluster records if there are any."
          }
        }
      ]
    }
  }
}

⚼ 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: The SCClusterRecord items on this page ,
Required: True ,
}
[
{
kind:
{
Description: Type of cluster ,
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 ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 (updated)
Description :  Get cluster by Id
Reference :  Link ¶

⚶ Changes

{
  "#id": "Organization_GetClusterById",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "spec": [
              {
                "#name": "cloud",
                "Description": {
                  "new": "The cloud service provider",
                  "old": "The cloud service provider "
                }
              }
            ]
          },
          {
            "status": [
              {
                "#name": "cku",
                "Description": {
                  "new": "The number of Confluent Kafka Units",
                  "old": "The number of Confluent Kafka Units "
                }
              }
            ]
          }
        ],
        "@removed_4df41549bf10492e8d481b44cc818b47": {
          "#name": "id",
          "Description": "Id of the cluster",
          "Required": false,
          "Type": "string"
        },
        "@removed_c8bc16561d2049dba8d442793a99578c": {
          "#name": "type",
          "Description": "Type of the resource",
          "Required": false,
          "Type": "string"
        },
        "@removed_2165b981b5094c72b0c69d49c58ceb6a": {
          "#name": "name",
          "Description": "Display name of the cluster",
          "Required": false,
          "Type": "string"
        }
      }
    }
  }
}

⚼ 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 ,
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 ,
}
,
}
,
}

⚐ 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 (updated)
Description :  Create confluent clusters
Reference :  Link ¶

⚶ Changes

{
  "#id": "Cluster_CreateOrUpdate",
  "$parameters": {
    "body": {
      "$properties": {
        "properties": [
          {
            "spec": [
              {
                "#name": "cloud",
                "Description": {
                  "new": "The cloud service provider",
                  "old": "The cloud service provider "
                }
              }
            ]
          },
          {
            "status": [
              {
                "#name": "cku",
                "Description": {
                  "new": "The number of Confluent Kafka Units",
                  "old": "The number of Confluent Kafka Units "
                }
              }
            ]
          }
        ],
        "@removed_2c864f3663934fc0be07dc61075cf258": {
          "#name": "id",
          "Description": "Id of the cluster",
          "Required": false,
          "Type": "string"
        },
        "@removed_5785021fc28a4493aa313fade15748fd": {
          "#name": "type",
          "Description": "Type of the resource",
          "Required": false,
          "Type": "string"
        },
        "@removed_35519515525c479386e5f43231dd7c7f": {
          "#name": "name",
          "Description": "Display name of the cluster",
          "Required": false,
          "Type": "string"
        }
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "spec": [
              {
                "#name": "cloud",
                "Description": {
                  "new": "The cloud service provider",
                  "old": "The cloud service provider "
                }
              }
            ]
          },
          {
            "status": [
              {
                "#name": "cku",
                "Description": {
                  "new": "The number of Confluent Kafka Units",
                  "old": "The number of Confluent Kafka Units "
                }
              }
            ]
          }
        ],
        "@removed_2289b6d4b644436194adacf5803187b5": {
          "#name": "id",
          "Description": "Id of the cluster",
          "Required": false,
          "Type": "string"
        },
        "@removed_157ecac611544147ae3804c79aed53a7": {
          "#name": "type",
          "Description": "Type of the resource",
          "Required": false,
          "Type": "string"
        },
        "@removed_6f7eb7ec1403407e9e9191cfcafd34ca": {
          "#name": "name",
          "Description": "Display name of the cluster",
          "Required": false,
          "Type": "string"
        }
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "spec": [
              {
                "#name": "cloud",
                "Description": {
                  "new": "The cloud service provider",
                  "old": "The cloud service provider "
                }
              }
            ]
          },
          {
            "status": [
              {
                "#name": "cku",
                "Description": {
                  "new": "The number of Confluent Kafka Units",
                  "old": "The number of Confluent Kafka Units "
                }
              }
            ]
          }
        ],
        "@removed_7865f7a9b4c2495bad2e6bad305a8e60": {
          "#name": "id",
          "Description": "Id of the cluster",
          "Required": false,
          "Type": "string"
        },
        "@removed_76453a605d5e491d84f93103af7f874f": {
          "#name": "type",
          "Description": "Type of the resource",
          "Required": false,
          "Type": "string"
        },
        "@removed_4a4a54ee9e084800a3e3b4294383f38c": {
          "#name": "name",
          "Description": "Display name of the cluster",
          "Required": false,
          "Type": "string"
        }
      }
    }
  }
}

⚼ 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 ,
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 ,
}
,
}
,
}
,
}

⚐ Response (200)

{
kind:
{
Description: Type of cluster ,
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 ,
}
,
}
,
}

⚐ Response (201)

{
kind:
{
Description: Type of cluster ,
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 ,
}
,
}
,
}

⚐ 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 (updated)
Description :  Delete confluent cluster by id
Reference :  Link ¶

⚶ Changes

{
  "#id": "Cluster_Delete",
  "$responses": {
    "202": [
      {
        "@added_0ed623d7530641ffb79794d15793ec3d": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ 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 ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ 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 (updated)
Description :  Lists all the connectors in a cluster
Reference :  Link ¶

⚶ Changes

{
  "#id": "Connector_List",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The ConnectorResource items on this page",
            "old": "List of connectors in a cluster of a confluent organization"
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "@removed_a385273706fd4d76b9b1245f11c6bada": {
                "#name": "name",
                "Description": "Display name of the connector",
                "Required": false,
                "Type": "string"
              }
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "URL to get the next set of connectors records if there are any."
          }
        }
      ]
    }
  }
}

⚼ 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: The ConnectorResource items on this page ,
Required: True ,
}
[
{
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: The link to the next page of items ,
Format: uri ,
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 ,
]
,
}
,
}
Connector_Get (updated)
Description :  Get confluent connector by Name
Reference :  Link ¶

⚶ Changes

{
  "#id": "Connector_Get",
  "$responses": {
    "200": {
      "$properties": {
        "@removed_ba1b9cb439284d528ab58b5571c56207": {
          "#name": "name",
          "Description": "Display name of the connector",
          "Required": false,
          "Type": "string"
        }
      }
    }
  }
}

⚼ 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)

{
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 (updated)
Description :  Create confluent connector by Name
Reference :  Link ¶

⚶ Changes

{
  "#id": "Connector_CreateOrUpdate",
  "$parameters": {
    "body": {
      "$properties": {
        "@removed_3cf27239c02546d182e0a8538d90102d": {
          "#name": "name",
          "Description": "Display name of the connector",
          "Required": false,
          "Type": "string"
        }
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "@removed_8b35c2a718d74ac381f381bc69c2a581": {
          "#name": "name",
          "Description": "Display name of the connector",
          "Required": false,
          "Type": "string"
        }
      }
    },
    "201": {
      "$properties": {
        "@removed_c7563f21f07943a782aa0df947d7debb": {
          "#name": "name",
          "Description": "Display name of the connector",
          "Required": false,
          "Type": "string"
        }
      }
    }
  }
}

⚼ 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 ,
}
{
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)

{
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)

{
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 (updated)
Description :  Delete confluent connector by name
Reference :  Link ¶

⚶ Changes

{
  "#id": "Connector_Delete",
  "$responses": {
    "202": [
      {
        "@added_14ed94cde89c48fe97c8d2ece5ab6518": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ 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 ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ 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_CreateAPIKey (updated)
Description :  Creates API key for a schema registry Cluster ID or Kafka Cluster ID under a environment
Reference :  Link ¶

⚶ Changes

{
  "#id": "Organization_CreateAPIKey",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "spec": [
              {
                "#name": "secret",
                "Description": {
                  "new": "API Key Secret",
                  "old": "API Key Secret "
                }
              },
              {
                "resource": [
                  {
                    "#name": "related",
                    "Description": {
                      "new": "API URL for accessing or modifying the api key resource object",
                      "old": "API URL for accessing or modifying the api key resource object "
                    }
                  }
                ]
              },
              {
                "owner": [
                  {
                    "#name": "related",
                    "Description": {
                      "new": "API URL for accessing or modifying the referred object",
                      "old": "API URL for accessing or modifying the referred object "
                    }
                  }
                ]
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ 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 ,
Format: password ,
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 ,
]
,
}
,
}
Topics_List (updated)
Description :  Lists of all the topics in a clusters
Reference :  Link ¶

⚶ Changes

{
  "#id": "Topics_List",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The TopicRecord items on this page",
            "old": "List of topics in a cluster of a confluent organization"
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "@removed_84bee1afa0304689ac6e311423105138": {
                "#name": "id",
                "Description": "The ARM Resource Id of the Topic",
                "Required": false,
                "Type": "string"
              },
              "@removed_c9947b9b81a74ccc96d6bb0c0e2077cc": {
                "#name": "name",
                "Description": "Display name of the topic",
                "Required": false,
                "Type": "string"
              },
              "@removed_d21bb22e197f4b64956e7e17f684bcdc": {
                "#name": "type",
                "Description": "The type of the resource.",
                "Required": false,
                "Type": "string"
              }
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "URL to get the next set of topics records if there are any."
          }
        }
      ]
    }
  }
}

⚼ 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: The TopicRecord items on this page ,
Required: True ,
}
[
{
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: The link to the next page of items ,
Format: uri ,
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 (updated)
Description :  Get confluent topic by Name
Reference :  Link ¶

⚶ Changes

{
  "#id": "Topics_Get",
  "$responses": {
    "200": {
      "$properties": {
        "@removed_a9f779ae797c49a3b28d4ca71777ed39": {
          "#name": "id",
          "Description": "The ARM Resource Id of the Topic",
          "Required": false,
          "Type": "string"
        },
        "@removed_c235cd839bd94dd08b086ce410b2534e": {
          "#name": "name",
          "Description": "Display name of the topic",
          "Required": false,
          "Type": "string"
        },
        "@removed_b6950a64e2004803afd3fa43b8e47f81": {
          "#name": "type",
          "Description": "The type of the resource.",
          "Required": false,
          "Type": "string"
        }
      }
    }
  }
}

⚼ 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)

{
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 (updated)
Description :  Create confluent topics by Name
Reference :  Link ¶

⚶ Changes

{
  "#id": "Topics_Create",
  "$parameters": {
    "body": {
      "$properties": {
        "@removed_c65952e69aa64fc0a4448f6ad7345cbd": {
          "#name": "id",
          "Description": "The ARM Resource Id of the Topic",
          "Required": false,
          "Type": "string"
        },
        "@removed_4e215ae214364c7db45e749f60a83f9b": {
          "#name": "name",
          "Description": "Display name of the topic",
          "Required": false,
          "Type": "string"
        },
        "@removed_6d0a4133102749d689047a460252f230": {
          "#name": "type",
          "Description": "The type of the resource.",
          "Required": false,
          "Type": "string"
        }
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "@removed_c3bf60594f3c416e894275cbfb89bcdc": {
          "#name": "id",
          "Description": "The ARM Resource Id of the Topic",
          "Required": false,
          "Type": "string"
        },
        "@removed_cd5930502a114f05bdac899d98c68fc1": {
          "#name": "name",
          "Description": "Display name of the topic",
          "Required": false,
          "Type": "string"
        },
        "@removed_37504dd1f7494a05a4e0a04b60cf0594": {
          "#name": "type",
          "Description": "The type of the resource.",
          "Required": false,
          "Type": "string"
        }
      }
    },
    "201": {
      "$properties": {
        "@removed_cd432f708e78425dba892a045c06be3d": {
          "#name": "id",
          "Description": "The ARM Resource Id of the Topic",
          "Required": false,
          "Type": "string"
        },
        "@removed_6e0c84ea7a6d4dafbf8e92627dd692e5": {
          "#name": "name",
          "Description": "Display name of the topic",
          "Required": false,
          "Type": "string"
        },
        "@removed_24a0d5f4e1c94f5d84412642bb836e9d": {
          "#name": "type",
          "Description": "The type of the resource.",
          "Required": false,
          "Type": "string"
        }
      }
    }
  }
}

⚼ 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 ,
}
{
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)

{
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)

{
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 (updated)
Description :  Delete confluent topic by name
Reference :  Link ¶

⚶ Changes

{
  "#id": "Topics_Delete",
  "$responses": {
    "202": [
      {
        "@added_1cd036f899e74a90a01ee8580f7ae0d1": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ 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 ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ 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_ListSchemaRegistryClusters (updated)
Description :  Get schema registry clusters
Reference :  Link ¶

⚶ Changes

{
  "#id": "Organization_ListSchemaRegistryClusters",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The SchemaRegistryClusterRecord items on this page",
            "old": "List of schema registry clusters in an environment of a confluent organization"
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "properties": [
                {
                  "spec": [
                    {
                      "#name": "cloud",
                      "Description": {
                        "new": "The cloud service provider",
                        "old": "The cloud service provider "
                      }
                    }
                  ]
                }
              ]
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "URL to get the next set of schema registry cluster records if there are any."
          }
        }
      ]
    }
  }
}

⚼ 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: The SchemaRegistryClusterRecord items on this page ,
Required: True ,
}
[
{
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: The link to the next page of items ,
Format: uri ,
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 (updated)
Description :  Get schema registry cluster by Id
Reference :  Link ¶

⚶ Changes

{
  "#id": "Organization_GetSchemaRegistryClusterById",
  "$parameters": [
    {
      "#name": "clusterId",
      "Description": {
        "new": "Confluent connector name",
        "old": "Confluent kafka or schema registry cluster id"
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "spec": [
              {
                "#name": "cloud",
                "Description": {
                  "new": "The cloud service provider",
                  "old": "The cloud service provider "
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ 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 connector name ,
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 ,
]
,
}
,
}
Validations_ValidateOrganization (updated)
Description :  Organization Validate proxy resource
Reference :  Link ¶

⚶ Changes

{
  "#id": "Validations_ValidateOrganization",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "Microsoft Azure subscription id"
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "Resource group name"
      }
    },
    {
      "body": {
        "$properties": {
          "@removed_118e6613d9b44c5ab38dac86c9c368fe": {
            "#name": "id",
            "Description": "The ARM id of the resource.",
            "Required": false,
            "Type": "string"
          },
          "@removed_5cabf5ef153943ba9ff47e6364535255": {
            "#name": "name",
            "Description": "The name of the resource.",
            "Required": false,
            "Type": "string"
          },
          "@removed_04585a305eee44058660afd92dee7f80": {
            "#name": "type",
            "Description": "The type of the resource.",
            "Required": false,
            "Type": "string"
          },
          "@removed_a3edd6f32cc84907b02cef78878a38bd": {
            "#name": "systemData",
            "Description": "Metadata pertaining to creation and last modification of the resource",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "createdBy",
                "Description": "The identity that created the resource.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "createdByType",
                "Description": "The type of identity that created the resource.",
                "Enum": [
                  [
                    "User",
                    ""
                  ],
                  [
                    "Application",
                    ""
                  ],
                  [
                    "ManagedIdentity",
                    ""
                  ],
                  [
                    "Key",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "createdAt",
                "Description": "The timestamp of resource creation (UTC).",
                "Format": "date-time",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "lastModifiedBy",
                "Description": "The identity that last modified the resource.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "lastModifiedByType",
                "Description": "The type of identity that last modified the resource.",
                "Enum": [
                  [
                    "User",
                    ""
                  ],
                  [
                    "Application",
                    ""
                  ],
                  [
                    "ManagedIdentity",
                    ""
                  ],
                  [
                    "Key",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "lastModifiedAt",
                "Description": "The timestamp of resource last modification (UTC)",
                "Format": "date-time",
                "Required": false,
                "Type": "string"
              }
            ]
          },
          "@removed_1c9a56678f5f457386807ac9155e66de": {
            "#name": "tags",
            "Description": "Organization resource tags",
            "Required": false,
            "Type": "object"
          },
          "@removed_632de532b7104bc6a6cd6b1ba8021583": {
            "#name": "location",
            "Description": "Location of Organization resource",
            "Required": false,
            "Type": "string"
          }
        }
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@removed_fadc98e0a53046d79a162ac3ec17412b": {
          "#name": "id",
          "Description": "The ARM id of the resource.",
          "Required": false,
          "Type": "string"
        },
        "@removed_b6f841ec5d1d4007944af04f6c3837ad": {
          "#name": "name",
          "Description": "The name of the resource.",
          "Required": false,
          "Type": "string"
        },
        "@removed_ac7d9ad1c3fb4b5f93aecc8e2c0ab338": {
          "#name": "type",
          "Description": "The type of the resource.",
          "Required": false,
          "Type": "string"
        },
        "@removed_c6fb9a8c1c9b4deeb7534bc25c9a9815": {
          "#name": "systemData",
          "Description": "Metadata pertaining to creation and last modification of the resource",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "createdBy",
              "Description": "The identity that created the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdByType",
              "Description": "The type of identity that created the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdAt",
              "Description": "The timestamp of resource creation (UTC).",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedBy",
              "Description": "The identity that last modified the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedByType",
              "Description": "The type of identity that last modified the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedAt",
              "Description": "The timestamp of resource last modification (UTC)",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            }
          ]
        },
        "@removed_4ebe4afc64204e42b16486d5043b53c3": {
          "#name": "tags",
          "Description": "Organization resource tags",
          "Required": false,
          "Type": "object"
        },
        "@removed_83e2bd6c6d3c419aa875a8fb7763da47": {
          "#name": "location",
          "Description": "Location of Organization resource",
          "Required": false,
          "Type": "string"
        }
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/validations/{organizationName}/orgvalidate
{
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: Organization resource model ,
Required: True ,
}
{
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 ,
Format: password ,
Required: True ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
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 ,
Format: password ,
Required: True ,
}
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 (updated)
Description :  Organization Validate proxy resource
Reference :  Link ¶

⚶ Changes

{
  "#id": "Validations_ValidateOrganizationV2",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "Microsoft Azure subscription id"
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "Resource group name"
      }
    },
    {
      "body": {
        "$properties": {
          "@removed_4e69e1c4eb6446e09f94937665f57601": {
            "#name": "id",
            "Description": "The ARM id of the resource.",
            "Required": false,
            "Type": "string"
          },
          "@removed_f3f42c57658d461db71d92e2c632f267": {
            "#name": "name",
            "Description": "The name of the resource.",
            "Required": false,
            "Type": "string"
          },
          "@removed_9664654e913642ed9f0027323be729b5": {
            "#name": "type",
            "Description": "The type of the resource.",
            "Required": false,
            "Type": "string"
          },
          "@removed_85538b75dee24b67a6cbe8536ec090a7": {
            "#name": "systemData",
            "Description": "Metadata pertaining to creation and last modification of the resource",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "createdBy",
                "Description": "The identity that created the resource.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "createdByType",
                "Description": "The type of identity that created the resource.",
                "Enum": [
                  [
                    "User",
                    ""
                  ],
                  [
                    "Application",
                    ""
                  ],
                  [
                    "ManagedIdentity",
                    ""
                  ],
                  [
                    "Key",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "createdAt",
                "Description": "The timestamp of resource creation (UTC).",
                "Format": "date-time",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "lastModifiedBy",
                "Description": "The identity that last modified the resource.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "lastModifiedByType",
                "Description": "The type of identity that last modified the resource.",
                "Enum": [
                  [
                    "User",
                    ""
                  ],
                  [
                    "Application",
                    ""
                  ],
                  [
                    "ManagedIdentity",
                    ""
                  ],
                  [
                    "Key",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "lastModifiedAt",
                "Description": "The timestamp of resource last modification (UTC)",
                "Format": "date-time",
                "Required": false,
                "Type": "string"
              }
            ]
          },
          "@removed_c05e37b12327461a95c2e482efac305f": {
            "#name": "tags",
            "Description": "Organization resource tags",
            "Required": false,
            "Type": "object"
          },
          "@removed_9ccace9fd44e4e36bf0a4c019ba8a889": {
            "#name": "location",
            "Description": "Location of Organization resource",
            "Required": false,
            "Type": "string"
          }
        }
      }
    }
  ]
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/validations/{organizationName}/orgvalidateV2
{
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: Organization resource model ,
Required: True ,
}
{
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 ,
Format: password ,
Required: True ,
}
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 ,
]
,
}
,
}