swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector Clusters API schemes: - https tags: - name: Clusters paths: ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedVMwarevSphere/clusters/{clusterName} : put: tags: - Clusters operationId: microsoftAzureClustersCreate description: Create Or Update cluster. summary: Microsoft Azure Implements Cluster Put Method x-ms-examples: CreateCluster: $ref: ./examples/CreateCluster.json consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - in: path name: clusterName required: true type: string description: Name of the cluster. - $ref: '#/parameters/api-version' - in: body name: body description: Request payload. schema: $ref: '#/definitions/Cluster' responses: '200': description: Arm resource update successful. schema: $ref: '#/definitions/Cluster' '201': description: Created schema: $ref: '#/definitions/Cluster' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation get: tags: - Clusters operationId: microsoftAzureClustersGet summary: Microsoft Azure Gets A Cluster description: Implements cluster GET method. x-ms-examples: GetCluster: $ref: ./examples/GetCluster.json produces: - application/json parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - in: path name: clusterName description: Name of the cluster. required: true type: string - $ref: '#/parameters/api-version' responses: '200': description: Success schema: $ref: '#/definitions/Cluster' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse patch: tags: - Clusters operationId: microsoftAzureClustersUpdate summary: Microsoft Azure Updates A Cluster description: API to update certain properties of the cluster resource. x-ms-examples: UpdateCluster: $ref: ./examples/UpdateCluster.json consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - in: path name: clusterName required: true type: string description: Name of the cluster. - $ref: '#/parameters/api-version' - in: body name: body description: Resource properties to update. schema: $ref: '#/definitions/ResourcePatch' responses: '200': description: Arm resource update successful. schema: $ref: '#/definitions/Cluster' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse delete: tags: - Clusters operationId: microsoftAzureClustersDelete summary: Microsoft Azure Deletes An Cluster description: Implements cluster DELETE method. x-ms-examples: DeleteCluster: $ref: ./examples/DeleteCluster.json produces: - application/json parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - in: path name: clusterName description: Name of the cluster. required: true type: string - $ref: '#/parameters/api-version' - in: query name: force description: Whether force delete was specified. required: false type: boolean responses: '200': description: Success '202': description: Accepted headers: Location: type: string '204': description: No Content default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true /subscriptions/{subscriptionId}/providers/Microsoft.ConnectedVMwarevSphere/clusters: get: tags: - Clusters operationId: microsoftAzureClustersList summary: Microsoft Azure Implements Get Clusters In A Subscription description: List of clusters in a subscription. x-ms-examples: ListClusters: $ref: ./examples/ListClusters.json produces: - application/json parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/api-version' responses: '200': description: Success schema: $ref: '#/definitions/ClustersList' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedVMwarevSphere/clusters: get: tags: - Clusters operationId: microsoftAzureClustersListbyresourcegroup summary: Microsoft Azure Implements Get Clusters In A Resource Group description: List of clusters in a resource group. x-ms-examples: ListClustersByResourceGroup: $ref: ./examples/ListClustersByResourceGroup.json produces: - application/json parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - $ref: '#/parameters/api-version' responses: '200': description: Success schema: $ref: '#/definitions/ClustersList' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink /subscriptions/{subscriptionId}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2: get: tags: - Clusters operationId: microsoftAzureClustersList x-ms-examples: List all the clusters: $ref: ./examples/ClusterList.json description: Lists all clusters in a subscription. parameters: - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter responses: '200': description: OK schema: $ref: '#/definitions/ClusterListResult' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Dbforpostgresql Servergroupsv2 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2: get: tags: - Clusters operationId: microsoftAzureClustersListbyresourcegroup x-ms-examples: List the clusters by resource group: $ref: ./examples/ClusterListByResourceGroup.json description: Lists all clusters in a resource group. parameters: - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter responses: '200': description: OK schema: $ref: '#/definitions/ClusterListResult' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dbforpostgresql Servergroupsv2 ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName} : put: description: Creates a new cluster with servers. tags: - Clusters operationId: microsoftAzureClustersCreate x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation x-ms-examples: Create a new single node cluster: $ref: ./examples/ClusterCreateSingleNode.json Create a new multi-node cluster: $ref: ./examples/ClusterCreateMultiNode.json Create a new single node Burstable 1 vCore cluster: $ref: ./examples/ClusterCreateBurstablev1.json Create a new single node Burstable 2 vCores cluster: $ref: ./examples/ClusterCreateBurstablev2.json Create a new cluster as a point in time restore: $ref: ./examples/ClusterCreatePITR.json Create a new cluster as a read replica: $ref: ./examples/ClusterCreateReadReplica.json parameters: - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ClusterNameParameter' - name: parameters in: body required: true schema: $ref: '#/definitions/Cluster_2' description: The required parameters for creating or updating a cluster. responses: '200': description: OK schema: $ref: '#/definitions/Cluster_2' '201': description: Created headers: location: type: string azure-async-operation: type: string schema: $ref: '#/definitions/Cluster_2' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dbforpostgresql Servergroupsv2 Clustername get: description: Gets information about a cluster such as compute and storage configuration and cluster lifecycle metadata such as cluster creation date and time. tags: - Clusters operationId: microsoftAzureClustersGet x-ms-examples: Get the cluster: $ref: ./examples/ClusterGet.json parameters: - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ClusterNameParameter' responses: '200': description: OK schema: $ref: '#/definitions/Cluster_2' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dbforpostgresql Servergroupsv2 Clustername delete: description: Deletes a cluster together with servers in it. tags: - Clusters operationId: microsoftAzureClustersDelete x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location x-ms-examples: Delete the cluster: $ref: ./examples/ClusterDelete.json parameters: - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ClusterNameParameter' responses: '200': description: OK '202': description: Accepted headers: location: type: string azure-async-operation: type: string '204': description: NoContent default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dbforpostgresql Servergroupsv2 Clustername patch: description: Updates an existing cluster. The request body can contain one or several properties from the cluster definition. tags: - Clusters operationId: microsoftAzureClustersUpdate x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location x-ms-examples: Update multiple configuration settings of the cluster: $ref: ./examples/ClusterUpdate.json Scale compute up or down: $ref: ./examples/ClusterScaleCompute.json Scale up storage: $ref: ./examples/ClusterScaleStorage.json 'Scale out: Add new worker nodes': $ref: ./examples/ClusterAddNode.json Update or define maintenance window: $ref: ./examples/ClusterUpdateMaintenanceWindow.json parameters: - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ClusterNameParameter' - name: parameters in: body required: true schema: $ref: '#/definitions/ClusterForUpdate' description: The parameters for updating a cluster. responses: '200': description: OK schema: $ref: '#/definitions/Cluster_2' '202': description: Accepted headers: location: type: string azure-async-operation: type: string schema: $ref: '#/definitions/Cluster_2' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dbforpostgresql Servergroupsv2 Clustername /subscriptions/{subscriptionId}/providers/Microsoft.DBforPostgreSQL/checkNameAvailability: post: description: Checks availability of a cluster name. Cluster names should be globally unique; at least 3 characters and at most 40 characters long; they must only contain lowercase letters, numbers, and hyphens; and must not start or end with a hyphen. tags: - Clusters operationId: microsoftAzureClustersChecknameavailability x-ms-examples: Check name availability: $ref: ./examples/CheckNameAvailability.json parameters: - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter - name: nameAvailabilityRequest in: body required: true schema: $ref: '#/definitions/NameAvailabilityRequest' description: The required parameters for checking if cluster name is available. responses: '200': description: OK schema: $ref: '#/definitions/NameAvailability' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Dbforpostgresql Checknameavailability ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters : get: operationId: microsoftAzureClustersList x-ms-pageable: nextLinkName: nextLink tags: - Clusters summary: Microsoft Azure List Clusters In A Private Cloud parameters: - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/privateCloudName' - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter responses: '200': description: successful operation schema: $ref: '#/definitions/ClusterList' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/CloudError' x-ms-examples: Clusters_List: $ref: ./examples/Clusters_List.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName} : get: operationId: microsoftAzureClustersGet tags: - Clusters summary: Microsoft Azure Get A Cluster By Name In A Private Cloud parameters: - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/privateCloudName' - $ref: '#/parameters/clusterName' - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter responses: '200': description: successful operation schema: $ref: '#/definitions/Cluster_3' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/CloudError' x-ms-examples: Clusters_Get: $ref: ./examples/Clusters_Get.json description: Needs a more full description created. put: operationId: microsoftAzureClustersCreateorupdate x-ms-long-running-operation: true tags: - Clusters summary: Microsoft Azure Create Or Update A Cluster In A Private Cloud parameters: - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - name: privateCloudName in: path required: true type: string description: The name of the private cloud. - $ref: '#/parameters/clusterName' - name: cluster description: A cluster in the private cloud in: body required: true schema: $ref: '#/definitions/Cluster_3' - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter responses: '200': description: successful operation schema: $ref: '#/definitions/Cluster_3' '201': description: accepted operation schema: $ref: '#/definitions/Cluster_3' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/CloudError' x-ms-examples: Clusters_CreateOrUpdate: $ref: ./examples/Clusters_CreateOrUpdate.json description: Needs a more full description created. patch: operationId: microsoftAzureClustersUpdate x-ms-long-running-operation: true tags: - Clusters summary: Microsoft Azure Update A Cluster In A Private Cloud parameters: - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/privateCloudName' - $ref: '#/parameters/clusterName' - name: clusterUpdate description: The cluster properties to be updated in: body required: true schema: $ref: '#/definitions/ClusterUpdate' - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter responses: '200': description: successful operation schema: $ref: '#/definitions/Cluster_3' '201': description: accepted operation schema: $ref: '#/definitions/Cluster_3' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/CloudError' x-ms-examples: Clusters_Update: $ref: ./examples/Clusters_Update.json description: Needs a more full description created. delete: operationId: microsoftAzureClustersDelete x-ms-long-running-operation: true tags: - Clusters summary: Microsoft Azure Delete A Cluster In A Private Cloud parameters: - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/privateCloudName' - $ref: '#/parameters/clusterName' - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter responses: '200': description: OK. The delete has succeeded '202': description: Accepted. The delete will complete asynchronously '204': description: No Content. No cluster to delete default: description: Error response describing why the operation failed schema: $ref: '#/definitions/CloudError' x-ms-examples: Clusters_Delete: $ref: ./examples/Clusters_Delete.json description: Needs a more full description created. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}: get: tags: - Clusters operationId: microsoftAzureClustersGet x-ms-examples: KustoClustersGet: $ref: ./examples/KustoClustersGet.json description: Gets a Kusto cluster. parameters: - $ref: '#/parameters/ResourceGroupParameter' - $ref: '#/parameters/ClusterNameParameter_2' - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: The Kusto cluster. schema: $ref: '#/definitions/Cluster_4' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError_2' summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Kusto Clusters Clustername put: tags: - Clusters operationId: microsoftAzureClustersCreateorupdate x-ms-examples: KustoClustersCreateOrUpdate: $ref: ./examples/KustoClustersCreateOrUpdate.json x-ms-long-running-operation: true description: Create or update a Kusto cluster. parameters: - $ref: '#/parameters/ResourceGroupParameter' - $ref: '#/parameters/ClusterNameParameter_2' - name: parameters in: body required: true schema: $ref: '#/definitions/Cluster_4' description: The Kusto cluster parameters supplied to the CreateOrUpdate operation. - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: Successfully updated the Cluster. schema: $ref: '#/definitions/Cluster_4' '201': description: Successfully created the cluster. schema: $ref: '#/definitions/Cluster_4' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError_2' summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Kusto Clusters Clustername patch: tags: - Clusters operationId: microsoftAzureClustersUpdate x-ms-examples: KustoClustersUpdate: $ref: ./examples/KustoClustersUpdate.json x-ms-long-running-operation: true description: Update a Kusto cluster. parameters: - $ref: '#/parameters/ResourceGroupParameter' - $ref: '#/parameters/ClusterNameParameter_2' - name: parameters in: body required: true schema: $ref: '#/definitions/ClusterUpdate_2' description: The Kusto cluster parameters supplied to the Update operation. - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: Successfully updated the Cluster. schema: $ref: '#/definitions/Cluster_4' '201': description: Successfully updated the cluster. schema: $ref: '#/definitions/Cluster_4' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError_2' summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Kusto Clusters Clustername delete: tags: - Clusters operationId: microsoftAzureClustersDelete x-ms-examples: KustoClustersDelete: $ref: ./examples/KustoClustersDelete.json x-ms-long-running-operation: true description: Deletes a Kusto cluster. parameters: - $ref: '#/parameters/ResourceGroupParameter' - $ref: '#/parameters/ClusterNameParameter_2' - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: OK -- cluster deleted successfully. '202': description: Accepted the delete cluster request. '204': description: NoContent -- cluster does not exist in the subscription. default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError_2' summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Kusto Clusters Clustername /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/stop: post: tags: - Clusters operationId: microsoftAzureClustersStop x-ms-examples: KustoClustersStop: $ref: ./examples/KustoClustersStop.json x-ms-long-running-operation: true description: Stops a Kusto cluster. parameters: - $ref: '#/parameters/ResourceGroupParameter' - $ref: '#/parameters/ClusterNameParameter_2' - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: OK. '202': description: Accepted default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError_2' summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Kusto Clusters Clustername Stop /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/start: post: tags: - Clusters operationId: microsoftAzureClustersStart x-ms-examples: KustoClustersStart: $ref: ./examples/KustoClustersStart.json x-ms-long-running-operation: true description: Starts a Kusto cluster. parameters: - $ref: '#/parameters/ResourceGroupParameter' - $ref: '#/parameters/ClusterNameParameter_2' - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: OK. '202': description: Accepted. default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError_2' summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Kusto Clusters Clustername Start /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters: get: tags: - Clusters operationId: microsoftAzureClustersListbyresourcegroup x-ms-examples: KustoClustersListByResourceGroup: $ref: ./examples/KustoClustersListByResourceGroup.json description: Lists all Kusto clusters within a resource group. parameters: - $ref: '#/parameters/ResourceGroupParameter' - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: OK. schema: $ref: '#/definitions/ClusterListResult_2' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError_2' x-ms-pageable: nextLinkName: null summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Kusto Clusters /subscriptions/{subscriptionId}/providers/Microsoft.Kusto/clusters: get: tags: - Clusters operationId: microsoftAzureClustersList x-ms-examples: KustoClustersList: $ref: ./examples/KustoClustersList.json description: Lists all Kusto clusters within a subscription. parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: OK. schema: $ref: '#/definitions/ClusterListResult_2' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError_2' x-ms-pageable: nextLinkName: null summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Kusto Clusters /subscriptions/{subscriptionId}/providers/Microsoft.Kusto/locations/{location}/checkNameAvailability: post: tags: - Clusters operationId: microsoftAzureClustersChecknameavailability x-ms-examples: KustoClustersCheckNameAvailability: $ref: ./examples/KustoClustersCheckNameAvailability.json description: Checks that the cluster name is valid and is not already in use. parameters: - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' - name: location in: path description: Azure location. required: true type: string - name: clusterName in: body required: true schema: $ref: '#/definitions/ClusterCheckNameRequest' description: The name of the cluster. responses: '200': description: OK -- Operation to check the kusto resource name availability was successful. schema: $ref: '#/definitions/CheckNameResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError_2' summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Kusto Locations Location Checknameavailability /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/skus: get: tags: - Clusters operationId: microsoftAzureClustersListskusbyresource x-ms-examples: KustoClustersListResourceSkus: $ref: ./examples/KustoClustersListResourceSkus.json description: Returns the SKUs available for the provided resource. parameters: - $ref: '#/parameters/ResourceGroupParameter' - $ref: '#/parameters/ClusterNameParameter_2' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK. schema: $ref: '#/definitions/ListResourceSkusResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError_2' x-ms-pageable: nextLinkName: null summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Kusto Clusters Clustername Skus definitions: PrivateEndpointConnectionSimpleProperties: description: The properties in private endpoint connection type: object properties: privateEndpoint: $ref: '#/definitions/PrivateEndpointProperty' description: Private endpoint which the connection belongs to. groupIds: type: array description: Group ids of the private endpoint connection. items: type: string privateLinkServiceConnectionState: $ref: ../../../../../common-types/resource-management/v4/privatelinks.json#/definitions/PrivateLinkServiceConnectionState ClusterForUpdate: description: Represents a cluster for update. type: object properties: properties: $ref: '#/definitions/ClusterPropertiesForUpdate' x-ms-client-flatten: true description: Properties of the cluster. tags: type: object additionalProperties: type: string description: Application-specific metadata in the form of key-value pairs. ClusterUpdateProperties: description: The properties of a cluster that may be updated properties: clusterSize: description: The cluster size type: integer format: int32 ClusterProperties_3: description: The properties of a cluster allOf: - $ref: '#/definitions/CommonClusterProperties' properties: {} Sku: description: The resource model definition representing SKU properties: name: type: string description: The name of the SKU. required: - name CloudErrorBody: x-ms-external: true properties: code: type: string description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. message: type: string description: A message describing the error, intended to be suitable for displaying in a user interface. target: type: string description: The target of the particular error. For example, the name of the property in error. details: type: array items: $ref: '#/definitions/CloudErrorBody' description: A list of additional details about the error. description: An error response from Kusto. MaintenanceWindow: type: object description: Schedule settings for regular cluster updates. properties: customWindow: type: string description: Indicates whether custom maintenance window is enabled or not. startHour: type: integer format: int32 description: Start hour within preferred day of the week for maintenance window. startMinute: type: integer format: int32 description: Start minute within the start hour for maintenance window. dayOfWeek: type: integer format: int32 description: Preferred day of the week for maintenance window. ExtendedLocation: type: object description: The extended location. properties: type: type: string description: The extended location type. name: type: string description: The extended location name. Cluster_4: required: - sku properties: etag: readOnly: true type: string description: An ETag of the resource created. sku: $ref: '#/definitions/AzureSku' description: The SKU of the cluster. properties: x-ms-client-flatten: true $ref: '#/definitions/ClusterProperties_4' allOf: - $ref: ../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource description: Class representing a Kusto cluster. TrustedExternalTenant: properties: value: type: string description: GUID representing an external tenant. AzureCapacity: type: object required: - minimum - maximum - default - scaleType properties: scaleType: description: Scale type. type: string enum: - automatic - manual - none x-ms-enum: name: AzureScaleType modelAsString: true minimum: description: Minimum allowed capacity. type: integer maximum: description: Maximum allowed capacity. type: integer default: description: The default capacity that would be used. type: integer ClusterUpdate: description: An update of a cluster resource properties: properties: description: The properties of a cluster resource that may be updated $ref: '#/definitions/ClusterUpdateProperties' x-ms-client-flatten: true NameAvailabilityRequest: description: Request from client to check cluster name availability. type: object properties: name: type: string description: Cluster name to verify. type: type: string enum: - Microsoft.DBforPostgreSQL/serverGroupsv2 description: Resource type used for verification. x-ms-enum: name: CheckNameAvailabilityResourceType modelAsString: false required: - name - type ResourceProvisioningState: type: string description: The current deployment state of resource. enum: - Succeeded - Failed - Canceled - Provisioning - Updating - Deleting - Accepted - Created x-ms-enum: name: ProvisioningState modelAsString: true CheckNameResult: type: object properties: nameAvailable: type: boolean description: Specifies a Boolean value that indicates if the name is available. name: type: string description: The name that was checked. message: type: string description: Message indicating an unavailable name due to a conflict, or a description of the naming rules that are violated. ClusterUpdate_2: properties: tags: type: object additionalProperties: type: string x-ms-mutability: - read - create - update description: Resource tags. location: type: string description: Resource location. etag: readOnly: true type: string description: An ETag of the resource updated. sku: $ref: '#/definitions/AzureSku' description: The SKU of the cluster. properties: x-ms-client-flatten: true $ref: '#/definitions/ClusterProperties_4' allOf: - $ref: ../../../../../common-types/resource-management/v1/types.json#/definitions/Resource description: Class representing an update to a Kusto cluster. Resource: description: The core properties of ARM resources properties: id: description: Resource ID. readOnly: true type: string name: description: Resource name. readOnly: true type: string type: description: Resource type. readOnly: true type: string x-ms-azure-resource: true NameAvailability: description: Represents cluster name availability. type: object properties: message: type: string description: Error message. nameAvailable: type: boolean description: Indicates whether the cluster name is available. name: type: string description: Name of the cluster. type: type: string description: Type of the cluster. ClusterListResult_2: properties: value: type: array items: $ref: '#/definitions/Cluster_4' description: The list of Kusto clusters. description: The list Kusto clusters operation response. ClusterProperties_2: description: Properties of the cluster. type: object properties: administratorLogin: type: string description: The administrator's login name of the servers in the cluster. readOnly: true administratorLoginPassword: type: string x-ms-secret: true format: password x-ms-mutability: - create - update description: The password of the administrator login. Required for creation. provisioningState: type: string description: Provisioning state of the cluster readOnly: true state: type: string description: A state of a cluster/server that is visible to user. readOnly: true postgresqlVersion: type: string description: The major PostgreSQL version on all cluster servers. citusVersion: type: string description: The Citus extension version on all cluster servers. maintenanceWindow: $ref: '#/definitions/MaintenanceWindow' description: Maintenance window of a cluster. preferredPrimaryZone: type: string description: Preferred primary availability zone (AZ) for all cluster servers. enableShardsOnCoordinator: type: boolean description: If distributed tables are placed on coordinator or not. Should be set to 'true' on single node clusters. Requires shard rebalancing after value is changed. enableHa: type: boolean description: If high availability (HA) is enabled or not for the cluster. coordinatorServerEdition: type: string description: 'The edition of a coordinator server (default: GeneralPurpose). Required for creation.' coordinatorStorageQuotaInMb: type: integer format: int32 description: The storage of a server in MB. Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. coordinatorVCores: type: integer format: int32 description: 'The vCores count of a server (max: 96). Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.' coordinatorEnablePublicIpAccess: type: boolean description: If public access is enabled on coordinator. nodeServerEdition: type: string description: 'The edition of a node server (default: MemoryOptimized).' nodeCount: type: integer format: int32 description: Worker node count of the cluster. When node count is 0, it represents a single node configuration with the ability to create distributed tables on that node. 2 or more worker nodes represent multi-node configuration. Node count value cannot be 1. Required for creation. nodeStorageQuotaInMb: type: integer format: int32 description: The storage in MB on each worker node. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. nodeVCores: type: integer format: int32 description: 'The compute in vCores on each worker node (max: 104). See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.' nodeEnablePublicIpAccess: type: boolean description: If public access is enabled on worker nodes. serverNames: type: array description: The list of server names in the cluster items: $ref: '#/definitions/ServerNameItem' x-ms-identifiers: - name readOnly: true uniqueItems: true sourceResourceId: type: string description: The resource id of source cluster for read replica clusters. sourceLocation: type: string description: The Azure region of source cluster for read replica clusters. pointInTimeUTC: type: string format: date-time description: Date and time in UTC (ISO8601 format) for cluster restore. readReplicas: type: array description: The array of read replica clusters. items: type: string readOnly: true uniqueItems: true earliestRestoreTime: type: string format: date-time description: The earliest restore point time (ISO8601 format) for the cluster. readOnly: true privateEndpointConnections: description: The private endpoint connections for a cluster. type: array items: $ref: '#/definitions/SimplePrivateEndpointConnection' readOnly: true databaseName: type: string description: The database name of the cluster. Only one database per cluster is supported. enableGeoBackup: type: boolean description: If cluster backup is stored in another Azure region in addition to the copy of the backup stored in the cluster's region. Enabled only at the time of cluster creation. authConfig: $ref: '#/definitions/AuthConfig' description: Authentication configuration of a cluster. Cluster: description: Define the cluster. required: - location - properties type: object x-ms-azure-resource: true properties: properties: x-ms-client-flatten: true description: Resource properties. $ref: '#/definitions/ClusterProperties' location: description: Gets or sets the location. type: string x-ms-mutability: - read - create extendedLocation: $ref: '#/definitions/ExtendedLocation' description: Gets or sets the extended location. systemData: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData description: The system data. tags: description: Gets or sets the Resource tags. type: object additionalProperties: type: string name: description: Gets or sets the name. type: string readOnly: true id: description: Gets or sets the Id. type: string readOnly: true type: description: Gets or sets the type of the resource. type: string readOnly: true kind: type: string description: Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value. SimplePrivateEndpointConnection: description: A private endpoint connection. type: object allOf: - $ref: ../../../../../common-types/resource-management/v4/types.json#/definitions/ProxyResource properties: properties: $ref: '#/definitions/PrivateEndpointConnectionSimpleProperties' x-ms-client-flatten: true description: Properties of the private endpoint connection. ResourceStatus: description: The resource status information. type: object properties: type: description: The type of the condition. type: string readOnly: true status: description: Status of the condition. type: string readOnly: true reason: description: The reason for the condition's status. type: string readOnly: true message: description: A human readable message indicating details about the status. type: string readOnly: true severity: description: Severity with which to treat failures of this type of condition. type: string readOnly: true lastUpdatedAt: description: The last update time for this condition. type: string format: date-time readOnly: true ClusterListResult: type: object properties: value: type: array items: $ref: '#/definitions/Cluster_2' description: The list of clusters nextLink: description: The link used to get the next page of cluster list. type: string readOnly: true description: A list of clusters. ClusterProperties: description: Describes the properties of a Cluster. type: object properties: uuid: description: Gets or sets a unique identifier for this resource. type: string readOnly: true vCenterId: description: Gets or sets the ARM Id of the vCenter resource in which this cluster resides. type: string moRefId: description: Gets or sets the vCenter MoRef (Managed Object Reference) ID for the cluster. type: string inventoryItemId: description: Gets or sets the inventory Item ID for the cluster. type: string moName: description: Gets or sets the vCenter Managed Object name for the cluster. type: string readOnly: true statuses: description: The resource status information. readOnly: true type: array items: $ref: '#/definitions/ResourceStatus' x-ms-identifiers: - type customResourceName: description: Gets the name of the corresponding resource in Kubernetes. type: string readOnly: true usedMemoryGB: format: int64 description: Gets the used physical memory on the cluster in GB. type: integer readOnly: true totalMemoryGB: format: int64 description: Gets the total amount of physical memory on the cluster in GB. type: integer readOnly: true usedCpuMHz: format: int64 description: Gets the used CPU usage across all cores on the cluster in MHz. type: integer readOnly: true totalCpuMHz: format: int64 description: Gets the max CPU usage across all cores on the cluster in MHz. type: integer readOnly: true datastoreIds: description: Gets the datastore ARM ids. type: array items: type: string readOnly: true networkIds: description: Gets the network ARM ids. type: array items: type: string readOnly: true provisioningState: $ref: '#/definitions/ResourceProvisioningState' description: Gets the provisioning state. readOnly: true AzureResourceSku: properties: resourceType: type: string description: Resource Namespace and Type. sku: $ref: '#/definitions/AzureSku' description: The SKU details. capacity: $ref: '#/definitions/AzureCapacity' description: The SKU capacity. ServerNameItem: description: The name object for a server. type: object properties: name: type: string description: The name of a server. fullyQualifiedDomainName: type: string description: The fully qualified domain name of a server. readOnly: true ClusterProperties_4: properties: state: type: string readOnly: true description: The state of the resource. enum: - Creating - Unavailable - Running - Deleting - Deleted - Stopping - Stopped - Starting x-ms-enum: name: State modelAsString: true provisioningState: type: string readOnly: true description: The provisioned state of the resource. enum: - Running - Creating - Deleting - Succeeded - Failed x-ms-enum: name: ProvisioningState modelAsString: true uri: type: string readOnly: true description: The cluster URI. dataIngestionUri: type: string readOnly: true description: The cluster data ingestion URI. trustedExternalTenants: type: array items: $ref: '#/definitions/TrustedExternalTenant' description: The cluster's external tenants. description: Class representing the Kusto cluster properties. Cluster_2: description: Represents a cluster. type: object properties: properties: $ref: '#/definitions/ClusterProperties_2' x-ms-client-flatten: true description: Properties of the cluster. allOf: - $ref: ../../../../../common-types/resource-management/v4/types.json#/definitions/TrackedResource ClusterCheckNameRequest: type: object properties: name: type: string description: Cluster name. type: type: string enum: - Microsoft.Kusto/clusters x-ms-enum: name: Type modelAsString: false description: The type of resource, Microsoft.Kusto/clusters. required: - name - type Cluster_3: description: A cluster resource required: - sku allOf: - $ref: '#/definitions/Resource' properties: sku: description: The cluster SKU $ref: '#/definitions/Sku' properties: description: The properties of a cluster resource $ref: '#/definitions/ClusterProperties_3' x-ms-client-flatten: true ClusterPropertiesForUpdate: description: The properties used to update a cluster. type: object properties: administratorLoginPassword: type: string x-ms-secret: true format: password x-ms-mutability: - create - update description: The password of the administrator login. Each cluster is created with pre-defined administrative role called ‘citus’.  postgresqlVersion: type: string description: The major PostgreSQL version on all cluster servers. citusVersion: type: string description: The Citus extension version on all cluster servers. enableShardsOnCoordinator: type: boolean description: If distributed tables are placed on coordinator or not. Should be set to 'true' on single node clusters. Requires shard rebalancing after value is changed. enableHa: type: boolean description: If high availability (HA) is enabled or not for the cluster. preferredPrimaryZone: type: string description: Preferred primary availability zone (AZ) for all cluster servers. coordinatorServerEdition: type: string description: 'The edition of the coordinator (default: GeneralPurpose).' coordinatorStorageQuotaInMb: type: integer format: int32 description: The storage of the coordinator in MB. coordinatorVCores: type: integer format: int32 description: 'The vCores count of the coordinator (max: 96).' coordinatorEnablePublicIpAccess: type: boolean description: If public access is enabled on coordinator. nodeServerEdition: type: string description: 'The edition of a node (default: MemoryOptimized).' nodeCount: type: integer format: int32 description: Worker node count of the cluster. When node count is 0, it represents a single node configuration with the ability to create distributed tables on that node. 2 or more worker nodes represent multi-node configuration. Node count value cannot be 1. nodeStorageQuotaInMb: type: integer format: int32 description: The storage in MB on each worker node. nodeVCores: type: integer format: int32 description: 'The compute in vCores on each worker node (max: 104).' nodeEnablePublicIpAccess: type: boolean description: If public access is enabled on worker nodes. readOnly: true maintenanceWindow: $ref: '#/definitions/MaintenanceWindow' description: Maintenance window of a cluster. AuthConfig: type: object description: Authentication configuration of a cluster. properties: activeDirectoryAuth: type: string enum: - enabled - disabled x-ms-enum: name: ActiveDirectoryAuth modelAsString: true passwordAuth: type: string enum: - enabled - disabled x-ms-enum: name: PasswordAuth modelAsString: true AzureSku: type: object required: - name - tier properties: name: description: SKU name. type: string enum: - KC8 - KC16 - KS8 - KS16 - D13_v2 - D14_v2 - L8 - L16 x-ms-enum: name: AzureSkuName modelAsString: true capacity: description: SKU capacity. type: integer tier: description: SKU tier. type: string enum: - Standard x-ms-enum: name: AzureSkuTier modelAsString: true PrivateEndpointProperty: type: object description: Property to represent resource id of the private endpoint. properties: id: type: string description: Resource id of the private endpoint. ResourcePatch: type: object properties: tags: type: object additionalProperties: type: string description: Resource tags. description: Object containing updates for patch operations. ListResourceSkusResult: description: List of available SKUs for an existing Kusto Cluster. type: object properties: value: type: array items: $ref: '#/definitions/AzureResourceSku' description: The collection of available SKUs for an existing resource. CloudError: x-ms-external: true properties: error: description: An error returned by the API $ref: ../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse description: API error response ClusterList: description: A paged list of clusters properties: value: description: The items on a page type: array readOnly: true items: $ref: '#/definitions/Cluster_3' nextLink: description: URL to get the next page if any type: string readOnly: true ClustersList: description: List of Clusters. type: object properties: nextLink: description: Url to follow for getting next page of Clusters. type: string value: description: Array of Clusters type: array items: $ref: '#/definitions/Cluster' required: - value CommonClusterProperties: description: The common properties of a cluster properties: provisioningState: description: The state of the cluster provisioning type: string readOnly: true enum: - Succeeded - Failed - Cancelled - Deleting - Updating x-ms-enum: name: ClusterProvisioningState modelAsString: true clusterSize: description: The cluster size type: integer format: int32 clusterId: description: The identity type: integer format: int32 readOnly: true hosts: description: The hosts type: array readOnly: true items: type: string CloudError_2: x-ms-external: true properties: error: $ref: '#/definitions/CloudErrorBody' description: An error response from Kusto. parameters: ApiVersionParameter: name: api-version in: query required: true type: string description: Client API Version. clusterName: name: clusterName in: path required: true type: string description: Name of the cluster in the private cloud x-ms-parameter-location: method resourceGroupName: in: path name: resourceGroupName description: The Resource Group Name. required: true type: string x-ms-parameter-location: method api-version: in: query name: api-version description: Client Api Version. required: true type: string SubscriptionIdParameter: name: subscriptionId in: path required: true type: string description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. subscriptionId: in: path name: subscriptionId description: The Subscription ID. required: true type: string ResourceGroupParameter: name: resourceGroupName in: path description: The name of the resource group containing the Kusto cluster. required: true type: string x-ms-parameter-location: method ClusterNameParameter_2: name: clusterName in: path description: The name of the Kusto cluster. required: true type: string x-ms-parameter-location: method ClusterNameParameter: name: clusterName in: path required: true type: string description: The name of the cluster. pattern: ^(?![0-9]+$)(?!-)[a-z0-9-]{3,40}(?