{ "swagger": "2.0", "info": { "title": "KustoManagementClient", "version": "2025-02-14", "description": "The Azure Kusto management API provides a RESTful set of web services that interact with Azure Kusto services to manage your clusters and databases. The API enables you to create, update, and delete clusters and databases.", "x-typespec-generated": [ { "emitter": "@azure-tools/typespec-autorest" } ] }, "schemes": [ "https" ], "host": "management.azure.com", "produces": [ "application/json" ], "consumes": [ "application/json" ], "security": [ { "azure_auth": [ "user_impersonation" ] } ], "securityDefinitions": { "azure_auth": { "type": "oauth2", "description": "Azure Active Directory OAuth2 Flow.", "flow": "implicit", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "scopes": { "user_impersonation": "impersonate your user account" } } }, "tags": [ { "name": "Operations" }, { "name": "ClusterPrincipalAssignments" }, { "name": "DatabasePrincipalAssignments" }, { "name": "Scripts" }, { "name": "scripts" }, { "name": "DataConnections" }, { "name": "Databases" }, { "name": "AttachedDatabaseConfigurations" }, { "name": "ManagedPrivateEndpoints" }, { "name": "SandboxCustomImages" }, { "name": "Clusters" }, { "name": "OutboundNetworkDependenciesEndpoints" }, { "name": "PrivateEndpointConnections" }, { "name": "PrivateLinkResources" }, { "name": "OperationResults" } ], "paths": { "/providers/Microsoft.Kusto/operations": { "get": { "operationId": "Operations_List", "tags": [ "Operations" ], "description": "List the operations for the provider", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/OperationListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "KustoOperationsList": { "$ref": "./examples/KustoOperationsList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Kusto/clusters": { "get": { "operationId": "Clusters_List", "tags": [ "Clusters" ], "description": "Lists all Kusto clusters within a subscription.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ClusterListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "KustoClustersList": { "$ref": "./examples/KustoClustersList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Kusto/locations/{location}/checkNameAvailability": { "post": { "operationId": "Clusters_CheckNameAvailability", "tags": [ "Clusters" ], "description": "Checks that the cluster name is valid and is not already in use.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/LocationParameter" }, { "name": "clusterName", "in": "body", "description": "The request body", "required": true, "schema": { "$ref": "#/definitions/ClusterCheckNameRequest" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/CheckNameResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "KustoClustersCheckNameAvailability": { "$ref": "./examples/KustoClustersCheckNameAvailability.json" } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Kusto/locations/{location}/operationResults/{operationId}": { "get": { "operationId": "OperationsResults_Get", "tags": [ "OperationResults" ], "description": "Returns operation results.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/LocationParameter" }, { "name": "operationId", "in": "path", "description": "The ID of an ongoing async operation.", "required": true, "type": "string", "minLength": 1 } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/OperationResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "KustoOperationResultsGet": { "$ref": "./examples/KustoOperationResultsGet.json" } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Kusto/locations/{location}/skus": { "get": { "operationId": "Skus_List", "description": "Lists eligible region SKUs for Kusto resource provider by Azure region.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/LocationParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/SkuDescriptionList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "KustoListRegionSkus": { "$ref": "./examples/KustoSkus.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Kusto/skus": { "get": { "operationId": "Clusters_ListSkus", "description": "Lists eligible SKUs for Kusto resource provider.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/SkuDescriptionList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "KustoClustersListSkus": { "$ref": "./examples/KustoClustersListSkus.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters": { "get": { "operationId": "Clusters_ListByResourceGroup", "tags": [ "Clusters" ], "description": "Lists all Kusto clusters within a resource group.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ClusterListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "KustoClustersListByResourceGroup": { "$ref": "./examples/KustoClustersListByResourceGroup.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}": { "get": { "operationId": "Clusters_Get", "tags": [ "Clusters" ], "description": "Gets a Kusto cluster.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Cluster" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "KustoClustersGet": { "$ref": "./examples/KustoClustersGet.json" } } }, "put": { "operationId": "Clusters_CreateOrUpdate", "tags": [ "Clusters" ], "description": "Create or update a Kusto cluster.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "If-Match", "in": "header", "description": "The ETag of the cluster. Omit this value to always overwrite the current cluster. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.", "required": false, "type": "string", "x-ms-client-name": "IfMatch" }, { "name": "If-None-Match", "in": "header", "description": "Set to '*' to allow a new cluster to be created, but to prevent updating an existing cluster. Other values will result in a 412 Pre-condition Failed response.", "required": false, "type": "string", "x-ms-client-name": "IfNoneMatch" }, { "name": "parameters", "in": "body", "description": "The Kusto cluster parameters supplied to the CreateOrUpdate operation.", "required": true, "schema": { "$ref": "#/definitions/Cluster" } } ], "responses": { "200": { "description": "Resource 'Cluster' update operation succeeded", "schema": { "$ref": "#/definitions/Cluster" } }, "201": { "description": "Resource 'Cluster' create operation succeeded", "schema": { "$ref": "#/definitions/Cluster" }, "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "KustoClusterCreateWithCMKFederatedIdentity": { "$ref": "./examples/KustoClusterCreateWithCMKFederatedIdentity.json" }, "KustoClusterCreateWithCMKUserAssignedIdentity": { "$ref": "./examples/KustoClusterCreateWithCMKUserAssignedIdentity.json" }, "KustoClustersCreateOrUpdate": { "$ref": "./examples/KustoClustersCreateOrUpdate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/Cluster" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "Clusters_Update", "tags": [ "Clusters" ], "description": "Update a Kusto cluster.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "If-Match", "in": "header", "description": "The ETag of the cluster. Omit this value to always overwrite the current cluster. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.", "required": false, "type": "string", "x-ms-client-name": "IfMatch" }, { "name": "parameters", "in": "body", "description": "The Kusto cluster parameters supplied to the Update operation.", "required": true, "schema": { "$ref": "#/definitions/ClusterUpdate" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Cluster" } }, "201": { "description": "Resource 'Cluster' create operation succeeded", "schema": { "$ref": "#/definitions/Cluster" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "202": { "description": "The request has been accepted for processing, but processing has not yet completed.", "schema": { "$ref": "#/definitions/Cluster" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "KustoClusterUpdateCMKKeyRotation": { "$ref": "./examples/KustoClusterUpdateCMKKeyRotation.json" }, "KustoClusterUpdateDisableCMK": { "$ref": "./examples/KustoClusterUpdateDisableCMK.json" }, "KustoClusterUpdateEnableCMK": { "$ref": "./examples/KustoClusterUpdateEnableCMK.json" }, "KustoClusterUpdateWithCMKFederatedIdentity": { "$ref": "./examples/KustoClusterUpdateWithCMKFederatedIdentity.json" }, "KustoClustersUpdate": { "$ref": "./examples/KustoClustersUpdate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/Cluster" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "Clusters_Delete", "tags": [ "Clusters" ], "description": "Deletes a Kusto cluster.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "202": { "description": "Resource deletion accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "KustoClustersDelete": { "$ref": "./examples/KustoClustersDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/addCalloutPolicies": { "post": { "operationId": "Clusters_AddCalloutPolicies", "tags": [ "Clusters" ], "description": "Adds a list of callout policies for engine services.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "calloutPolicies", "in": "body", "description": "The callout policies to add.", "required": true, "schema": { "$ref": "#/definitions/CalloutPoliciesList" } } ], "responses": { "200": { "description": "The request has succeeded." }, "202": { "description": "Resource operation accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "KustoClusterAddCalloutPolicy": { "$ref": "./examples/KustoClusterAddCalloutPolicies.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/addLanguageExtensions": { "post": { "operationId": "Clusters_AddLanguageExtensions", "tags": [ "Clusters" ], "description": "Add a list of language extensions that can run within KQL queries.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "languageExtensionsToAdd", "in": "body", "description": "The language extensions to add.", "required": true, "schema": { "$ref": "#/definitions/LanguageExtensionsList" } } ], "responses": { "200": { "description": "The request has succeeded." }, "202": { "description": "Resource operation accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "KustoClusterAddLanguageExtensions": { "$ref": "./examples/KustoClusterAddLanguageExtensions.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/attachedDatabaseConfigurationCheckNameAvailability": { "post": { "operationId": "AttachedDatabaseConfigurations_CheckNameAvailability", "tags": [ "AttachedDatabaseConfigurations" ], "description": "Checks that the attached database configuration resource name is valid and is not already in use.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "resourceName", "in": "body", "description": "The name of the resource.", "required": true, "schema": { "$ref": "#/definitions/AttachedDatabaseConfigurationsCheckNameRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/CheckNameResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "KustoAttachedDatabaseConfigurationCheckNameAvailability": { "$ref": "./examples/KustoAttachedDatabaseConfigurationCheckNameAvailability.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/attachedDatabaseConfigurations": { "get": { "operationId": "AttachedDatabaseConfigurations_ListByCluster", "tags": [ "AttachedDatabaseConfigurations" ], "description": "Returns the list of attached database configurations of the given Kusto cluster.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AttachedDatabaseConfigurationListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "KustoAttachedDatabaseConfigurationsListByCluster": { "$ref": "./examples/KustoAttachedDatabaseConfigurationsListByCluster.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/attachedDatabaseConfigurations/{attachedDatabaseConfigurationName}": { "get": { "operationId": "AttachedDatabaseConfigurations_Get", "tags": [ "AttachedDatabaseConfigurations" ], "description": "Returns an attached database configuration.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "attachedDatabaseConfigurationName", "in": "path", "description": "The name of the attached database configuration.", "required": true, "type": "string", "pattern": "^.*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AttachedDatabaseConfiguration" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "AttachedDatabaseConfigurationsGet": { "$ref": "./examples/KustoAttachedDatabaseConfigurationsGet.json" } } }, "put": { "operationId": "AttachedDatabaseConfigurations_CreateOrUpdate", "tags": [ "AttachedDatabaseConfigurations" ], "description": "Creates or updates an attached database configuration.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "attachedDatabaseConfigurationName", "in": "path", "description": "The name of the attached database configuration.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "parameters", "in": "body", "description": "The database parameters supplied to the CreateOrUpdate operation.", "required": true, "schema": { "$ref": "#/definitions/AttachedDatabaseConfiguration" } } ], "responses": { "200": { "description": "Resource 'AttachedDatabaseConfiguration' update operation succeeded", "schema": { "$ref": "#/definitions/AttachedDatabaseConfiguration" } }, "201": { "description": "Resource 'AttachedDatabaseConfiguration' create operation succeeded", "schema": { "$ref": "#/definitions/AttachedDatabaseConfiguration" }, "headers": { "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "202": { "description": "The request has been accepted for processing, but processing has not yet completed.", "schema": { "$ref": "#/definitions/AttachedDatabaseConfiguration" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "AttachedDatabaseConfigurationsCreateOrUpdate": { "$ref": "./examples/KustoAttachedDatabaseConfigurationsCreateOrUpdate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/AttachedDatabaseConfiguration" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "AttachedDatabaseConfigurations_Delete", "tags": [ "AttachedDatabaseConfigurations" ], "description": "Deletes the attached database configuration with the given name.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "attachedDatabaseConfigurationName", "in": "path", "description": "The name of the attached database configuration.", "required": true, "type": "string", "pattern": "^.*$" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "202": { "description": "Resource deletion accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "AttachedDatabaseConfigurationsDelete": { "$ref": "./examples/KustoAttachedDatabaseConfigurationsDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/checkNameAvailability": { "post": { "operationId": "Databases_CheckNameAvailability", "tags": [ "Databases" ], "description": "Checks that the databases resource name is valid and is not already in use.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "resourceName", "in": "body", "description": "The name of the resource.", "required": true, "schema": { "$ref": "#/definitions/CheckNameRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/CheckNameResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "KustoDatabasesCheckNameAvailability": { "$ref": "./examples/KustoDatabasesCheckNameAvailability.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/checkPrincipalAssignmentNameAvailability": { "post": { "operationId": "ClusterPrincipalAssignments_CheckNameAvailability", "tags": [ "ClusterPrincipalAssignments" ], "description": "Checks that the principal assignment name is valid and is not already in use.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "principalAssignmentName", "in": "body", "description": "The name of the principal assignment.", "required": true, "schema": { "$ref": "#/definitions/ClusterPrincipalAssignmentCheckNameRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/CheckNameResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "KustoClusterPrincipalAssignmentsCheckNameAvailability": { "$ref": "./examples/KustoClusterPrincipalAssignmentsCheckNameAvailability.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases": { "get": { "operationId": "Databases_ListByCluster", "tags": [ "Databases" ], "description": "Returns the list of databases of the given Kusto cluster.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "$top", "in": "query", "description": "limit the number of results", "required": false, "type": "integer", "format": "int32", "minimum": 5, "maximum": 1000 }, { "name": "$skiptoken", "in": "query", "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DatabaseListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "KustoDatabasesListByCluster": { "$ref": "./examples/KustoDatabasesListByCluster.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}": { "get": { "operationId": "Databases_Get", "tags": [ "Databases" ], "description": "Returns a database.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "databaseName", "in": "path", "description": "The name of the database in the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Database" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "KustoDatabasesGet": { "$ref": "./examples/KustoDatabasesGet.json" }, "KustoSuspendedDatabasesGet": { "$ref": "./examples/KustoSuspendedDatabasesGet.json" } } }, "put": { "operationId": "Databases_CreateOrUpdate", "tags": [ "Databases" ], "description": "Creates or updates a database.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "databaseName", "in": "path", "description": "The name of the database in the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "callerRole", "in": "query", "description": "By default, any user who run operation on a database become an Admin on it. This property allows the caller to exclude the caller from Admins list.", "required": false, "type": "string", "default": "Admin", "enum": [ "Admin", "None" ], "x-ms-enum": { "name": "CallerRole", "modelAsString": true, "values": [ { "name": "Admin", "value": "Admin", "description": "Admin" }, { "name": "None", "value": "None", "description": "None" } ] } }, { "name": "parameters", "in": "body", "description": "The database parameters supplied to the CreateOrUpdate operation.", "required": true, "schema": { "$ref": "#/definitions/Database" } } ], "responses": { "200": { "description": "Resource 'Database' update operation succeeded", "schema": { "$ref": "#/definitions/Database" } }, "201": { "description": "Resource 'Database' create operation succeeded", "schema": { "$ref": "#/definitions/Database" }, "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, "202": { "description": "The request has been accepted for processing, but processing has not yet completed.", "schema": { "$ref": "#/definitions/Database" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Kusto ReadOnly database update": { "$ref": "./examples/KustoDatabaseReadonlyUpdate.json" }, "Kusto ReadWrite database create or update": { "$ref": "./examples/KustoDatabasesCreateOrUpdate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/Database" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "Databases_Update", "tags": [ "Databases" ], "description": "Updates a database.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "databaseName", "in": "path", "description": "The name of the database in the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "callerRole", "in": "query", "description": "By default, any user who run operation on a database become an Admin on it. This property allows the caller to exclude the caller from Admins list.", "required": false, "type": "string", "default": "Admin", "enum": [ "Admin", "None" ], "x-ms-enum": { "name": "CallerRole", "modelAsString": true, "values": [ { "name": "Admin", "value": "Admin", "description": "Admin" }, { "name": "None", "value": "None", "description": "None" } ] } }, { "name": "parameters", "in": "body", "description": "The database parameters supplied to the Update operation.", "required": true, "schema": { "$ref": "#/definitions/Database" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Database" } }, "201": { "description": "Resource 'Database' create operation succeeded", "schema": { "$ref": "#/definitions/Database" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, "202": { "description": "The request has been accepted for processing, but processing has not yet completed.", "schema": { "$ref": "#/definitions/Database" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "KustoDatabasesUpdate": { "$ref": "./examples/KustoDatabasesUpdate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/Database" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "Databases_Delete", "tags": [ "Databases" ], "description": "Deletes the database with the given name.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "databaseName", "in": "path", "description": "The name of the database in the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "202": { "description": "Resource deletion accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "KustoDatabasesDelete": { "$ref": "./examples/KustoDatabasesDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/addPrincipals": { "post": { "operationId": "Databases_AddPrincipals", "tags": [ "Databases" ], "description": "Add Database principals permissions.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "databaseName", "in": "path", "description": "The name of the database in the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "databasePrincipalsToAdd", "in": "body", "description": "List of database principals to add.", "required": true, "schema": { "$ref": "#/definitions/DatabasePrincipalListRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DatabasePrincipalListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "KustoDatabaseAddPrincipals": { "$ref": "./examples/KustoDatabaseAddPrincipals.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/checkNameAvailability": { "post": { "operationId": "DataConnections_CheckNameAvailability", "tags": [ "DataConnections" ], "description": "Checks that the data connection name is valid and is not already in use.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "databaseName", "in": "path", "description": "The name of the database in the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "dataConnectionName", "in": "body", "description": "The name of the data connection.", "required": true, "schema": { "$ref": "#/definitions/DataConnectionCheckNameRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/CheckNameResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "KustoDataConnectionsCheckNameAvailability": { "$ref": "./examples/KustoDataConnectionsCheckNameAvailability.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/checkPrincipalAssignmentNameAvailability": { "post": { "operationId": "DatabasePrincipalAssignments_CheckNameAvailability", "tags": [ "DatabasePrincipalAssignments" ], "description": "Checks that the database principal assignment is valid and is not already in use.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "databaseName", "in": "path", "description": "The name of the database in the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "principalAssignmentName", "in": "body", "description": "The name of the resource.", "required": true, "schema": { "$ref": "#/definitions/DatabasePrincipalAssignmentCheckNameRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/CheckNameResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "KustoDatabaseCheckNameAvailability": { "$ref": "./examples/KustoDatabasePrincipalAssignmentsCheckNameAvailability.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/dataConnectionValidation": { "post": { "operationId": "DataConnections_dataConnectionValidation", "tags": [ "DataConnections" ], "description": "Checks that the data connection parameters are valid.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "databaseName", "in": "path", "description": "The name of the database in the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "parameters", "in": "body", "description": "The data connection parameters supplied to the CreateOrUpdate operation.", "required": true, "schema": { "$ref": "#/definitions/DataConnectionValidation" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DataConnectionValidationListResult" } }, "202": { "description": "Data connection validation request accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "KustoDataConnectionEventGridValidation": { "$ref": "./examples/KustoDataConnectionEventGridValidationAsync.json" }, "KustoDataConnectionEventGridWithManagedIdentityValidationAsync": { "$ref": "./examples/KustoDataConnectionEventGridWithManagedIdentityValidationAsync.json" }, "KustoDataConnectionEventHubWithManagedIdentityValidationAsync": { "$ref": "./examples/KustoDataConnectionEventHubWithManagedIdentityValidationAsync.json" }, "KustoDataConnectionValidation": { "$ref": "./examples/KustoDataConnectionValidationAsync.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/DataConnectionValidationListResult" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/dataConnections": { "get": { "operationId": "DataConnections_ListByDatabase", "tags": [ "DataConnections" ], "description": "Returns the list of data connections of the given Kusto database.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "databaseName", "in": "path", "description": "The name of the database in the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DataConnectionListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "KustoDatabasesListByCluster": { "$ref": "./examples/KustoDataConnectionsListByDatabase.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/dataConnections/{dataConnectionName}": { "get": { "operationId": "DataConnections_Get", "tags": [ "DataConnections" ], "description": "Returns a data connection.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "databaseName", "in": "path", "description": "The name of the database in the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "dataConnectionName", "in": "path", "description": "The name of the data connection.", "required": true, "type": "string", "pattern": "^.*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DataConnection" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "KustoDataConnectionsCosmosDbGet": { "$ref": "./examples/KustoDataConnectionsCosmosDbGet.json" }, "KustoDataConnectionsEventGridGet": { "$ref": "./examples/KustoDataConnectionsEventGridGet.json" }, "KustoDataConnectionsEventGridWithManagedIdentityGet": { "$ref": "./examples/KustoDataConnectionsEventGridWithManagedIdentityGet.json" }, "KustoDataConnectionsEventHubWithManagedIdentityGet": { "$ref": "./examples/KustoDataConnectionsEventHubWithManagedIdentityGet.json" }, "KustoDataConnectionsGet": { "$ref": "./examples/KustoDataConnectionsGet.json" } } }, "put": { "operationId": "DataConnections_CreateOrUpdate", "tags": [ "DataConnections" ], "description": "Creates or updates a data connection.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "databaseName", "in": "path", "description": "The name of the database in the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "dataConnectionName", "in": "path", "description": "The name of the data connection.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "parameters", "in": "body", "description": "The data connection parameters supplied to the CreateOrUpdate operation.", "required": true, "schema": { "$ref": "#/definitions/DataConnection" } } ], "responses": { "200": { "description": "Resource 'DataConnection' update operation succeeded", "schema": { "$ref": "#/definitions/DataConnection" } }, "201": { "description": "The request has succeeded and a new resource has been created as a result.", "schema": { "$ref": "#/definitions/DataConnection" } }, "202": { "description": "The request has been accepted for processing, but processing has not yet completed.", "schema": { "$ref": "#/definitions/DataConnection" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "KustoDataConnectionsCosmosDbCreateOrUpdate": { "$ref": "./examples/KustoDataConnectionsCosmosDbCreateOrUpdate.json" }, "KustoDataConnectionsCreateOrUpdate": { "$ref": "./examples/KustoDataConnectionsCreateOrUpdate.json" }, "KustoDataConnectionsEventGridCreateOrUpdate": { "$ref": "./examples/KustoDataConnectionsEventGridCreateOrUpdate.json" }, "KustoDataConnectionsEventGridWithManagedIdentityCreateOrUpdate": { "$ref": "./examples/KustoDataConnectionsEventGridWithManagedIdentityCreateOrUpdate.json" }, "KustoDataConnectionsEventHubWithManagedIdentityCreateOrUpdate": { "$ref": "./examples/KustoDataConnectionsEventHubWithManagedIdentityCreateOrUpdate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/DataConnection" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "DataConnections_Update", "tags": [ "DataConnections" ], "description": "Updates a data connection.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "databaseName", "in": "path", "description": "The name of the database in the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "dataConnectionName", "in": "path", "description": "The name of the data connection.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "parameters", "in": "body", "description": "The data connection parameters supplied to the Update operation.", "required": true, "schema": { "$ref": "#/definitions/DataConnection" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DataConnection" } }, "201": { "description": "Resource 'DataConnection' create operation succeeded", "schema": { "$ref": "#/definitions/DataConnection" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "202": { "description": "The request has been accepted for processing, but processing has not yet completed.", "schema": { "$ref": "#/definitions/DataConnection" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "KustoDataConnectionsCosmosDbUpdate": { "$ref": "./examples/KustoDataConnectionsCosmosDbUpdate.json" }, "KustoDataConnectionsEventGridUpdate": { "$ref": "./examples/KustoDataConnectionsEventGridUpdate.json" }, "KustoDataConnectionsEventGridWithManagedIdentityUpdate": { "$ref": "./examples/KustoDataConnectionsEventGridWithManagedIdentityUpdate.json" }, "KustoDataConnectionsEventHubWithManagedIdentityUpdate": { "$ref": "./examples/KustoDataConnectionsEventHubWithManagedIdentityUpdate.json" }, "KustoDataConnectionsUpdate": { "$ref": "./examples/KustoDataConnectionsUpdate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/DataConnection" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "DataConnections_Delete", "tags": [ "DataConnections" ], "description": "Deletes the data connection with the given name.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "databaseName", "in": "path", "description": "The name of the database in the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "dataConnectionName", "in": "path", "description": "The name of the data connection.", "required": true, "type": "string", "pattern": "^.*$" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "202": { "description": "Resource deletion accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "KustoDataConnectionsDelete": { "$ref": "./examples/KustoDataConnectionsDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/inviteFollower": { "post": { "operationId": "Database_InviteFollower", "tags": [ "Databases" ], "description": "Generates an invitation token that allows attaching a follower database to this database.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "databaseName", "in": "path", "description": "The name of the database in the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "parameters", "in": "body", "description": "The follower invitation request parameters.", "required": true, "schema": { "$ref": "#/definitions/DatabaseInviteFollowerRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DatabaseInviteFollowerResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "KustoDatabaseInviteFollower": { "$ref": "./examples/KustoDatabaseInviteFollower.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/listPrincipals": { "post": { "operationId": "Databases_ListPrincipals", "tags": [ "Databases" ], "description": "Returns a list of database principals of the given Kusto cluster and database.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "databaseName", "in": "path", "description": "The name of the database in the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DatabasePrincipalListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "KustoDatabaseListPrincipals": { "$ref": "./examples/KustoDatabaseListPrincipals.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/principalAssignments": { "get": { "operationId": "DatabasePrincipalAssignments_List", "tags": [ "DatabasePrincipalAssignments" ], "description": "Lists all Kusto cluster database principalAssignments.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "databaseName", "in": "path", "description": "The name of the database in the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DatabasePrincipalAssignmentListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "KustoPrincipalAssignmentsList": { "$ref": "./examples/KustoDatabasePrincipalAssignmentsList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/principalAssignments/{principalAssignmentName}": { "get": { "operationId": "DatabasePrincipalAssignments_Get", "tags": [ "DatabasePrincipalAssignments" ], "description": "Gets a Kusto cluster database principalAssignment.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "databaseName", "in": "path", "description": "The name of the database in the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "principalAssignmentName", "in": "path", "description": "The name of the Kusto principalAssignment.", "required": true, "type": "string", "pattern": "^.*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DatabasePrincipalAssignment" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "KustoDatabasePrincipalAssignmentsGet": { "$ref": "./examples/KustoDatabasePrincipalAssignmentsGet.json" } } }, "put": { "operationId": "DatabasePrincipalAssignments_CreateOrUpdate", "tags": [ "DatabasePrincipalAssignments" ], "description": "Creates a Kusto cluster database principalAssignment.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "databaseName", "in": "path", "description": "The name of the database in the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "principalAssignmentName", "in": "path", "description": "The name of the Kusto principalAssignment.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "parameters", "in": "body", "description": "The Kusto principalAssignments parameters supplied for the operation.", "required": true, "schema": { "$ref": "#/definitions/DatabasePrincipalAssignment" } } ], "responses": { "200": { "description": "Resource 'DatabasePrincipalAssignment' update operation succeeded", "schema": { "$ref": "#/definitions/DatabasePrincipalAssignment" } }, "201": { "description": "Resource 'DatabasePrincipalAssignment' create operation succeeded", "schema": { "$ref": "#/definitions/DatabasePrincipalAssignment" }, "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "KustoDatabasePrincipalAssignmentsCreateOrUpdate": { "$ref": "./examples/KustoDatabasePrincipalAssignmentsCreateOrUpdate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/DatabasePrincipalAssignment" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "DatabasePrincipalAssignments_Delete", "tags": [ "DatabasePrincipalAssignments" ], "description": "Deletes a Kusto principalAssignment.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "databaseName", "in": "path", "description": "The name of the database in the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "principalAssignmentName", "in": "path", "description": "The name of the Kusto principalAssignment.", "required": true, "type": "string", "pattern": "^.*$" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "202": { "description": "Resource deletion accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "KustoDatabasePrincipalAssignmentsDelete": { "$ref": "./examples/KustoDatabasePrincipalAssignmentsDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/removePrincipals": { "post": { "operationId": "Databases_RemovePrincipals", "tags": [ "Databases" ], "description": "Remove Database principals permissions.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "databaseName", "in": "path", "description": "The name of the database in the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "databasePrincipalsToRemove", "in": "body", "description": "List of database principals to remove.", "required": true, "schema": { "$ref": "#/definitions/DatabasePrincipalListRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DatabasePrincipalListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "KustoDatabaseRemovePrincipals": { "$ref": "./examples/KustoDatabaseRemovePrincipals.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/scripts": { "get": { "operationId": "Scripts_ListByDatabase", "tags": [ "scripts" ], "description": "Returns the list of database scripts for given database.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "databaseName", "in": "path", "description": "The name of the database in the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ScriptListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "KustoScriptsList": { "$ref": "./examples/KustoScriptsListByDatabase.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/scripts/{scriptName}": { "get": { "operationId": "Scripts_Get", "tags": [ "Scripts" ], "description": "Gets a Kusto cluster database script.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "databaseName", "in": "path", "description": "The name of the database in the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "scriptName", "in": "path", "description": "The name of the Kusto database script.", "required": true, "type": "string", "pattern": "^.*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Script" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "KustoScriptsGet": { "$ref": "./examples/KustoScriptsGet.json" }, "KustoScriptsGetWithManagedIdentity": { "$ref": "./examples/KustoScriptsGetWithManagedIdentity.json" } } }, "put": { "operationId": "Scripts_CreateOrUpdate", "tags": [ "Scripts" ], "description": "Creates a Kusto database script.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "databaseName", "in": "path", "description": "The name of the database in the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "scriptName", "in": "path", "description": "The name of the Kusto database script.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "parameters", "in": "body", "description": "The Kusto Script parameters contains the KQL to run.", "required": true, "schema": { "$ref": "#/definitions/Script" } } ], "responses": { "200": { "description": "Resource 'Script' update operation succeeded", "schema": { "$ref": "#/definitions/Script" } }, "201": { "description": "Resource 'Script' create operation succeeded", "schema": { "$ref": "#/definitions/Script" }, "headers": { "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "202": { "description": "The request has been accepted for processing, but processing has not yet completed.", "schema": { "$ref": "#/definitions/Script" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "KustoScriptsCreateOrUpdate": { "$ref": "./examples/KustoScriptsCreateOrUpdate.json" }, "KustoScriptsCreateOrUpdateWithManagedIdentity": { "$ref": "./examples/KustoScriptsCreateOrUpdateWithManagedIdentity.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/Script" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "Scripts_Update", "tags": [ "Scripts" ], "description": "Updates a database script.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "databaseName", "in": "path", "description": "The name of the database in the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "scriptName", "in": "path", "description": "The name of the Kusto database script.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "parameters", "in": "body", "description": "The Kusto Script parameters contains to the KQL to run.", "required": true, "schema": { "$ref": "#/definitions/Script" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Script" } }, "202": { "description": "The request has been accepted for processing, but processing has not yet completed.", "schema": { "$ref": "#/definitions/Script" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "KustoScriptsUpdate": { "$ref": "./examples/KustoScriptsUpdate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/Script" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "Scripts_Delete", "tags": [ "Scripts" ], "description": "Deletes a Kusto database script.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "databaseName", "in": "path", "description": "The name of the database in the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "scriptName", "in": "path", "description": "The name of the Kusto database script.", "required": true, "type": "string", "pattern": "^.*$" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "202": { "description": "Resource deletion accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "KustoScriptsDelete": { "$ref": "./examples/KustoScriptsDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/scriptsCheckNameAvailability": { "post": { "operationId": "Scripts_CheckNameAvailability", "tags": [ "Scripts" ], "description": "Checks that the script name is valid and is not already in use.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "databaseName", "in": "path", "description": "The name of the database in the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "scriptName", "in": "body", "description": "The name of the script.", "required": true, "schema": { "$ref": "#/definitions/ScriptCheckNameRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/CheckNameResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "KustoScriptsCheckNameAvailability": { "$ref": "./examples/KustoScriptsCheckNameAvailability.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/detachFollowerDatabases": { "post": { "operationId": "Clusters_DetachFollowerDatabases", "tags": [ "Clusters" ], "description": "Detaches all followers of a database owned by this cluster.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "followerDatabaseToRemove", "in": "body", "description": "The follower databases properties to remove.", "required": true, "schema": { "$ref": "#/definitions/FollowerDatabaseDefinition" } } ], "responses": { "200": { "description": "The request has succeeded." }, "202": { "description": "Resource operation accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "KustoClusterDetachFollowerDatabases": { "$ref": "./examples/KustoClusterDetachFollowerDatabases.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/diagnoseVirtualNetwork": { "post": { "operationId": "Clusters_DiagnoseVirtualNetwork", "tags": [ "Clusters" ], "description": "Diagnoses network connectivity status for external resources on which the service is dependent on.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DiagnoseVirtualNetworkResult" } }, "202": { "description": "Diagnose virtual network request accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "KustoClusterDiagnoseVirtualNetwork": { "$ref": "./examples/KustoClustersDiagnoseVirtualNetwork.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/DiagnoseVirtualNetworkResult" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/listCalloutPolicies": { "post": { "operationId": "Clusters_ListCalloutPolicies", "tags": [ "Clusters" ], "description": "Returns the allowed callout policies for the specified service.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/CalloutPoliciesList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "KustoClusterListCalloutPolicies": { "$ref": "./examples/KustoClustersListCalloutPolicies.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/listFollowerDatabases": { "get": { "operationId": "Clusters_ListFollowerDatabasesGet", "tags": [ "Clusters" ], "description": "Returns a list of databases that are owned by this cluster and were followed by another cluster.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/FollowerDatabaseListResultGet" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "KustoClusterListFollowerDatabasesGet": { "$ref": "./examples/KustoClusterListFollowerDatabasesGet.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } }, "post": { "operationId": "Clusters_ListFollowerDatabases", "tags": [ "Clusters" ], "description": "Returns a list of databases that are owned by this cluster and were followed by another cluster.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/FollowerDatabaseListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "KustoClusterListFollowerDatabases": { "$ref": "./examples/KustoClusterListFollowerDatabases.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/listLanguageExtensions": { "post": { "operationId": "Clusters_ListLanguageExtensions", "tags": [ "Clusters" ], "description": "Returns a list of language extensions that can run within KQL queries.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/LanguageExtensionsList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "KustoClusterListLanguageExtensions": { "$ref": "./examples/KustoClusterListLanguageExtensions.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/managedPrivateEndpoints": { "get": { "operationId": "ManagedPrivateEndpoints_List", "tags": [ "ManagedPrivateEndpoints" ], "description": "Returns the list of managed private endpoints.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ManagedPrivateEndpointListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "KustoManagedPrivateEndpointsList": { "$ref": "./examples/KustoManagedPrivateEndpointsList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/managedPrivateEndpoints/{managedPrivateEndpointName}": { "get": { "operationId": "ManagedPrivateEndpoints_Get", "tags": [ "ManagedPrivateEndpoints" ], "description": "Gets a managed private endpoint.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "managedPrivateEndpointName", "in": "path", "description": "The name of the managed private endpoint.", "required": true, "type": "string", "pattern": "^.*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ManagedPrivateEndpoint" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "KustoManagedPrivateEndpointsGet": { "$ref": "./examples/KustoManagedPrivateEndpointsGet.json" } } }, "put": { "operationId": "ManagedPrivateEndpoints_CreateOrUpdate", "tags": [ "ManagedPrivateEndpoints" ], "description": "Creates a managed private endpoint.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "managedPrivateEndpointName", "in": "path", "description": "The name of the managed private endpoint.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "parameters", "in": "body", "description": "The managed private endpoint parameters.", "required": true, "schema": { "$ref": "#/definitions/ManagedPrivateEndpoint" } } ], "responses": { "200": { "description": "Resource 'ManagedPrivateEndpoint' update operation succeeded", "schema": { "$ref": "#/definitions/ManagedPrivateEndpoint" } }, "201": { "description": "Resource 'ManagedPrivateEndpoint' create operation succeeded", "schema": { "$ref": "#/definitions/ManagedPrivateEndpoint" }, "headers": { "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "202": { "description": "The request has been accepted for processing, but processing has not yet completed.", "schema": { "$ref": "#/definitions/ManagedPrivateEndpoint" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "KustoManagedPrivateEndpointsCreateOrUpdate": { "$ref": "./examples/KustoManagedPrivateEndpointsCreateOrUpdate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/ManagedPrivateEndpoint" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "ManagedPrivateEndpoints_Update", "tags": [ "ManagedPrivateEndpoints" ], "description": "Updates a managed private endpoint.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "managedPrivateEndpointName", "in": "path", "description": "The name of the managed private endpoint.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "parameters", "in": "body", "description": "The managed private endpoint parameters.", "required": true, "schema": { "$ref": "#/definitions/ManagedPrivateEndpoint" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ManagedPrivateEndpoint" } }, "202": { "description": "The request has been accepted for processing, but processing has not yet completed.", "schema": { "$ref": "#/definitions/ManagedPrivateEndpoint" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "KustoManagedPrivateEndpointsUpdate": { "$ref": "./examples/KustoManagedPrivateEndpointsUpdate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/ManagedPrivateEndpoint" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "ManagedPrivateEndpoints_Delete", "tags": [ "ManagedPrivateEndpoints" ], "description": "Deletes a managed private endpoint.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "managedPrivateEndpointName", "in": "path", "description": "The name of the managed private endpoint.", "required": true, "type": "string", "pattern": "^.*$" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "202": { "description": "Resource deletion accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ManagedPrivateEndpointsDelete": { "$ref": "./examples/KustoManagedPrivateEndpointsDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/managedPrivateEndpointsCheckNameAvailability": { "post": { "operationId": "ManagedPrivateEndpoints_CheckNameAvailability", "tags": [ "ManagedPrivateEndpoints" ], "description": "Checks that the managed private endpoints resource name is valid and is not already in use.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "resourceName", "in": "body", "description": "The name of the resource.", "required": true, "schema": { "$ref": "#/definitions/ManagedPrivateEndpointsCheckNameRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/CheckNameResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "KustoManagedPrivateEndpointsCheckNameAvailability": { "$ref": "./examples/KustoManagedPrivateEndpointsCheckNameAvailability.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/migrate": { "post": { "operationId": "Clusters_Migrate", "tags": [ "Clusters" ], "description": "Migrate data from a Kusto cluster to another cluster.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "clusterMigrateRequest", "in": "body", "description": "The cluster migrate request parameters.", "required": true, "schema": { "$ref": "#/definitions/ClusterMigrateRequest" } } ], "responses": { "200": { "description": "The request has succeeded." }, "202": { "description": "Resource operation accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "KustoClusterMigrate": { "$ref": "./examples/KustoClusterMigrate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/outboundNetworkDependenciesEndpoints": { "get": { "operationId": "Clusters_ListOutboundNetworkDependenciesEndpoints", "tags": [ "OutboundNetworkDependenciesEndpoints" ], "description": "Gets the network endpoints of all outbound dependencies of a Kusto cluster", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/OutboundNetworkDependenciesEndpointListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get Kusto cluster outbound network dependencies": { "$ref": "./examples/KustoOutboundNetworkDependenciesList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/principalAssignments": { "get": { "operationId": "ClusterPrincipalAssignments_List", "tags": [ "ClusterPrincipalAssignments" ], "description": "Lists all Kusto cluster principalAssignments.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ClusterPrincipalAssignmentListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "KustoPrincipalAssignmentsList": { "$ref": "./examples/KustoClusterPrincipalAssignmentsList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/principalAssignments/{principalAssignmentName}": { "get": { "operationId": "ClusterPrincipalAssignments_Get", "tags": [ "ClusterPrincipalAssignments" ], "description": "Gets a Kusto cluster principalAssignment.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "principalAssignmentName", "in": "path", "description": "The name of the Kusto principalAssignment.", "required": true, "type": "string", "pattern": "^.*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ClusterPrincipalAssignment" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "KustoClusterPrincipalAssignmentsGet": { "$ref": "./examples/KustoClusterPrincipalAssignmentsGet.json" } } }, "put": { "operationId": "ClusterPrincipalAssignments_CreateOrUpdate", "tags": [ "ClusterPrincipalAssignments" ], "description": "Create a Kusto cluster principalAssignment.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "principalAssignmentName", "in": "path", "description": "The name of the Kusto principalAssignment.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "parameters", "in": "body", "description": "The Kusto cluster principalAssignment's parameters supplied for the operation.", "required": true, "schema": { "$ref": "#/definitions/ClusterPrincipalAssignment" } } ], "responses": { "200": { "description": "Resource 'ClusterPrincipalAssignment' update operation succeeded", "schema": { "$ref": "#/definitions/ClusterPrincipalAssignment" } }, "201": { "description": "Resource 'ClusterPrincipalAssignment' create operation succeeded", "schema": { "$ref": "#/definitions/ClusterPrincipalAssignment" }, "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "KustoClusterPrincipalAssignmentsCreateOrUpdate": { "$ref": "./examples/KustoClusterPrincipalAssignmentsCreateOrUpdate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/ClusterPrincipalAssignment" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "ClusterPrincipalAssignments_Delete", "tags": [ "ClusterPrincipalAssignments" ], "description": "Deletes a Kusto cluster principalAssignment.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "principalAssignmentName", "in": "path", "description": "The name of the Kusto principalAssignment.", "required": true, "type": "string", "pattern": "^.*$" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "202": { "description": "Resource deletion accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "KustoClusterPrincipalAssignmentsDelete": { "$ref": "./examples/KustoClusterPrincipalAssignmentsDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/privateEndpointConnections": { "get": { "operationId": "PrivateEndpointConnections_List", "tags": [ "PrivateEndpointConnections" ], "description": "Returns the list of private endpoint connections.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/PrivateEndpointConnectionListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "KustoPrivateEndpointConnectionsList": { "$ref": "./examples/KustoPrivateEndpointConnectionsList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/privateEndpointConnections/{privateEndpointConnectionName}": { "get": { "operationId": "PrivateEndpointConnections_Get", "tags": [ "PrivateEndpointConnections" ], "description": "Gets a private endpoint connection.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "privateEndpointConnectionName", "in": "path", "description": "The name of the private endpoint connection.", "required": true, "type": "string", "pattern": "^.*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/PrivateEndpointConnection" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Gets private endpoint connection.": { "$ref": "./examples/KustoPrivateEndpointConnectionsGet.json" } } }, "put": { "operationId": "PrivateEndpointConnections_CreateOrUpdate", "tags": [ "PrivateEndpointConnections" ], "description": "Approve or reject a private endpoint connection with a given name.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "privateEndpointConnectionName", "in": "path", "description": "The name of the private endpoint connection.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "parameters", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/PrivateEndpointConnection" } } ], "responses": { "200": { "description": "Resource 'PrivateEndpointConnection' update operation succeeded", "schema": { "$ref": "#/definitions/PrivateEndpointConnection" } }, "201": { "description": "Resource 'PrivateEndpointConnection' create operation succeeded", "schema": { "$ref": "#/definitions/PrivateEndpointConnection" }, "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Approve or reject a private endpoint connection with a given name.": { "$ref": "./examples/KustoPrivateEndpointConnectionsCreateOrUpdate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/PrivateEndpointConnection" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "PrivateEndpointConnections_Delete", "tags": [ "PrivateEndpointConnections" ], "description": "Deletes a private endpoint connection with a given name.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "privateEndpointConnectionName", "in": "path", "description": "The name of the private endpoint connection.", "required": true, "type": "string", "pattern": "^.*$" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "202": { "description": "Resource deletion accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Deletes a private endpoint connection with a given name.": { "$ref": "./examples/KustoPrivateEndpointConnectionsDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/privateLinkResources": { "get": { "operationId": "PrivateLinkResources_List", "tags": [ "PrivateLinkResources" ], "description": "Returns the list of private link resources.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/PrivateLinkResourceListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Gets private endpoint connections.": { "$ref": "./examples/KustoPrivateLinkResourcesList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/privateLinkResources/{privateLinkResourceName}": { "get": { "operationId": "PrivateLinkResources_Get", "tags": [ "PrivateLinkResources" ], "description": "Gets a private link resource.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "privateLinkResourceName", "in": "path", "description": "The name of the private link resource.", "required": true, "type": "string", "pattern": "^.*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/PrivateLinkResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Gets private endpoint connection.": { "$ref": "./examples/KustoPrivateLinkResourcesGet.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/removeCalloutPolicy": { "post": { "operationId": "Clusters_RemoveCalloutPolicy", "tags": [ "Clusters" ], "description": "Removes callout policy for engine services.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "calloutPolicy", "in": "body", "description": "The callout policies to remove.", "required": true, "schema": { "$ref": "#/definitions/CalloutPolicyToRemove" } } ], "responses": { "200": { "description": "The request has succeeded." }, "202": { "description": "Resource operation accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "KustoClusterDropCalloutPolicy": { "$ref": "./examples/KustoClusterRemoveCalloutPolicy.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/removeLanguageExtensions": { "post": { "operationId": "Clusters_RemoveLanguageExtensions", "tags": [ "Clusters" ], "description": "Remove a list of language extensions that can run within KQL queries.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "languageExtensionsToRemove", "in": "body", "description": "The language extensions to remove.", "required": true, "schema": { "$ref": "#/definitions/LanguageExtensionsList" } } ], "responses": { "200": { "description": "The request has succeeded." }, "202": { "description": "Resource operation accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "KustoClusterRemoveLanguageExtensions": { "$ref": "./examples/KustoClusterRemoveLanguageExtensions.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/sandboxCustomImages": { "get": { "operationId": "SandboxCustomImages_ListByCluster", "tags": [ "SandboxCustomImages" ], "description": "Returns the list of the existing sandbox custom images of the given Kusto cluster.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SandboxCustomImagesListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "KustoSandboxCustomImagesListByCluster": { "$ref": "./examples/KustoSandboxCustomImagesList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/sandboxCustomImages/{sandboxCustomImageName}": { "get": { "operationId": "SandboxCustomImages_Get", "tags": [ "SandboxCustomImages" ], "description": "Returns a sandbox custom image", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "sandboxCustomImageName", "in": "path", "description": "The name of the sandbox custom image.", "required": true, "type": "string", "pattern": "^.*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SandboxCustomImage" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "KustoSandboxCustomImagesGet": { "$ref": "./examples/KustoSandboxCustomImagesGet.json" } } }, "put": { "operationId": "SandboxCustomImages_CreateOrUpdate", "tags": [ "SandboxCustomImages" ], "description": "Creates or updates a sandbox custom image.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "sandboxCustomImageName", "in": "path", "description": "The name of the sandbox custom image.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "parameters", "in": "body", "description": "The sandbox custom image parameters.", "required": true, "schema": { "$ref": "#/definitions/SandboxCustomImage" } } ], "responses": { "200": { "description": "Resource 'SandboxCustomImage' update operation succeeded", "schema": { "$ref": "#/definitions/SandboxCustomImage" } }, "201": { "description": "Resource 'SandboxCustomImage' create operation succeeded", "schema": { "$ref": "#/definitions/SandboxCustomImage" }, "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "KustoSandboxCustomImagesCreateOrUpdate": { "$ref": "./examples/KustoSandboxCustomImagesCreateOrUpdate.json" }, "KustoSandboxCustomImagesCreateOrUpdateWithCustomBaseImage": { "$ref": "./examples/KustoSandboxCustomImagesCreateOrUpdateWithCustomBaseImage.json" }, "KustoSandboxCustomImagesCreateOrUpdateWithManagedBaseImage": { "$ref": "./examples/KustoSandboxCustomImagesCreateOrUpdateWithManagedBaseImage.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/SandboxCustomImage" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "SandboxCustomImages_Update", "tags": [ "SandboxCustomImages" ], "description": "Updates a sandbox custom image.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "sandboxCustomImageName", "in": "path", "description": "The name of the sandbox custom image.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "parameters", "in": "body", "description": "The sandbox custom image parameters.", "required": true, "schema": { "$ref": "#/definitions/SandboxCustomImage" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SandboxCustomImage" } }, "201": { "description": "Resource 'SandboxCustomImage' create operation succeeded", "schema": { "$ref": "#/definitions/SandboxCustomImage" }, "headers": { "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "202": { "description": "The request has been accepted for processing, but processing has not yet completed.", "schema": { "$ref": "#/definitions/SandboxCustomImage" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "KustoSandboxCustomImagesUpdate": { "$ref": "./examples/KustoSandboxCustomImageUpdate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/SandboxCustomImage" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "SandboxCustomImages_Delete", "tags": [ "SandboxCustomImages" ], "description": "Deletes a sandbox custom image.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "sandboxCustomImageName", "in": "path", "description": "The name of the sandbox custom image.", "required": true, "type": "string", "pattern": "^.*$" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "202": { "description": "Resource deletion accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "SandboxCustomImagesDelete": { "$ref": "./examples/KustoSandboxCustomImageDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/sandboxCustomImagesCheckNameAvailability": { "post": { "operationId": "SandboxCustomImages_CheckNameAvailability", "tags": [ "SandboxCustomImages" ], "description": "Checks that the sandbox custom image resource name is valid and is not already in use.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" }, { "name": "resourceName", "in": "body", "description": "The name of the resource.", "required": true, "schema": { "$ref": "#/definitions/SandboxCustomImagesCheckNameRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/CheckNameResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "KustoSandboxCustomImagesCheckNameAvailability": { "$ref": "./examples/KustoSandboxCustomImagesCheckNameAvailability.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/skus": { "get": { "operationId": "Clusters_ListSkusByResource", "tags": [ "Clusters" ], "description": "Returns the SKUs available for the provided resource.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ListResourceSkusResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "KustoClustersListResourceSkus": { "$ref": "./examples/KustoClustersListResourceSkus.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/start": { "post": { "operationId": "Clusters_Start", "tags": [ "Clusters" ], "description": "Starts a Kusto cluster.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" } ], "responses": { "200": { "description": "The request has succeeded." }, "202": { "description": "Resource operation accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "KustoClustersStart": { "$ref": "./examples/KustoClustersStart.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/stop": { "post": { "operationId": "Clusters_Stop", "tags": [ "Clusters" ], "description": "Stops a Kusto cluster.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "clusterName", "in": "path", "description": "The name of the Kusto cluster.", "required": true, "type": "string", "pattern": "^.*$" } ], "responses": { "200": { "description": "The request has succeeded." }, "202": { "description": "Resource operation accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "KustoClustersStop": { "$ref": "./examples/KustoClustersStop.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } } }, "x-ms-paths": { "/subscriptions/{subscriptionId}/providers/Microsoft.Kusto/locations/{location}/operationResults/{operationId}?operationResultResponseType=Location": { "get": { "operationId": "OperationsResultsLocation_Get", "tags": [ "OperationResults" ], "description": "Returns operation results.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/LocationParameter" }, { "name": "operationId", "in": "path", "description": "The ID of an ongoing async operation.", "required": true, "type": "string", "minLength": 1 }, { "name": "operationResultResponseType", "in": "query", "required": true, "type": "string", "enum": [ "Location" ], "x-ms-enum": { "modelAsString": false } } ], "responses": { "200": { "description": "The request has succeeded." }, "202": { "description": "The request has been accepted for processing, but processing has not yet completed.", "headers": { "Azure-AsyncOperation": { "type": "string", "description": "URL to query the status of the operation." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "KustoOperationsResultsLocationGet": { "$ref": "./examples/KustoOperationResultsOperationResultResponseTypeGet.json" } } } } }, "definitions": { "AcceptedAudiences": { "type": "object", "description": "Represents an accepted audience trusted by the cluster.", "properties": { "value": { "type": "string", "description": "GUID or valid URL representing an accepted audience." } } }, "AttachedDatabaseConfiguration": { "type": "object", "description": "Class representing an attached database configuration.", "properties": { "properties": { "$ref": "#/definitions/AttachedDatabaseConfigurationProperties", "description": "The properties of the attached database configuration.", "x-ms-client-flatten": true }, "location": { "type": "string", "description": "Resource location." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" } ] }, "AttachedDatabaseConfigurationListResult": { "type": "object", "description": "The list attached database configurations operation response.", "properties": { "value": { "type": "array", "description": "The list of attached database configurations.", "items": { "$ref": "#/definitions/AttachedDatabaseConfiguration" } }, "nextLink": { "type": "string", "description": "Link to the next page of results." } } }, "AttachedDatabaseConfigurationProperties": { "type": "object", "description": "Class representing the an attached database configuration properties of kind specific.", "properties": { "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The provisioned state of the resource.", "readOnly": true }, "databaseName": { "type": "string", "description": "The name of the database which you would like to attach, use * if you want to follow all current and future databases." }, "clusterResourceId": { "type": "string", "description": "The resource id of the cluster where the databases you would like to attach reside." }, "attachedDatabaseNames": { "type": "array", "description": "The list of databases from the clusterResourceId which are currently attached to the cluster.", "items": { "type": "string" }, "readOnly": true }, "defaultPrincipalsModificationKind": { "$ref": "#/definitions/DefaultPrincipalsModificationKind", "description": "The default principals modification kind" }, "tableLevelSharingProperties": { "$ref": "#/definitions/TableLevelSharingProperties", "description": "Table level sharing specifications" }, "databaseNameOverride": { "type": "string", "description": "Overrides the original database name. Relevant only when attaching to a specific database." }, "databaseNamePrefix": { "type": "string", "description": "Adds a prefix to the attached databases name. When following an entire cluster, that prefix would be added to all of the databases original names from leader cluster." } }, "required": [ "databaseName", "clusterResourceId", "defaultPrincipalsModificationKind" ] }, "AttachedDatabaseConfigurationsCheckNameRequest": { "type": "object", "description": "The result returned from a AttachedDatabaseConfigurations check name availability request.", "properties": { "name": { "type": "string", "description": "Attached database resource name." }, "type": { "type": "string", "description": "The type of resource, for instance Microsoft.Kusto/clusters/attachedDatabaseConfigurations.", "enum": [ "Microsoft.Kusto/clusters/attachedDatabaseConfigurations" ], "x-ms-enum": { "modelAsString": false } } }, "required": [ "name", "type" ] }, "AzureCapacity": { "type": "object", "description": "Azure capacity definition.", "properties": { "scaleType": { "$ref": "#/definitions/AzureScaleType", "description": "Scale type." }, "minimum": { "type": "integer", "format": "int32", "description": "Minimum allowed capacity." }, "maximum": { "type": "integer", "format": "int32", "description": "Maximum allowed capacity." }, "default": { "type": "integer", "format": "int32", "description": "The default capacity that would be used." } }, "required": [ "scaleType", "minimum", "maximum", "default" ] }, "AzureResourceSku": { "type": "object", "description": "Azure resource SKU definition.", "properties": { "resourceType": { "type": "string", "description": "Resource Namespace and Type." }, "sku": { "$ref": "#/definitions/AzureSku", "description": "The SKU details." }, "capacity": { "$ref": "#/definitions/AzureCapacity", "description": "The number of instances of the cluster." } } }, "AzureScaleType": { "type": "string", "description": "Scale type.", "enum": [ "automatic", "manual", "none" ], "x-ms-enum": { "name": "AzureScaleType", "modelAsString": true, "values": [ { "name": "automatic", "value": "automatic", "description": "automatic" }, { "name": "manual", "value": "manual", "description": "manual" }, { "name": "none", "value": "none", "description": "none" } ] } }, "AzureSku": { "type": "object", "description": "Azure SKU definition.", "properties": { "name": { "$ref": "#/definitions/AzureSkuName", "description": "SKU name." }, "capacity": { "type": "integer", "format": "int32", "description": "The number of instances of the cluster." }, "tier": { "$ref": "#/definitions/AzureSkuTier", "description": "SKU tier." } }, "required": [ "name", "tier" ] }, "AzureSkuName": { "type": "string", "description": "SKU name.", "enum": [ "Dev(No SLA)_Standard_D11_v2", "Dev(No SLA)_Standard_E2a_v4", "Standard_D11_v2", "Standard_D12_v2", "Standard_D13_v2", "Standard_D14_v2", "Standard_D32d_v4", "Standard_D16d_v5", "Standard_D32d_v5", "Standard_DS13_v2+1TB_PS", "Standard_DS13_v2+2TB_PS", "Standard_DS14_v2+3TB_PS", "Standard_DS14_v2+4TB_PS", "Standard_L4s", "Standard_L8s", "Standard_L16s", "Standard_L8s_v2", "Standard_L16s_v2", "Standard_L8s_v3", "Standard_L16s_v3", "Standard_L32s_v3", "Standard_L8as_v3", "Standard_L16as_v3", "Standard_L32as_v3", "Standard_E64i_v3", "Standard_E80ids_v4", "Standard_E2a_v4", "Standard_E4a_v4", "Standard_E8a_v4", "Standard_E16a_v4", "Standard_E8as_v4+1TB_PS", "Standard_E8as_v4+2TB_PS", "Standard_E16as_v4+3TB_PS", "Standard_E16as_v4+4TB_PS", "Standard_E8as_v5+1TB_PS", "Standard_E8as_v5+2TB_PS", "Standard_E16as_v5+3TB_PS", "Standard_E16as_v5+4TB_PS", "Standard_E2ads_v5", "Standard_E4ads_v5", "Standard_E8ads_v5", "Standard_E16ads_v5", "Standard_EC8as_v5+1TB_PS", "Standard_EC8as_v5+2TB_PS", "Standard_EC16as_v5+3TB_PS", "Standard_EC16as_v5+4TB_PS", "Standard_EC8ads_v5", "Standard_EC16ads_v5", "Standard_E8s_v4+1TB_PS", "Standard_E8s_v4+2TB_PS", "Standard_E16s_v4+3TB_PS", "Standard_E16s_v4+4TB_PS", "Standard_E8s_v5+1TB_PS", "Standard_E8s_v5+2TB_PS", "Standard_E16s_v5+3TB_PS", "Standard_E16s_v5+4TB_PS", "Standard_E2d_v4", "Standard_E4d_v4", "Standard_E8d_v4", "Standard_E16d_v4", "Standard_E2d_v5", "Standard_E4d_v5", "Standard_E8d_v5", "Standard_E16d_v5" ], "x-ms-enum": { "name": "AzureSkuName", "modelAsString": true, "values": [ { "name": "Dev(No SLA)_Standard_D11_v2", "value": "Dev(No SLA)_Standard_D11_v2", "description": "Dev(No SLA)_Standard_D11_v2" }, { "name": "Dev(No SLA)_Standard_E2a_v4", "value": "Dev(No SLA)_Standard_E2a_v4", "description": "Dev(No SLA)_Standard_E2a_v4" }, { "name": "Standard_D11_v2", "value": "Standard_D11_v2", "description": "Standard_D11_v2" }, { "name": "Standard_D12_v2", "value": "Standard_D12_v2", "description": "Standard_D12_v2" }, { "name": "Standard_D13_v2", "value": "Standard_D13_v2", "description": "Standard_D13_v2" }, { "name": "Standard_D14_v2", "value": "Standard_D14_v2", "description": "Standard_D14_v2" }, { "name": "Standard_D32d_v4", "value": "Standard_D32d_v4", "description": "Standard_D32d_v4" }, { "name": "Standard_D16d_v5", "value": "Standard_D16d_v5", "description": "Standard_D16d_v5" }, { "name": "Standard_D32d_v5", "value": "Standard_D32d_v5", "description": "Standard_D32d_v5" }, { "name": "Standard_DS13_v2+1TB_PS", "value": "Standard_DS13_v2+1TB_PS", "description": "Standard_DS13_v2+1TB_PS" }, { "name": "Standard_DS13_v2+2TB_PS", "value": "Standard_DS13_v2+2TB_PS", "description": "Standard_DS13_v2+2TB_PS" }, { "name": "Standard_DS14_v2+3TB_PS", "value": "Standard_DS14_v2+3TB_PS", "description": "Standard_DS14_v2+3TB_PS" }, { "name": "Standard_DS14_v2+4TB_PS", "value": "Standard_DS14_v2+4TB_PS", "description": "Standard_DS14_v2+4TB_PS" }, { "name": "Standard_L4s", "value": "Standard_L4s", "description": "Standard_L4s" }, { "name": "Standard_L8s", "value": "Standard_L8s", "description": "Standard_L8s" }, { "name": "Standard_L16s", "value": "Standard_L16s", "description": "Standard_L16s" }, { "name": "Standard_L8s_v2", "value": "Standard_L8s_v2", "description": "Standard_L8s_v2" }, { "name": "Standard_L16s_v2", "value": "Standard_L16s_v2", "description": "Standard_L16s_v2" }, { "name": "Standard_L8s_v3", "value": "Standard_L8s_v3", "description": "Standard_L8s_v3" }, { "name": "Standard_L16s_v3", "value": "Standard_L16s_v3", "description": "Standard_L16s_v3" }, { "name": "Standard_L32s_v3", "value": "Standard_L32s_v3", "description": "Standard_L32s_v3" }, { "name": "Standard_L8as_v3", "value": "Standard_L8as_v3", "description": "Standard_L8as_v3" }, { "name": "Standard_L16as_v3", "value": "Standard_L16as_v3", "description": "Standard_L16as_v3" }, { "name": "Standard_L32as_v3", "value": "Standard_L32as_v3", "description": "Standard_L32as_v3" }, { "name": "Standard_E64i_v3", "value": "Standard_E64i_v3", "description": "Standard_E64i_v3" }, { "name": "Standard_E80ids_v4", "value": "Standard_E80ids_v4", "description": "Standard_E80ids_v4" }, { "name": "Standard_E2a_v4", "value": "Standard_E2a_v4", "description": "Standard_E2a_v4" }, { "name": "Standard_E4a_v4", "value": "Standard_E4a_v4", "description": "Standard_E4a_v4" }, { "name": "Standard_E8a_v4", "value": "Standard_E8a_v4", "description": "Standard_E8a_v4" }, { "name": "Standard_E16a_v4", "value": "Standard_E16a_v4", "description": "Standard_E16a_v4" }, { "name": "Standard_E8as_v4+1TB_PS", "value": "Standard_E8as_v4+1TB_PS", "description": "Standard_E8as_v4+1TB_PS" }, { "name": "Standard_E8as_v4+2TB_PS", "value": "Standard_E8as_v4+2TB_PS", "description": "Standard_E8as_v4+2TB_PS" }, { "name": "Standard_E16as_v4+3TB_PS", "value": "Standard_E16as_v4+3TB_PS", "description": "Standard_E16as_v4+3TB_PS" }, { "name": "Standard_E16as_v4+4TB_PS", "value": "Standard_E16as_v4+4TB_PS", "description": "Standard_E16as_v4+4TB_PS" }, { "name": "Standard_E8as_v5+1TB_PS", "value": "Standard_E8as_v5+1TB_PS", "description": "Standard_E8as_v5+1TB_PS" }, { "name": "Standard_E8as_v5+2TB_PS", "value": "Standard_E8as_v5+2TB_PS", "description": "Standard_E8as_v5+2TB_PS" }, { "name": "Standard_E16as_v5+3TB_PS", "value": "Standard_E16as_v5+3TB_PS", "description": "Standard_E16as_v5+3TB_PS" }, { "name": "Standard_E16as_v5+4TB_PS", "value": "Standard_E16as_v5+4TB_PS", "description": "Standard_E16as_v5+4TB_PS" }, { "name": "Standard_E2ads_v5", "value": "Standard_E2ads_v5", "description": "Standard_E2ads_v5" }, { "name": "Standard_E4ads_v5", "value": "Standard_E4ads_v5", "description": "Standard_E4ads_v5" }, { "name": "Standard_E8ads_v5", "value": "Standard_E8ads_v5", "description": "Standard_E8ads_v5" }, { "name": "Standard_E16ads_v5", "value": "Standard_E16ads_v5", "description": "Standard_E16ads_v5" }, { "name": "Standard_EC8as_v5+1TB_PS", "value": "Standard_EC8as_v5+1TB_PS", "description": "Standard_EC8as_v5+1TB_PS" }, { "name": "Standard_EC8as_v5+2TB_PS", "value": "Standard_EC8as_v5+2TB_PS", "description": "Standard_EC8as_v5+2TB_PS" }, { "name": "Standard_EC16as_v5+3TB_PS", "value": "Standard_EC16as_v5+3TB_PS", "description": "Standard_EC16as_v5+3TB_PS" }, { "name": "Standard_EC16as_v5+4TB_PS", "value": "Standard_EC16as_v5+4TB_PS", "description": "Standard_EC16as_v5+4TB_PS" }, { "name": "Standard_EC8ads_v5", "value": "Standard_EC8ads_v5", "description": "Standard_EC8ads_v5" }, { "name": "Standard_EC16ads_v5", "value": "Standard_EC16ads_v5", "description": "Standard_EC16ads_v5" }, { "name": "Standard_E8s_v4+1TB_PS", "value": "Standard_E8s_v4+1TB_PS", "description": "Standard_E8s_v4+1TB_PS" }, { "name": "Standard_E8s_v4+2TB_PS", "value": "Standard_E8s_v4+2TB_PS", "description": "Standard_E8s_v4+2TB_PS" }, { "name": "Standard_E16s_v4+3TB_PS", "value": "Standard_E16s_v4+3TB_PS", "description": "Standard_E16s_v4+3TB_PS" }, { "name": "Standard_E16s_v4+4TB_PS", "value": "Standard_E16s_v4+4TB_PS", "description": "Standard_E16s_v4+4TB_PS" }, { "name": "Standard_E8s_v5+1TB_PS", "value": "Standard_E8s_v5+1TB_PS", "description": "Standard_E8s_v5+1TB_PS" }, { "name": "Standard_E8s_v5+2TB_PS", "value": "Standard_E8s_v5+2TB_PS", "description": "Standard_E8s_v5+2TB_PS" }, { "name": "Standard_E16s_v5+3TB_PS", "value": "Standard_E16s_v5+3TB_PS", "description": "Standard_E16s_v5+3TB_PS" }, { "name": "Standard_E16s_v5+4TB_PS", "value": "Standard_E16s_v5+4TB_PS", "description": "Standard_E16s_v5+4TB_PS" }, { "name": "Standard_E2d_v4", "value": "Standard_E2d_v4", "description": "Standard_E2d_v4" }, { "name": "Standard_E4d_v4", "value": "Standard_E4d_v4", "description": "Standard_E4d_v4" }, { "name": "Standard_E8d_v4", "value": "Standard_E8d_v4", "description": "Standard_E8d_v4" }, { "name": "Standard_E16d_v4", "value": "Standard_E16d_v4", "description": "Standard_E16d_v4" }, { "name": "Standard_E2d_v5", "value": "Standard_E2d_v5", "description": "Standard_E2d_v5" }, { "name": "Standard_E4d_v5", "value": "Standard_E4d_v5", "description": "Standard_E4d_v5" }, { "name": "Standard_E8d_v5", "value": "Standard_E8d_v5", "description": "Standard_E8d_v5" }, { "name": "Standard_E16d_v5", "value": "Standard_E16d_v5", "description": "Standard_E16d_v5" } ] } }, "AzureSkuTier": { "type": "string", "description": "SKU tier.", "enum": [ "Basic", "Standard" ], "x-ms-enum": { "name": "AzureSkuTier", "modelAsString": true, "values": [ { "name": "Basic", "value": "Basic", "description": "Basic" }, { "name": "Standard", "value": "Standard", "description": "Standard" } ] } }, "BlobStorageEventType": { "type": "string", "description": "The name of blob storage event type to process.", "enum": [ "Microsoft.Storage.BlobCreated", "Microsoft.Storage.BlobRenamed" ], "x-ms-enum": { "name": "BlobStorageEventType", "modelAsString": true, "values": [ { "name": "Microsoft.Storage.BlobCreated", "value": "Microsoft.Storage.BlobCreated", "description": "Microsoft.Storage.BlobCreated" }, { "name": "Microsoft.Storage.BlobRenamed", "value": "Microsoft.Storage.BlobRenamed", "description": "Microsoft.Storage.BlobRenamed" } ] } }, "CalloutPoliciesList": { "type": "object", "description": "A list of the service's callout policy objects.", "properties": { "value": { "type": "array", "description": "The CalloutPolicy items on this page", "items": { "$ref": "#/definitions/CalloutPolicy" } }, "nextLink": { "type": "string", "format": "uri", "title": "The URL to get the next set of callout policies list results if there are any.", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "CalloutPolicy": { "type": "object", "description": "Configuration for external callout policies, including URI patterns, access types, and service types.", "properties": { "calloutUriRegex": { "type": "string", "description": "Regular expression or FQDN pattern for the callout URI." }, "calloutType": { "$ref": "#/definitions/CalloutType", "description": "Type of the callout service, specifying the kind of external resource or service being accessed." }, "outboundAccess": { "$ref": "#/definitions/OutboundAccess", "description": "Indicates whether outbound access is permitted for the specified URI pattern." }, "calloutId": { "type": "string", "description": "Unique identifier for the callout configuration.", "readOnly": true } } }, "CalloutPolicyToRemove": { "type": "object", "description": "Configuration for an external callout policy to remove.", "properties": { "calloutId": { "type": "string", "description": "Unique identifier for the callout configuration." } } }, "CalloutType": { "type": "string", "description": "Type of the callout service, specifying the kind of external resource or service being accessed.", "enum": [ "kusto", "sql", "cosmosdb", "external_data", "azure_digital_twins", "sandbox_artifacts", "webapi", "mysql", "postgresql", "genevametrics", "azure_openai" ], "x-ms-enum": { "name": "CalloutType", "modelAsString": true, "values": [ { "name": "kusto", "value": "kusto", "description": "kusto" }, { "name": "sql", "value": "sql", "description": "sql" }, { "name": "cosmosdb", "value": "cosmosdb", "description": "cosmosdb" }, { "name": "external_data", "value": "external_data", "description": "external_data" }, { "name": "azure_digital_twins", "value": "azure_digital_twins", "description": "azure_digital_twins" }, { "name": "sandbox_artifacts", "value": "sandbox_artifacts", "description": "sandbox_artifacts" }, { "name": "webapi", "value": "webapi", "description": "webapi" }, { "name": "mysql", "value": "mysql", "description": "mysql" }, { "name": "postgresql", "value": "postgresql", "description": "postgresql" }, { "name": "genevametrics", "value": "genevametrics", "description": "genevametrics" }, { "name": "azure_openai", "value": "azure_openai", "description": "azure_openai" } ] } }, "CheckNameRequest": { "type": "object", "description": "The result returned from a database check name availability request.", "properties": { "name": { "type": "string", "description": "Resource name." }, "type": { "$ref": "#/definitions/Type", "description": "The type of resource, for instance Microsoft.Kusto/clusters/databases." } }, "required": [ "name", "type" ] }, "CheckNameResult": { "type": "object", "description": "The result returned from a check name availability request.", "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." }, "reason": { "$ref": "#/definitions/Reason", "description": "Message providing the reason why the given name is invalid." } } }, "Cluster": { "type": "object", "description": "Class representing a Kusto cluster.", "properties": { "properties": { "$ref": "#/definitions/ClusterProperties", "description": "The cluster properties.", "x-ms-client-flatten": true }, "sku": { "$ref": "#/definitions/AzureSku", "description": "The SKU of the cluster." }, "zones": { "type": "array", "description": "The availability zones.", "items": { "type": "string" } }, "identity": { "$ref": "#/definitions/Identity", "description": "The identity of the cluster, if configured." }, "etag": { "type": "string", "description": "\"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.\")", "readOnly": true } }, "required": [ "sku" ], "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" } ] }, "ClusterCheckNameRequest": { "type": "object", "description": "The result returned from a cluster check name availability request.", "properties": { "name": { "type": "string", "description": "Cluster name." }, "type": { "type": "string", "description": "The type of resource, Microsoft.Kusto/clusters.", "enum": [ "Microsoft.Kusto/clusters" ], "x-ms-enum": { "modelAsString": false } } }, "required": [ "name", "type" ] }, "ClusterListResult": { "type": "object", "description": "The list Kusto clusters operation response.", "properties": { "value": { "type": "array", "description": "The list of Kusto clusters.", "items": { "$ref": "#/definitions/Cluster" } }, "nextLink": { "type": "string", "description": "Link to the next page of results." } } }, "ClusterMigrateRequest": { "type": "object", "description": "A cluster migrate request.", "properties": { "clusterResourceId": { "type": "string", "description": "Resource ID of the destination cluster or kusto pool." } }, "required": [ "clusterResourceId" ] }, "ClusterPrincipalAssignment": { "type": "object", "description": "Class representing a cluster principal assignment.", "properties": { "properties": { "$ref": "#/definitions/ClusterPrincipalProperties", "description": "The cluster principal.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" } ] }, "ClusterPrincipalAssignmentCheckNameRequest": { "type": "object", "description": "A principal assignment check name availability request.", "properties": { "name": { "type": "string", "description": "Principal Assignment resource name." }, "type": { "type": "string", "description": "The type of resource, Microsoft.Kusto/clusters/principalAssignments.", "enum": [ "Microsoft.Kusto/clusters/principalAssignments" ], "x-ms-enum": { "modelAsString": false } } }, "required": [ "name", "type" ] }, "ClusterPrincipalAssignmentListResult": { "type": "object", "description": "The list Kusto cluster principal assignments operation response.", "properties": { "value": { "type": "array", "description": "The list of Kusto cluster principal assignments.", "items": { "$ref": "#/definitions/ClusterPrincipalAssignment" } }, "nextLink": { "type": "string", "description": "Link to the next page of results." } } }, "ClusterPrincipalProperties": { "type": "object", "description": "A class representing cluster principal property.", "properties": { "principalId": { "type": "string", "description": "The principal ID assigned to the cluster principal. It can be a user email, application ID, or security group name." }, "role": { "$ref": "#/definitions/ClusterPrincipalRole", "description": "Cluster principal role." }, "tenantId": { "type": "string", "description": "The tenant id of the principal" }, "principalType": { "$ref": "#/definitions/PrincipalType", "description": "Principal type." }, "tenantName": { "type": "string", "description": "The tenant name of the principal", "readOnly": true }, "principalName": { "type": "string", "description": "The principal name", "readOnly": true }, "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The provisioned state of the resource.", "readOnly": true }, "aadObjectId": { "type": "string", "description": "The service principal object id in AAD (Azure active directory)", "readOnly": true } }, "required": [ "principalId", "role", "principalType" ] }, "ClusterPrincipalRole": { "type": "string", "description": "Cluster principal role.", "enum": [ "AllDatabasesAdmin", "AllDatabasesViewer", "AllDatabasesMonitor" ], "x-ms-enum": { "name": "ClusterPrincipalRole", "modelAsString": true, "values": [ { "name": "AllDatabasesAdmin", "value": "AllDatabasesAdmin", "description": "AllDatabasesAdmin" }, { "name": "AllDatabasesViewer", "value": "AllDatabasesViewer", "description": "AllDatabasesViewer" }, { "name": "AllDatabasesMonitor", "value": "AllDatabasesMonitor", "description": "AllDatabasesMonitor" } ] } }, "ClusterProperties": { "type": "object", "description": "Class representing the Kusto cluster properties.", "properties": { "state": { "$ref": "#/definitions/State", "description": "The state of the resource.", "readOnly": true }, "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The provisioned state of the resource.", "readOnly": true }, "uri": { "type": "string", "description": "The cluster URI.", "readOnly": true }, "dataIngestionUri": { "type": "string", "description": "The cluster data ingestion URI.", "readOnly": true }, "stateReason": { "type": "string", "description": "The reason for the cluster's current state.", "readOnly": true }, "trustedExternalTenants": { "type": "array", "description": "The cluster's external tenants.", "items": { "$ref": "#/definitions/TrustedExternalTenant" }, "x-ms-identifiers": [] }, "optimizedAutoscale": { "$ref": "#/definitions/OptimizedAutoscale", "description": "Optimized auto scale definition." }, "enableDiskEncryption": { "type": "boolean", "description": "A boolean value that indicates if the cluster's disks are encrypted.", "default": false }, "enableStreamingIngest": { "type": "boolean", "description": "A boolean value that indicates if the streaming ingest is enabled.", "default": false }, "virtualNetworkConfiguration": { "$ref": "#/definitions/VirtualNetworkConfiguration", "description": "Virtual network definition." }, "keyVaultProperties": { "$ref": "#/definitions/KeyVaultProperties", "description": "KeyVault properties for the cluster encryption." }, "enablePurge": { "type": "boolean", "description": "A boolean value that indicates if the purge operations are enabled.", "default": false }, "languageExtensions": { "$ref": "#/definitions/LanguageExtensionsList", "description": "List of the cluster's language extensions." }, "enableDoubleEncryption": { "type": "boolean", "description": "A boolean value that indicates if double encryption is enabled.", "default": false }, "publicNetworkAccess": { "type": "string", "description": "Public network access to the cluster is enabled by default. When disabled, only private endpoint connection to the cluster is allowed", "default": "Enabled", "enum": [ "Enabled", "Disabled", "SecuredByPerimeter" ], "x-ms-enum": { "name": "PublicNetworkAccess", "modelAsString": true, "values": [ { "name": "Enabled", "value": "Enabled", "description": "Enabled" }, { "name": "Disabled", "value": "Disabled", "description": "Disabled" }, { "name": "SecuredByPerimeter", "value": "SecuredByPerimeter", "description": "SecuredByPerimeter" } ] } }, "allowedIpRangeList": { "type": "array", "description": "The list of ips in the format of CIDR allowed to connect to the cluster.", "items": { "type": "string" } }, "engineType": { "type": "string", "description": "The engine type", "default": "V3", "enum": [ "V2", "V3" ], "x-ms-enum": { "name": "EngineType", "modelAsString": true, "values": [ { "name": "V2", "value": "V2", "description": "V2" }, { "name": "V3", "value": "V3", "description": "V3" } ] } }, "acceptedAudiences": { "type": "array", "description": "The cluster's accepted audiences.", "items": { "$ref": "#/definitions/AcceptedAudiences" }, "x-ms-identifiers": [] }, "enableAutoStop": { "type": "boolean", "description": "A boolean value that indicates if the cluster could be automatically stopped (due to lack of data or no activity for many days).", "default": true }, "restrictOutboundNetworkAccess": { "type": "string", "description": "Whether or not to restrict outbound network access. Value is optional but if passed in, must be 'Enabled' or 'Disabled'", "default": "Disabled", "enum": [ "Enabled", "Disabled" ], "x-ms-enum": { "name": "ClusterNetworkAccessFlag", "modelAsString": true, "values": [ { "name": "Enabled", "value": "Enabled", "description": "Enabled" }, { "name": "Disabled", "value": "Disabled", "description": "Disabled" } ] } }, "allowedFqdnList": { "type": "array", "description": "List of allowed FQDNs(Fully Qualified Domain Name) for egress from Cluster.", "items": { "type": "string" } }, "calloutPolicies": { "type": "array", "description": "List of callout policies for egress from Cluster.", "items": { "$ref": "#/definitions/CalloutPolicy" }, "x-ms-identifiers": [] }, "publicIPType": { "type": "string", "description": "Indicates what public IP type to create - IPv4 (default), or DualStack (both IPv4 and IPv6)", "default": "IPv4", "enum": [ "IPv4", "DualStack" ], "x-ms-enum": { "name": "PublicIPType", "modelAsString": true, "values": [ { "name": "IPv4", "value": "IPv4", "description": "IPv4" }, { "name": "DualStack", "value": "DualStack", "description": "DualStack" } ] } }, "virtualClusterGraduationProperties": { "type": "string", "format": "password", "description": "Virtual Cluster graduation properties", "x-ms-mutability": [ "create" ], "x-ms-secret": true }, "privateEndpointConnections": { "type": "array", "description": "A list of private endpoint connections.", "items": { "$ref": "#/definitions/PrivateEndpointConnection" }, "readOnly": true }, "migrationCluster": { "$ref": "#/definitions/MigrationClusterProperties", "description": "Properties of the peer cluster involved in a migration to/from this cluster.", "readOnly": true }, "zoneStatus": { "$ref": "#/definitions/ZoneStatus", "description": "Indicates whether the cluster is zonal or non-zonal.", "readOnly": true } } }, "ClusterUpdate": { "type": "object", "description": "Class representing an update to a Kusto cluster.", "properties": { "tags": { "type": "object", "description": "Resource tags.", "additionalProperties": { "type": "string" }, "x-ms-mutability": [ "read", "update", "create" ] }, "location": { "type": "string", "description": "Resource location." }, "sku": { "$ref": "#/definitions/AzureSku", "description": "The SKU of the cluster." }, "zones": { "type": "array", "description": "The availability zones of the cluster.", "items": { "type": "string" } }, "identity": { "$ref": "#/definitions/Identity", "description": "The identity of the cluster, if configured." }, "properties": { "$ref": "#/definitions/ClusterProperties", "description": "The cluster properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" } ] }, "ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties": { "type": "object", "properties": { "principalId": { "type": "string", "description": "The principal id of user assigned identity.", "readOnly": true }, "clientId": { "type": "string", "description": "The client id of user assigned identity.", "readOnly": true } } }, "CosmosDbDataConnection": { "type": "object", "description": "Class representing a CosmosDb data connection.", "properties": { "properties": { "$ref": "#/definitions/CosmosDbDataConnectionProperties", "description": "The properties of the CosmosDb data connection.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/DataConnection" } ], "x-ms-discriminator-value": "CosmosDb" }, "CosmosDbDataConnectionProperties": { "type": "object", "description": "Class representing the Kusto CosmosDb data connection properties.", "properties": { "tableName": { "type": "string", "description": "The case-sensitive name of the existing target table in your cluster. Retrieved data is ingested into this table." }, "mappingRuleName": { "type": "string", "description": "The name of an existing mapping rule to use when ingesting the retrieved data." }, "managedIdentityResourceId": { "type": "string", "description": "The resource ID of a managed system or user-assigned identity. The identity is used to authenticate with Cosmos DB." }, "managedIdentityObjectId": { "type": "string", "description": "The object ID of the managed identity resource.", "readOnly": true }, "cosmosDbAccountResourceId": { "type": "string", "description": "The resource ID of the Cosmos DB account used to create the data connection." }, "cosmosDbDatabase": { "type": "string", "description": "The name of an existing database in the Cosmos DB account." }, "cosmosDbContainer": { "type": "string", "description": "The name of an existing container in the Cosmos DB database." }, "retrievalStartDate": { "type": "string", "format": "date-time", "description": "Optional. If defined, the data connection retrieves Cosmos DB documents created or updated after the specified retrieval start date." }, "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The provisioned state of the resource.", "readOnly": true } }, "required": [ "tableName", "managedIdentityResourceId", "cosmosDbAccountResourceId", "cosmosDbDatabase", "cosmosDbContainer" ] }, "DataConnection": { "type": "object", "description": "Class representing an data connection.", "properties": { "location": { "type": "string", "description": "Resource location." }, "kind": { "$ref": "#/definitions/DataConnectionKind", "description": "Kind of the endpoint for the data connection" } }, "discriminator": "kind", "required": [ "kind" ], "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" } ], "x-ms-azure-resource": true }, "DataConnectionCheckNameRequest": { "type": "object", "description": "A data connection check name availability request.", "properties": { "name": { "type": "string", "description": "Data Connection name." }, "type": { "type": "string", "description": "The type of resource, Microsoft.Kusto/clusters/databases/dataConnections.", "enum": [ "Microsoft.Kusto/clusters/databases/dataConnections" ], "x-ms-enum": { "modelAsString": false } } }, "required": [ "name", "type" ] }, "DataConnectionKind": { "type": "string", "description": "Kind of the endpoint for the data connection", "enum": [ "EventHub", "EventGrid", "IotHub", "CosmosDb", "EventHubWithManagedIdentity", "EventGridWithManagedIdentity" ], "x-ms-enum": { "name": "DataConnectionKind", "modelAsString": true, "values": [ { "name": "EventHub", "value": "EventHub", "description": "EventHub" }, { "name": "EventGrid", "value": "EventGrid", "description": "EventGrid" }, { "name": "IotHub", "value": "IotHub", "description": "IotHub" }, { "name": "CosmosDb", "value": "CosmosDb", "description": "CosmosDb" }, { "name": "EventHubWithManagedIdentity", "value": "EventHubWithManagedIdentity", "description": "EventHubWithManagedIdentity" }, { "name": "EventGridWithManagedIdentity", "value": "EventGridWithManagedIdentity", "description": "EventGridWithManagedIdentity" } ] } }, "DataConnectionListResult": { "type": "object", "description": "The list Kusto data connections operation response.", "properties": { "value": { "type": "array", "description": "The list of Kusto data connections.", "items": { "$ref": "#/definitions/DataConnection" } }, "nextLink": { "type": "string", "description": "Link to the next page of results." } } }, "DataConnectionValidation": { "type": "object", "description": "Class representing an data connection validation.", "properties": { "dataConnectionName": { "type": "string", "description": "The name of the data connection." }, "properties": { "$ref": "#/definitions/DataConnection", "description": "The data connection properties to validate." } } }, "DataConnectionValidationListResult": { "type": "object", "description": "The list Kusto data connection validation result.", "properties": { "value": { "type": "array", "description": "The list of Kusto data connection validation errors.", "items": { "$ref": "#/definitions/DataConnectionValidationResult" }, "x-ms-identifiers": [] } } }, "DataConnectionValidationResult": { "type": "object", "description": "The result returned from a data connection validation request.", "properties": { "errorMessage": { "type": "string", "description": "A message which indicates a problem in data connection validation." } } }, "Database": { "type": "object", "description": "Class representing a Kusto database.", "properties": { "location": { "type": "string", "description": "Resource location." }, "kind": { "$ref": "#/definitions/Kind", "description": "Kind of the database" } }, "discriminator": "kind", "required": [ "kind" ], "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" } ], "x-ms-azure-resource": true }, "DatabaseInviteFollowerRequest": { "type": "object", "description": "The request to invite a follower to a database.", "properties": { "inviteeEmail": { "type": "string", "description": "The email of the invited user for which the follower invitation is generated." }, "tableLevelSharingProperties": { "$ref": "#/definitions/TableLevelSharingProperties", "description": "Table level sharing specifications" } }, "required": [ "inviteeEmail" ] }, "DatabaseInviteFollowerResult": { "type": "object", "description": "The result returned from a follower invitation generation request.", "properties": { "generatedInvitation": { "type": "string", "description": "The generated invitation token." } } }, "DatabaseListResult": { "type": "object", "description": "The response of a Database list operation.", "properties": { "value": { "type": "array", "description": "The Database items on this page", "items": { "$ref": "#/definitions/Database" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "DatabasePrincipal": { "type": "object", "description": "A class representing database principal entity.", "properties": { "role": { "$ref": "#/definitions/DatabasePrincipalRole", "description": "Database principal role." }, "name": { "type": "string", "description": "Database principal name." }, "type": { "$ref": "#/definitions/DatabasePrincipalType", "description": "Database principal type." }, "fqn": { "type": "string", "description": "Database principal fully qualified name." }, "email": { "type": "string", "description": "Database principal email if exists." }, "appId": { "type": "string", "description": "Application id - relevant only for application principal type." }, "tenantName": { "type": "string", "description": "The tenant name of the principal", "readOnly": true } }, "required": [ "role", "name", "type" ] }, "DatabasePrincipalAssignment": { "type": "object", "description": "Class representing a database principal assignment.", "properties": { "properties": { "$ref": "#/definitions/DatabasePrincipalProperties", "description": "The database principal.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" } ] }, "DatabasePrincipalAssignmentCheckNameRequest": { "type": "object", "description": "A principal assignment check name availability request.", "properties": { "name": { "type": "string", "description": "Principal Assignment resource name." }, "type": { "type": "string", "description": "The type of resource, Microsoft.Kusto/clusters/databases/principalAssignments.", "enum": [ "Microsoft.Kusto/clusters/databases/principalAssignments" ], "x-ms-enum": { "modelAsString": false } } }, "required": [ "name", "type" ] }, "DatabasePrincipalAssignmentListResult": { "type": "object", "description": "The list Kusto database principal assignments operation response.", "properties": { "value": { "type": "array", "description": "The list of Kusto database principal assignments.", "items": { "$ref": "#/definitions/DatabasePrincipalAssignment" } }, "nextLink": { "type": "string", "description": "Link to the next page of results." } } }, "DatabasePrincipalListRequest": { "type": "object", "description": "The list Kusto database principals operation request.", "properties": { "value": { "type": "array", "description": "The list of Kusto database principals.", "items": { "$ref": "#/definitions/DatabasePrincipal" } } } }, "DatabasePrincipalListResult": { "type": "object", "description": "The list Kusto database principals operation response.", "properties": { "value": { "type": "array", "description": "The list of Kusto database principals.", "items": { "$ref": "#/definitions/DatabasePrincipal" } }, "nextLink": { "type": "string", "description": "Link to the next page of results." } } }, "DatabasePrincipalProperties": { "type": "object", "description": "A class representing database principal property.", "properties": { "principalId": { "type": "string", "description": "The principal ID assigned to the database principal. It can be a user email, application ID, or security group name." }, "role": { "$ref": "#/definitions/DatabasePrincipalRole", "description": "Database principal role." }, "tenantId": { "type": "string", "description": "The tenant id of the principal" }, "principalType": { "$ref": "#/definitions/PrincipalType", "description": "Principal type." }, "tenantName": { "type": "string", "description": "The tenant name of the principal", "readOnly": true }, "principalName": { "type": "string", "description": "The principal name", "readOnly": true }, "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The provisioned state of the resource.", "readOnly": true }, "aadObjectId": { "type": "string", "description": "The service principal object id in AAD (Azure active directory)", "readOnly": true } }, "required": [ "principalId", "role", "principalType" ] }, "DatabasePrincipalRole": { "type": "string", "description": "Database principal role.", "enum": [ "Admin", "Ingestor", "Monitor", "User", "UnrestrictedViewer", "Viewer" ], "x-ms-enum": { "name": "DatabasePrincipalRole", "modelAsString": true, "values": [ { "name": "Admin", "value": "Admin", "description": "Admin" }, { "name": "Ingestor", "value": "Ingestor", "description": "Ingestor" }, { "name": "Monitor", "value": "Monitor", "description": "Monitor" }, { "name": "User", "value": "User", "description": "User" }, { "name": "UnrestrictedViewer", "value": "UnrestrictedViewer", "description": "UnrestrictedViewer" }, { "name": "Viewer", "value": "Viewer", "description": "Viewer" } ] } }, "DatabasePrincipalType": { "type": "string", "description": "Database principal type.", "enum": [ "App", "Group", "User" ], "x-ms-enum": { "name": "DatabasePrincipalType", "modelAsString": true, "values": [ { "name": "App", "value": "App", "description": "App" }, { "name": "Group", "value": "Group", "description": "Group" }, { "name": "User", "value": "User", "description": "User" } ] } }, "DatabaseShareOrigin": { "type": "string", "description": "The origin of the following setup.", "enum": [ "Direct", "DataShare", "Other" ], "x-ms-enum": { "name": "DatabaseShareOrigin", "modelAsString": true, "values": [ { "name": "Direct", "value": "Direct", "description": "Direct" }, { "name": "DataShare", "value": "DataShare", "description": "DataShare" }, { "name": "Other", "value": "Other", "description": "Other" } ] } }, "DatabaseStatistics": { "type": "object", "description": "A class that contains database statistics information.", "properties": { "size": { "type": "number", "format": "float", "description": "The database size - the total size of compressed data and index in bytes." } } }, "DefaultPrincipalsModificationKind": { "type": "string", "description": "The default principals modification kind", "enum": [ "Union", "Replace", "None" ], "x-ms-enum": { "name": "DefaultPrincipalsModificationKind", "modelAsString": true, "values": [ { "name": "Union", "value": "Union", "description": "Union" }, { "name": "Replace", "value": "Replace", "description": "Replace" }, { "name": "None", "value": "None", "description": "None" } ] } }, "DiagnoseVirtualNetworkResult": { "type": "object", "properties": { "findings": { "type": "array", "description": "The list of network connectivity diagnostic finding", "items": { "type": "string" } } } }, "EndpointDependency": { "type": "object", "description": "A domain name that a service is reached at, including details of the current connection status.", "properties": { "domainName": { "type": "string", "description": "The domain name of the dependency." }, "endpointDetails": { "type": "array", "description": "The ports used when connecting to DomainName.", "items": { "$ref": "#/definitions/EndpointDetail" }, "x-ms-identifiers": [] } } }, "EndpointDetail": { "type": "object", "description": "Current TCP connectivity information from the Kusto cluster to a single endpoint.", "properties": { "port": { "type": "integer", "format": "int32", "description": "The port an endpoint is connected to." }, "ipAddress": { "type": "string", "description": "The ip address of the endpoint." } } }, "EventGridConnectionProperties": { "type": "object", "description": "Class representing the Kusto event grid connection properties.", "properties": { "storageAccountResourceId": { "type": "string", "description": "The resource ID of the storage account where the data resides." }, "eventGridResourceId": { "type": "string", "description": "The resource ID of the event grid that is subscribed to the storage account events." }, "eventHubResourceId": { "type": "string", "description": "The resource ID where the event grid is configured to send events." }, "consumerGroup": { "type": "string", "description": "The event hub consumer group." }, "tableName": { "type": "string", "description": "The table where the data should be ingested. Optionally the table information can be added to each message." }, "mappingRuleName": { "type": "string", "description": "The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message." }, "dataFormat": { "$ref": "#/definitions/EventGridDataFormat", "description": "The data format of the message. Optionally the data format can be added to each message." }, "ignoreFirstRecord": { "type": "boolean", "description": "A Boolean value that, if set to true, indicates that ingestion should ignore the first record of every file" }, "blobStorageEventType": { "$ref": "#/definitions/BlobStorageEventType", "description": "The name of blob storage event type to process." }, "managedIdentityResourceId": { "type": "string", "description": "The resource ID of a managed identity (system or user assigned) to be used to authenticate with event hub and storage account." }, "managedIdentityObjectId": { "type": "string", "description": "The object ID of managedIdentityResourceId", "readOnly": true }, "databaseRouting": { "type": "string", "description": "Indication for database routing information from the data connection, by default only database routing information is allowed", "default": "Single", "enum": [ "Single", "Multi" ], "x-ms-enum": { "name": "DatabaseRouting", "modelAsString": true, "values": [ { "name": "Single", "value": "Single", "description": "Single" }, { "name": "Multi", "value": "Multi", "description": "Multi" } ] } }, "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The provisioned state of the resource.", "readOnly": true } }, "required": [ "storageAccountResourceId", "eventHubResourceId", "consumerGroup" ] }, "EventGridConnectionWithManagedIdentityProperties": { "type": "object", "description": "Class representing the Kusto event grid connection with mandatory managed identity properties.", "properties": { "storageAccountResourceIdForManagedIdentity": { "type": "string", "description": "The resource ID of the storage account where the data resides." }, "eventHubResourceIdForManagedIdentity": { "type": "string", "description": "The resource ID of the event hub that is subscribed to the storage account events." }, "eventGridResourceId": { "type": "string", "description": "The resource ID where the event grid is configured to send events." }, "consumerGroup": { "type": "string", "description": "The event hub consumer group." }, "tableName": { "type": "string", "description": "The table where the data should be ingested. Optionally the table information can be added to each message." }, "mappingRuleName": { "type": "string", "description": "The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message." }, "dataFormat": { "$ref": "#/definitions/EventGridDataFormat", "description": "The data format of the message. Optionally the data format can be added to each message." }, "ignoreFirstRecord": { "type": "boolean", "description": "A Boolean value that, if set to true, indicates that ingestion should ignore the first record of every file" }, "blobStorageEventType": { "$ref": "#/definitions/BlobStorageEventType", "description": "The name of blob storage event type to process." }, "managedIdentityResourceId": { "type": "string", "description": "The resource ID of a managed identity (system or user assigned) to be used to authenticate with event hub and storage account." }, "managedIdentityObjectId": { "type": "string", "description": "The object ID of managedIdentityResourceId", "readOnly": true }, "databaseRouting": { "type": "string", "description": "Indication for database routing information from the data connection, by default only database routing information is allowed", "default": "Single", "enum": [ "Single", "Multi" ], "x-ms-enum": { "name": "DatabaseRouting", "modelAsString": true, "values": [ { "name": "Single", "value": "Single", "description": "Single" }, { "name": "Multi", "value": "Multi", "description": "Multi" } ] } }, "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The provisioned state of the resource.", "readOnly": true } }, "required": [ "storageAccountResourceIdForManagedIdentity", "eventHubResourceIdForManagedIdentity", "consumerGroup", "managedIdentityResourceId" ] }, "EventGridDataConnection": { "type": "object", "description": "Class representing an Event Grid data connection.", "properties": { "properties": { "$ref": "#/definitions/EventGridConnectionProperties", "description": "The properties of the Event Grid data connection.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/DataConnection" } ], "x-ms-discriminator-value": "EventGrid" }, "EventGridDataConnectionWithManagedIdentity": { "type": "object", "description": "Class representing an Event Grid data connection with mandatory managed identity.", "properties": { "properties": { "$ref": "#/definitions/EventGridConnectionWithManagedIdentityProperties", "description": "The properties of the Event Grid data connection with mandatory managed identity.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/DataConnection" } ], "x-ms-discriminator-value": "EventGridWithManagedIdentity" }, "EventGridDataFormat": { "type": "string", "description": "The data format of the message. Optionally the data format can be added to each message.", "enum": [ "MULTIJSON", "JSON", "CSV", "TSV", "SCSV", "SOHSV", "PSV", "TXT", "RAW", "SINGLEJSON", "AVRO", "TSVE", "PARQUET", "ORC", "APACHEAVRO", "W3CLOGFILE", "AZMONSTREAM" ], "x-ms-enum": { "name": "EventGridDataFormat", "modelAsString": true, "values": [ { "name": "MULTIJSON", "value": "MULTIJSON", "description": "MULTIJSON" }, { "name": "JSON", "value": "JSON", "description": "JSON" }, { "name": "CSV", "value": "CSV", "description": "CSV" }, { "name": "TSV", "value": "TSV", "description": "TSV" }, { "name": "SCSV", "value": "SCSV", "description": "SCSV" }, { "name": "SOHSV", "value": "SOHSV", "description": "SOHSV" }, { "name": "PSV", "value": "PSV", "description": "PSV" }, { "name": "TXT", "value": "TXT", "description": "TXT" }, { "name": "RAW", "value": "RAW", "description": "RAW" }, { "name": "SINGLEJSON", "value": "SINGLEJSON", "description": "SINGLEJSON" }, { "name": "AVRO", "value": "AVRO", "description": "AVRO" }, { "name": "TSVE", "value": "TSVE", "description": "TSVE" }, { "name": "PARQUET", "value": "PARQUET", "description": "PARQUET" }, { "name": "ORC", "value": "ORC", "description": "ORC" }, { "name": "APACHEAVRO", "value": "APACHEAVRO", "description": "APACHEAVRO" }, { "name": "W3CLOGFILE", "value": "W3CLOGFILE", "description": "W3CLOGFILE" }, { "name": "AZMONSTREAM", "value": "AZMONSTREAM", "description": "AZMONSTREAM" } ] } }, "EventHubConnectionProperties": { "type": "object", "description": "Class representing the Kusto event hub connection properties.", "properties": { "eventHubResourceId": { "type": "string", "description": "The resource ID of the event hub to be used to create a data connection." }, "consumerGroup": { "type": "string", "description": "The event hub consumer group." }, "tableName": { "type": "string", "description": "The table where the data should be ingested. Optionally the table information can be added to each message." }, "mappingRuleName": { "type": "string", "description": "The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message." }, "dataFormat": { "$ref": "#/definitions/EventHubDataFormat", "description": "The data format of the message. Optionally the data format can be added to each message." }, "eventSystemProperties": { "type": "array", "description": "System properties of the event hub", "items": { "type": "string" } }, "compression": { "type": "string", "description": "The compression type", "default": "None", "enum": [ "None", "GZip" ], "x-ms-enum": { "name": "Compression", "modelAsString": true, "values": [ { "name": "None", "value": "None", "description": "None" }, { "name": "GZip", "value": "GZip", "description": "GZip" } ] } }, "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The provisioned state of the resource.", "readOnly": true }, "managedIdentityResourceId": { "type": "string", "description": "The resource ID of a managed identity (system or user assigned) to be used to authenticate with event hub." }, "managedIdentityObjectId": { "type": "string", "description": "The object ID of the managedIdentityResourceId", "readOnly": true }, "databaseRouting": { "type": "string", "description": "Indication for database routing information from the data connection, by default only database routing information is allowed", "default": "Single", "enum": [ "Single", "Multi" ], "x-ms-enum": { "name": "DatabaseRouting", "modelAsString": true, "values": [ { "name": "Single", "value": "Single", "description": "Single" }, { "name": "Multi", "value": "Multi", "description": "Multi" } ] } }, "retrievalStartDate": { "type": "string", "format": "date-time", "description": "When defined, the data connection retrieves existing Event hub events created since the Retrieval start date. It can only retrieve events retained by the Event hub, based on its retention period." } }, "required": [ "eventHubResourceId", "consumerGroup" ] }, "EventHubConnectionWithManagedIdentityProperties": { "type": "object", "description": "Class representing the Kusto event hub connection with required managed identity properties.", "properties": { "eventHubResourceIdForManagedIdentity": { "type": "string", "description": "The resource ID of the event hub to be used to create a data connection." }, "consumerGroup": { "type": "string", "description": "The event hub consumer group." }, "tableName": { "type": "string", "description": "The table where the data should be ingested. Optionally the table information can be added to each message." }, "mappingRuleName": { "type": "string", "description": "The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message." }, "dataFormat": { "$ref": "#/definitions/EventHubDataFormat", "description": "The data format of the message. Optionally the data format can be added to each message." }, "eventSystemProperties": { "type": "array", "description": "System properties of the event hub", "items": { "type": "string" } }, "compression": { "type": "string", "description": "The compression type", "default": "None", "enum": [ "None", "GZip" ], "x-ms-enum": { "name": "Compression", "modelAsString": true, "values": [ { "name": "None", "value": "None", "description": "None" }, { "name": "GZip", "value": "GZip", "description": "GZip" } ] } }, "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The provisioned state of the resource.", "readOnly": true }, "managedIdentityResourceId": { "type": "string", "description": "The resource ID of a managed identity (system or user assigned) to be used to authenticate with event hub." }, "managedIdentityObjectId": { "type": "string", "description": "The object ID of the managedIdentityResourceId", "readOnly": true }, "databaseRouting": { "type": "string", "description": "Indication for database routing information from the data connection, by default only database routing information is allowed", "default": "Single", "enum": [ "Single", "Multi" ], "x-ms-enum": { "name": "DatabaseRouting", "modelAsString": true, "values": [ { "name": "Single", "value": "Single", "description": "Single" }, { "name": "Multi", "value": "Multi", "description": "Multi" } ] } }, "retrievalStartDate": { "type": "string", "format": "date-time", "description": "When defined, the data connection retrieves existing Event hub events created since the Retrieval start date. It can only retrieve events retained by the Event hub, based on its retention period." } }, "required": [ "eventHubResourceIdForManagedIdentity", "consumerGroup", "managedIdentityResourceId" ] }, "EventHubDataConnection": { "type": "object", "description": "Class representing an event hub data connection.", "properties": { "properties": { "$ref": "#/definitions/EventHubConnectionProperties", "description": "The Event Hub data connection properties to validate.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/DataConnection" } ], "x-ms-discriminator-value": "EventHub" }, "EventHubDataConnectionWithManagedIdentity": { "type": "object", "description": "Class representing an event hub data connection with required managed identity.", "properties": { "properties": { "$ref": "#/definitions/EventHubConnectionWithManagedIdentityProperties", "description": "The Event Hub data connection properties to validate.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/DataConnection" } ], "x-ms-discriminator-value": "EventHubWithManagedIdentity" }, "EventHubDataFormat": { "type": "string", "description": "The data format of the message. Optionally the data format can be added to each message.", "enum": [ "MULTIJSON", "JSON", "CSV", "TSV", "SCSV", "SOHSV", "PSV", "TXT", "RAW", "SINGLEJSON", "AVRO", "TSVE", "PARQUET", "ORC", "APACHEAVRO", "W3CLOGFILE", "AZMONSTREAM" ], "x-ms-enum": { "name": "EventHubDataFormat", "modelAsString": true, "values": [ { "name": "MULTIJSON", "value": "MULTIJSON", "description": "MULTIJSON" }, { "name": "JSON", "value": "JSON", "description": "JSON" }, { "name": "CSV", "value": "CSV", "description": "CSV" }, { "name": "TSV", "value": "TSV", "description": "TSV" }, { "name": "SCSV", "value": "SCSV", "description": "SCSV" }, { "name": "SOHSV", "value": "SOHSV", "description": "SOHSV" }, { "name": "PSV", "value": "PSV", "description": "PSV" }, { "name": "TXT", "value": "TXT", "description": "TXT" }, { "name": "RAW", "value": "RAW", "description": "RAW" }, { "name": "SINGLEJSON", "value": "SINGLEJSON", "description": "SINGLEJSON" }, { "name": "AVRO", "value": "AVRO", "description": "AVRO" }, { "name": "TSVE", "value": "TSVE", "description": "TSVE" }, { "name": "PARQUET", "value": "PARQUET", "description": "PARQUET" }, { "name": "ORC", "value": "ORC", "description": "ORC" }, { "name": "APACHEAVRO", "value": "APACHEAVRO", "description": "APACHEAVRO" }, { "name": "W3CLOGFILE", "value": "W3CLOGFILE", "description": "W3CLOGFILE" }, { "name": "AZMONSTREAM", "value": "AZMONSTREAM", "description": "AZMONSTREAM" } ] } }, "FollowerDatabaseDefinition": { "type": "object", "description": "A class representing follower database request.", "properties": { "clusterResourceId": { "type": "string", "description": "Resource id of the cluster that follows a database owned by this cluster." }, "attachedDatabaseConfigurationName": { "type": "string", "description": "Resource name of the attached database configuration in the follower cluster." }, "databaseName": { "type": "string", "description": "The database name owned by this cluster that was followed. * in case following all databases.", "readOnly": true }, "tableLevelSharingProperties": { "$ref": "#/definitions/TableLevelSharingProperties", "description": "Table level sharing specifications", "readOnly": true }, "databaseShareOrigin": { "$ref": "#/definitions/DatabaseShareOrigin", "description": "The origin of the following setup.", "readOnly": true } }, "required": [ "clusterResourceId", "attachedDatabaseConfigurationName" ] }, "FollowerDatabaseDefinitionGet": { "type": "object", "description": "A class representing follower database object.", "properties": { "properties": { "$ref": "#/definitions/FollowerDatabaseProperties", "description": "Follower database definition.", "x-ms-client-flatten": true } } }, "FollowerDatabaseListResult": { "type": "object", "description": "The list Kusto database principals operation response.", "properties": { "value": { "type": "array", "description": "The list of follower database result.", "items": { "$ref": "#/definitions/FollowerDatabaseDefinition" }, "x-ms-identifiers": [] }, "nextLink": { "type": "string", "description": "Link to the next page of results." } } }, "FollowerDatabaseListResultGet": { "type": "object", "description": "The list Kusto database principals operation response.", "properties": { "value": { "type": "array", "description": "The FollowerDatabaseDefinitionGet items on this page", "items": { "$ref": "#/definitions/FollowerDatabaseDefinitionGet" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "FollowerDatabaseProperties": { "type": "object", "description": "A class representing the properties of a follower database object.", "properties": { "clusterResourceId": { "type": "string", "description": "Resource id of the cluster that follows a database owned by this cluster." }, "attachedDatabaseConfigurationName": { "type": "string", "description": "Resource name of the attached database configuration in the follower cluster." }, "databaseName": { "type": "string", "description": "The database name owned by this cluster that was followed. * in case following all databases.", "readOnly": true }, "tableLevelSharingProperties": { "$ref": "#/definitions/TableLevelSharingProperties", "description": "Table level sharing specifications", "readOnly": true }, "databaseShareOrigin": { "$ref": "#/definitions/DatabaseShareOrigin", "description": "The origin of the following setup.", "readOnly": true } }, "required": [ "clusterResourceId", "attachedDatabaseConfigurationName" ] }, "Identity": { "type": "object", "description": "Identity for the resource.", "properties": { "principalId": { "type": "string", "description": "The principal ID of resource identity.", "readOnly": true }, "tenantId": { "type": "string", "description": "The tenant ID of resource.", "readOnly": true }, "type": { "$ref": "#/definitions/IdentityType", "description": "The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove all identities." }, "userAssignedIdentities": { "type": "object", "description": "The list of user identities associated with the Kusto cluster. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.", "additionalProperties": { "$ref": "#/definitions/ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties" } } }, "required": [ "type" ] }, "IdentityType": { "type": "string", "description": "The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove all identities.", "enum": [ "None", "SystemAssigned", "UserAssigned", "SystemAssigned, UserAssigned" ], "x-ms-enum": { "name": "IdentityType", "modelAsString": true, "values": [ { "name": "None", "value": "None", "description": "None" }, { "name": "SystemAssigned", "value": "SystemAssigned", "description": "SystemAssigned" }, { "name": "UserAssigned", "value": "UserAssigned", "description": "UserAssigned" }, { "name": "SystemAssigned, UserAssigned", "value": "SystemAssigned, UserAssigned", "description": "SystemAssigned, UserAssigned" } ] } }, "IotHubConnectionProperties": { "type": "object", "description": "Class representing the Kusto Iot hub connection properties.", "properties": { "iotHubResourceId": { "type": "string", "description": "The resource ID of the Iot hub to be used to create a data connection." }, "consumerGroup": { "type": "string", "description": "The iot hub consumer group." }, "tableName": { "type": "string", "description": "The table where the data should be ingested. Optionally the table information can be added to each message." }, "mappingRuleName": { "type": "string", "description": "The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message." }, "dataFormat": { "$ref": "#/definitions/IotHubDataFormat", "description": "The data format of the message. Optionally the data format can be added to each message." }, "eventSystemProperties": { "type": "array", "description": "System properties of the iot hub", "items": { "type": "string" } }, "sharedAccessPolicyName": { "type": "string", "description": "The name of the share access policy" }, "databaseRouting": { "type": "string", "description": "Indication for database routing information from the data connection, by default only database routing information is allowed", "default": "Single", "enum": [ "Single", "Multi" ], "x-ms-enum": { "name": "DatabaseRouting", "modelAsString": true, "values": [ { "name": "Single", "value": "Single", "description": "Single" }, { "name": "Multi", "value": "Multi", "description": "Multi" } ] } }, "retrievalStartDate": { "type": "string", "format": "date-time", "description": "When defined, the data connection retrieves existing Event hub events created since the Retrieval start date. It can only retrieve events retained by the Event hub, based on its retention period." }, "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The provisioned state of the resource.", "readOnly": true } }, "required": [ "iotHubResourceId", "consumerGroup", "sharedAccessPolicyName" ] }, "IotHubDataConnection": { "type": "object", "description": "Class representing an iot hub data connection.", "properties": { "properties": { "$ref": "#/definitions/IotHubConnectionProperties", "description": "The Iot Hub data connection properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/DataConnection" } ], "x-ms-discriminator-value": "IotHub" }, "IotHubDataFormat": { "type": "string", "description": "The data format of the message. Optionally the data format can be added to each message.", "enum": [ "MULTIJSON", "JSON", "CSV", "TSV", "SCSV", "SOHSV", "PSV", "TXT", "RAW", "SINGLEJSON", "AVRO", "TSVE", "PARQUET", "ORC", "APACHEAVRO", "W3CLOGFILE", "AZMONSTREAM" ], "x-ms-enum": { "name": "IotHubDataFormat", "modelAsString": true, "values": [ { "name": "MULTIJSON", "value": "MULTIJSON", "description": "MULTIJSON" }, { "name": "JSON", "value": "JSON", "description": "JSON" }, { "name": "CSV", "value": "CSV", "description": "CSV" }, { "name": "TSV", "value": "TSV", "description": "TSV" }, { "name": "SCSV", "value": "SCSV", "description": "SCSV" }, { "name": "SOHSV", "value": "SOHSV", "description": "SOHSV" }, { "name": "PSV", "value": "PSV", "description": "PSV" }, { "name": "TXT", "value": "TXT", "description": "TXT" }, { "name": "RAW", "value": "RAW", "description": "RAW" }, { "name": "SINGLEJSON", "value": "SINGLEJSON", "description": "SINGLEJSON" }, { "name": "AVRO", "value": "AVRO", "description": "AVRO" }, { "name": "TSVE", "value": "TSVE", "description": "TSVE" }, { "name": "PARQUET", "value": "PARQUET", "description": "PARQUET" }, { "name": "ORC", "value": "ORC", "description": "ORC" }, { "name": "APACHEAVRO", "value": "APACHEAVRO", "description": "APACHEAVRO" }, { "name": "W3CLOGFILE", "value": "W3CLOGFILE", "description": "W3CLOGFILE" }, { "name": "AZMONSTREAM", "value": "AZMONSTREAM", "description": "AZMONSTREAM" } ] } }, "KeyVaultProperties": { "type": "object", "description": "Properties of the key vault.", "properties": { "keyName": { "type": "string", "description": "The name of the key vault key.", "x-ms-client-name": "KeyName" }, "keyVersion": { "type": "string", "description": "The version of the key vault key.", "x-ms-client-name": "KeyVersion" }, "keyVaultUri": { "type": "string", "description": "The Uri of the key vault.", "x-ms-client-name": "KeyVaultUri" }, "userIdentity": { "type": "string", "description": "The user assigned identity (ARM resource id) that has access to the key. The identity must have 'Get', 'Wrap Key', and 'Unwrap Key' permissions on the Key Vault key, or be assigned the 'Key Vault Crypto Service Encryption User' role.", "x-ms-client-name": "UserIdentity" }, "federatedIdentityClientId": { "type": "string", "description": "The application (client) ID of the multi-tenant Microsoft Entra application. Used for cross-tenant customer-managed key scenarios where the encryption key is stored in a different tenant than the cluster. The application must be configured with the user-assigned managed identity as a federated identity credential.", "x-ms-client-name": "FederatedIdentityClientId" } } }, "Kind": { "type": "string", "description": "Kind of the database", "enum": [ "ReadWrite", "ReadOnlyFollowing" ], "x-ms-enum": { "name": "Kind", "modelAsString": true, "values": [ { "name": "ReadWrite", "value": "ReadWrite", "description": "ReadWrite" }, { "name": "ReadOnlyFollowing", "value": "ReadOnlyFollowing", "description": "ReadOnlyFollowing" } ] } }, "Language": { "type": "string", "description": "The language name, for example Python.", "enum": [ "Python" ], "x-ms-enum": { "name": "Language", "modelAsString": true, "values": [ { "name": "Python", "value": "Python", "description": "Python" } ] } }, "LanguageExtension": { "type": "object", "description": "The language extension object.", "properties": { "languageExtensionName": { "$ref": "#/definitions/LanguageExtensionName", "description": "The language extension name." }, "languageExtensionImageName": { "$ref": "#/definitions/LanguageExtensionImageName", "description": "The language extension image name." }, "languageExtensionCustomImageName": { "type": "string", "description": "The sandbox custom image name that should be enabled as the active language extension. Sandbox custom image is a cluster sub resource. When this property is set, LanguageExtensionImageName should be set to 'PythonCustomImage'." } } }, "LanguageExtensionImageName": { "type": "string", "description": "Language extension image name.", "enum": [ "R", "Python3_6_5", "Python3_10_8", "Python3_10_8_DL", "PythonCustomImage", "Python3_11_7", "Python3_11_7_DL" ], "x-ms-enum": { "name": "LanguageExtensionImageName", "modelAsString": true, "values": [ { "name": "R", "value": "R", "description": "R" }, { "name": "Python3_6_5", "value": "Python3_6_5", "description": "Python3_6_5" }, { "name": "Python3_10_8", "value": "Python3_10_8", "description": "Python3_10_8" }, { "name": "Python3_10_8_DL", "value": "Python3_10_8_DL", "description": "Python3_10_8_DL" }, { "name": "PythonCustomImage", "value": "PythonCustomImage", "description": "PythonCustomImage" }, { "name": "Python3_11_7", "value": "Python3_11_7", "description": "Python3_11_7" }, { "name": "Python3_11_7_DL", "value": "Python3_11_7_DL", "description": "Python3_11_7_DL" } ] } }, "LanguageExtensionName": { "type": "string", "description": "Language extension that can run within KQL query.", "enum": [ "PYTHON", "R" ], "x-ms-enum": { "name": "LanguageExtensionName", "modelAsString": true, "values": [ { "name": "PYTHON", "value": "PYTHON", "description": "PYTHON" }, { "name": "R", "value": "R", "description": "R" } ] } }, "LanguageExtensionsList": { "type": "object", "description": "The list of language extension objects.", "properties": { "value": { "type": "array", "description": "The list of language extensions.", "items": { "$ref": "#/definitions/LanguageExtension" }, "x-ms-identifiers": [] }, "nextLink": { "type": "string", "description": "The link to the next page of resources." } } }, "ListResourceSkusResult": { "type": "object", "description": "List of available SKUs for a Kusto Cluster.", "properties": { "value": { "type": "array", "description": "The collection of available SKUs for an existing resource.", "items": { "$ref": "#/definitions/AzureResourceSku" }, "x-ms-identifiers": [] }, "nextLink": { "type": "string", "description": "Link to the next page of results." } } }, "ManagedPrivateEndpoint": { "type": "object", "description": "Class representing a managed private endpoint.", "properties": { "properties": { "$ref": "#/definitions/ManagedPrivateEndpointProperties", "description": "A managed private endpoint.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" } ] }, "ManagedPrivateEndpointListResult": { "type": "object", "description": "The list managed private endpoints operation response.", "properties": { "value": { "type": "array", "description": "The list of managed private endpoints.", "items": { "$ref": "#/definitions/ManagedPrivateEndpoint" } }, "nextLink": { "type": "string", "description": "Link to the next page of results." } } }, "ManagedPrivateEndpointProperties": { "type": "object", "description": "A class representing the properties of a managed private endpoint object.", "properties": { "privateLinkResourceId": { "type": "string", "description": "The ARM resource ID of the resource for which the managed private endpoint is created." }, "privateLinkResourceRegion": { "type": "string", "description": "The region of the resource to which the managed private endpoint is created." }, "groupId": { "type": "string", "description": "The groupId in which the managed private endpoint is created." }, "requestMessage": { "type": "string", "description": "The user request message." }, "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The provisioned state of the resource.", "readOnly": true } }, "required": [ "privateLinkResourceId", "groupId" ] }, "ManagedPrivateEndpointsCheckNameRequest": { "type": "object", "description": "The result returned from a managedPrivateEndpoints check name availability request.", "properties": { "name": { "type": "string", "description": "Managed private endpoint resource name." }, "type": { "type": "string", "description": "The type of resource, for instance Microsoft.Kusto/clusters/managedPrivateEndpoints.", "enum": [ "Microsoft.Kusto/clusters/managedPrivateEndpoints" ], "x-ms-enum": { "modelAsString": false } } }, "required": [ "name", "type" ] }, "MigrationClusterProperties": { "type": "object", "description": "Represents a properties of a cluster that is part of a migration.", "properties": { "id": { "type": "string", "description": "The resource ID of the cluster.", "readOnly": true }, "uri": { "type": "string", "description": "The public URL of the cluster.", "readOnly": true }, "dataIngestionUri": { "type": "string", "description": "The public data ingestion URL of the cluster.", "readOnly": true }, "role": { "$ref": "#/definitions/MigrationClusterRole", "description": "The role of the cluster in the migration process.", "readOnly": true } } }, "MigrationClusterRole": { "type": "string", "description": "The role of the cluster in the migration process.", "enum": [ "Source", "Destination" ], "x-ms-enum": { "name": "MigrationClusterRole", "modelAsString": true, "values": [ { "name": "Source", "value": "Source", "description": "Source" }, { "name": "Destination", "value": "Destination", "description": "Destination" } ] } }, "Operation": { "type": "object", "title": "A REST API operation", "description": "A REST API operation", "properties": { "name": { "type": "string", "title": "The operation name.", "description": "This is of the format {provider}/{resource}/{operation}." }, "display": { "$ref": "#/definitions/OperationDisplay", "title": "The object that describes the operation.", "description": "The object that describes the operation." }, "origin": { "type": "string", "title": "The intended executor of the operation.", "description": "The intended executor of the operation." }, "properties": { "title": "Properties of the operation.", "description": "Properties of the operation.", "x-ms-client-flatten": true } } }, "OperationDisplay": { "type": "object", "description": "The object that describes the operation.", "properties": { "provider": { "type": "string", "title": "Friendly name of the resource provider.", "description": "Friendly name of the resource provider." }, "operation": { "type": "string", "title": "The operation type.", "description": "For example: read, write, delete." }, "resource": { "type": "string", "title": "The resource type on which the operation is performed.", "description": "The resource type on which the operation is performed." }, "description": { "type": "string", "title": "The friendly name of the operation.", "description": "The friendly name of the operation." } } }, "OperationListResult": { "type": "object", "title": "Result of the request to list REST API operations. It contains a list of operations and a URL nextLink to get the next set of results.", "description": "Result of the request to list REST API operations. It contains a list of operations and a URL nextLink to get the next set of results.", "properties": { "value": { "type": "array", "title": "The list of operations supported by the resource provider.", "description": "The list of operations supported by the resource provider.", "items": { "$ref": "#/definitions/Operation" } }, "nextLink": { "type": "string", "title": "The URL to get the next set of operation list results if there are any.", "description": "Link to the next page of results." } } }, "OperationResult": { "type": "object", "description": "Operation Result Entity.", "properties": { "id": { "type": "string", "description": "ID of the resource.", "readOnly": true }, "name": { "type": "string", "description": "Name of the resource.", "readOnly": true }, "status": { "$ref": "#/definitions/Status", "description": "status of the Operation result.", "readOnly": true }, "startTime": { "type": "string", "format": "date-time", "description": "The operation start time" }, "endTime": { "type": "string", "format": "date-time", "description": "The operation end time" }, "percentComplete": { "type": "number", "format": "double", "description": "Percentage completed.", "minimum": 0, "maximum": 100 }, "properties": { "$ref": "#/definitions/OperationResultProperties", "description": "Properties of the operation results", "x-ms-client-flatten": true }, "error": { "$ref": "#/definitions/OperationResultErrorProperties", "description": "Object that contains the error code and message if the operation failed.", "x-ms-client-flatten": true } } }, "OperationResultErrorProperties": { "type": "object", "description": "Operation result error properties", "properties": { "code": { "type": "string", "description": "The code of the error." }, "message": { "type": "string", "description": "The error message." } } }, "OperationResultProperties": { "type": "object", "description": "Operation result properties", "properties": { "operationKind": { "type": "string", "description": "The kind of the operation." }, "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The provisioned state of the resource.", "readOnly": true }, "operationState": { "type": "string", "description": "The state of the operation." } } }, "OptimizedAutoscale": { "type": "object", "description": "A class that contains the optimized auto scale definition.", "properties": { "version": { "type": "integer", "format": "int32", "description": "The version of the template defined, for instance 1." }, "isEnabled": { "type": "boolean", "description": "A boolean value that indicate if the optimized autoscale feature is enabled or not." }, "minimum": { "type": "integer", "format": "int32", "description": "Minimum allowed instances count." }, "maximum": { "type": "integer", "format": "int32", "description": "Maximum allowed instances count." } }, "required": [ "version", "isEnabled", "minimum", "maximum" ] }, "OutboundAccess": { "type": "string", "description": "Indicates whether outbound access is permitted for the specified URI pattern.", "enum": [ "Allow", "Deny" ], "x-ms-enum": { "name": "OutboundAccess", "modelAsString": true, "values": [ { "name": "Allow", "value": "Allow", "description": "Allow" }, { "name": "Deny", "value": "Deny", "description": "Deny" } ] } }, "OutboundNetworkDependenciesEndpoint": { "type": "object", "description": "Endpoints accessed for a common purpose that the Kusto Service Environment requires outbound network access to.", "properties": { "properties": { "$ref": "#/definitions/OutboundNetworkDependenciesEndpointProperties", "description": "The outbound environment endpoint properties.", "x-ms-client-flatten": true }, "etag": { "type": "string", "description": "A unique read-only string that changes whenever the resource is updated.", "readOnly": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" } ] }, "OutboundNetworkDependenciesEndpointListResult": { "type": "object", "description": "The response of a OutboundNetworkDependenciesEndpoint list operation.", "properties": { "value": { "type": "array", "description": "The OutboundNetworkDependenciesEndpoint items on this page", "items": { "$ref": "#/definitions/OutboundNetworkDependenciesEndpoint" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "OutboundNetworkDependenciesEndpointProperties": { "type": "object", "description": "Endpoints accessed for a common purpose that the Kusto Service Environment requires outbound network access to.", "properties": { "category": { "type": "string", "description": "The type of service accessed by the Kusto Service Environment, e.g., Azure Storage, Azure SQL Database, and Azure Active Directory." }, "endpoints": { "type": "array", "description": "The endpoints that the Kusto Service Environment reaches the service at.", "items": { "$ref": "#/definitions/EndpointDependency" }, "x-ms-identifiers": [] }, "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The provisioned state of the resource.", "readOnly": true } } }, "PrincipalPermissionsAction": { "type": "string", "description": "Indicates if the permissions for the script caller are kept following completion of the script.", "enum": [ "RetainPermissionOnScriptCompletion", "RemovePermissionOnScriptCompletion" ], "x-ms-enum": { "name": "PrincipalPermissionsAction", "modelAsString": true, "values": [ { "name": "RetainPermissionOnScriptCompletion", "value": "RetainPermissionOnScriptCompletion", "description": "RetainPermissionOnScriptCompletion" }, { "name": "RemovePermissionOnScriptCompletion", "value": "RemovePermissionOnScriptCompletion", "description": "RemovePermissionOnScriptCompletion" } ] } }, "PrincipalType": { "type": "string", "description": "Principal type.", "enum": [ "App", "Group", "User" ], "x-ms-enum": { "name": "PrincipalType", "modelAsString": true, "values": [ { "name": "App", "value": "App", "description": "App" }, { "name": "Group", "value": "Group", "description": "Group" }, { "name": "User", "value": "User", "description": "User" } ] } }, "PrincipalsModificationKind": { "type": "string", "description": "The principals modification kind of the database", "enum": [ "Union", "Replace", "None" ], "x-ms-enum": { "name": "PrincipalsModificationKind", "modelAsString": true, "values": [ { "name": "Union", "value": "Union", "description": "Union" }, { "name": "Replace", "value": "Replace", "description": "Replace" }, { "name": "None", "value": "None", "description": "None" } ] } }, "PrivateEndpointConnection": { "type": "object", "description": "A private endpoint connection", "properties": { "properties": { "$ref": "#/definitions/PrivateEndpointConnectionProperties", "description": "Resource properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" } ] }, "PrivateEndpointConnectionListResult": { "type": "object", "description": "A list of private endpoint connections", "properties": { "value": { "type": "array", "description": "Array of private endpoint connections", "items": { "$ref": "#/definitions/PrivateEndpointConnection" } }, "nextLink": { "type": "string", "description": "Link to the next page of results." } } }, "PrivateEndpointConnectionProperties": { "type": "object", "description": "Properties of a private endpoint connection.", "properties": { "privateEndpoint": { "$ref": "#/definitions/PrivateEndpointProperty", "description": "Private endpoint which the connection belongs to.", "readOnly": true }, "privateLinkServiceConnectionState": { "$ref": "#/definitions/PrivateLinkServiceConnectionStateProperty", "description": "Connection State of the Private Endpoint Connection." }, "groupId": { "type": "string", "description": "Group id of the private endpoint.", "readOnly": true }, "provisioningState": { "type": "string", "description": "Provisioning state of the private endpoint.", "readOnly": true } }, "required": [ "privateLinkServiceConnectionState" ] }, "PrivateEndpointProperty": { "type": "object", "description": "Private endpoint which the connection belongs to.", "properties": { "id": { "type": "string", "description": "Resource id of the private endpoint.", "readOnly": true } } }, "PrivateLinkResource": { "type": "object", "description": "A private link resource", "properties": { "properties": { "$ref": "#/definitions/PrivateLinkResourceProperties", "description": "Resource properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" } ] }, "PrivateLinkResourceListResult": { "type": "object", "description": "A list of private link resources", "properties": { "value": { "type": "array", "description": "Array of private link resources", "items": { "$ref": "#/definitions/PrivateLinkResource" } }, "nextLink": { "type": "string", "description": "Link to the next page of results." } } }, "PrivateLinkResourceProperties": { "type": "object", "description": "Properties of a private link resource.", "properties": { "groupId": { "type": "string", "description": "The private link resource group id.", "readOnly": true }, "requiredMembers": { "type": "array", "description": "The private link resource required member names.", "items": { "type": "string" }, "readOnly": true }, "requiredZoneNames": { "type": "array", "description": "The private link resource required zone names.", "items": { "type": "string" }, "readOnly": true } } }, "PrivateLinkServiceConnectionStateProperty": { "type": "object", "description": "Connection State of the Private Endpoint Connection.", "properties": { "status": { "type": "string", "description": "The private link service connection status." }, "description": { "type": "string", "description": "The private link service connection description." }, "actionsRequired": { "type": "string", "description": "Any action that is required beyond basic workflow (approve/ reject/ disconnect)", "readOnly": true } } }, "ProvisioningState": { "type": "string", "description": "The provisioned state of the resource.", "enum": [ "Running", "Creating", "Deleting", "Succeeded", "Failed", "Moving", "Canceled" ], "x-ms-enum": { "name": "ProvisioningState", "modelAsString": true, "values": [ { "name": "Running", "value": "Running", "description": "Running" }, { "name": "Creating", "value": "Creating", "description": "Creating" }, { "name": "Deleting", "value": "Deleting", "description": "Deleting" }, { "name": "Succeeded", "value": "Succeeded", "description": "Succeeded" }, { "name": "Failed", "value": "Failed", "description": "Failed" }, { "name": "Moving", "value": "Moving", "description": "Moving" }, { "name": "Canceled", "value": "Canceled", "description": "Canceled" } ] } }, "ReadOnlyFollowingDatabase": { "type": "object", "description": "Class representing a read only following database.", "properties": { "properties": { "$ref": "#/definitions/ReadOnlyFollowingDatabaseProperties", "description": "The database properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Database" } ], "x-ms-discriminator-value": "ReadOnlyFollowing" }, "ReadOnlyFollowingDatabaseProperties": { "type": "object", "description": "Class representing the Kusto database properties.", "properties": { "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The provisioned state of the resource.", "readOnly": true }, "softDeletePeriod": { "type": "string", "format": "duration", "description": "The time the data should be kept before it stops being accessible to queries in TimeSpan.", "readOnly": true }, "hotCachePeriod": { "type": "string", "format": "duration", "description": "The time the data should be kept in cache for fast queries in TimeSpan." }, "statistics": { "$ref": "#/definitions/DatabaseStatistics", "description": "The statistics of the database.", "readOnly": true }, "leaderClusterResourceId": { "type": "string", "description": "The name of the leader cluster", "readOnly": true }, "attachedDatabaseConfigurationName": { "type": "string", "description": "The name of the attached database configuration cluster", "readOnly": true }, "principalsModificationKind": { "$ref": "#/definitions/PrincipalsModificationKind", "description": "The principals modification kind of the database", "readOnly": true }, "tableLevelSharingProperties": { "$ref": "#/definitions/TableLevelSharingProperties", "description": "Table level sharing specifications", "readOnly": true }, "originalDatabaseName": { "type": "string", "description": "The original database name, before databaseNameOverride or databaseNamePrefix where applied.", "readOnly": true }, "databaseShareOrigin": { "$ref": "#/definitions/DatabaseShareOrigin", "description": "The origin of the following setup.", "readOnly": true }, "suspensionDetails": { "$ref": "#/definitions/SuspensionDetails", "description": "The database suspension details. If the database is suspended, this object contains information related to the database's suspension state.", "readOnly": true } } }, "ReadWriteDatabase": { "type": "object", "description": "Class representing a read write database.", "properties": { "properties": { "$ref": "#/definitions/ReadWriteDatabaseProperties", "description": "The database properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Database" } ], "x-ms-discriminator-value": "ReadWrite" }, "ReadWriteDatabaseProperties": { "type": "object", "description": "Class representing the Kusto database properties.", "properties": { "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The provisioned state of the resource.", "readOnly": true }, "softDeletePeriod": { "type": "string", "format": "duration", "description": "The time the data should be kept before it stops being accessible to queries in TimeSpan." }, "hotCachePeriod": { "type": "string", "format": "duration", "description": "The time the data should be kept in cache for fast queries in TimeSpan." }, "statistics": { "$ref": "#/definitions/DatabaseStatistics", "description": "The statistics of the database.", "readOnly": true }, "isFollowed": { "type": "boolean", "description": "Indicates whether the database is followed.", "readOnly": true }, "keyVaultProperties": { "$ref": "#/definitions/KeyVaultProperties", "description": "KeyVault properties for the database encryption." }, "suspensionDetails": { "$ref": "#/definitions/SuspensionDetails", "description": "The database suspension details. If the database is suspended, this object contains information related to the database's suspension state.", "readOnly": true } } }, "Reason": { "type": "string", "description": "Message providing the reason why the given name is invalid.", "enum": [ "Invalid", "AlreadyExists" ], "x-ms-enum": { "name": "Reason", "modelAsString": true, "values": [ { "name": "Invalid", "value": "Invalid", "description": "Invalid" }, { "name": "AlreadyExists", "value": "AlreadyExists", "description": "AlreadyExists" } ] } }, "ResourceSkuCapabilities": { "type": "object", "description": "Describes The SKU capabilities object.", "properties": { "name": { "type": "string", "description": "An invariant to describe the feature.", "readOnly": true }, "value": { "type": "string", "description": "An invariant if the feature is measured by quantity.", "readOnly": true } } }, "ResourceSkuZoneDetails": { "type": "object", "description": "Describes The zonal capabilities of a SKU.", "properties": { "name": { "type": "array", "description": "The set of zones that the SKU is available in with the specified capabilities.", "items": { "type": "string" }, "readOnly": true }, "capabilities": { "type": "array", "description": "A list of capabilities that are available for the SKU in the specified list of zones.", "items": { "$ref": "#/definitions/ResourceSkuCapabilities" }, "readOnly": true, "x-ms-identifiers": [ "name" ] } } }, "SandboxCustomImage": { "type": "object", "description": "Class representing a Kusto sandbox custom image.", "properties": { "properties": { "$ref": "#/definitions/SandboxCustomImageProperties", "description": "A sandbox custom image.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" } ] }, "SandboxCustomImageProperties": { "type": "object", "description": "A class representing the properties of a sandbox custom image object.", "properties": { "language": { "$ref": "#/definitions/Language", "description": "The language name, for example Python." }, "languageVersion": { "type": "string", "description": "The version of the language. Either this property or baseImageName should be specified." }, "baseImageName": { "type": "string", "description": "The base image name on which the custom image is built on top of. It can be one of the LanguageExtensionImageName (e.g.: 'Python3_10_8', 'Python3_10_8_DL') or the name of an existing custom image. Either this property or languageVersion should be specified." }, "requirementsFileContent": { "type": "string", "description": "The requirements file content." }, "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The provisioned state of the resource.", "readOnly": true } }, "required": [ "language" ] }, "SandboxCustomImagesCheckNameRequest": { "type": "object", "description": "The result returned from a sandboxCustomImage check name availability request.", "properties": { "name": { "type": "string", "description": "Sandbox custom image resource name." }, "type": { "type": "string", "description": "The type of resource, for instance Microsoft.Kusto/clusters/sandboxCustomImages.", "enum": [ "Microsoft.Kusto/clusters/sandboxCustomImages" ], "x-ms-enum": { "modelAsString": false } } }, "required": [ "name", "type" ] }, "SandboxCustomImagesListResult": { "type": "object", "description": "The list Kusto sandbox custom images operation response.", "properties": { "value": { "type": "array", "description": "The SandboxCustomImage items on this page", "items": { "$ref": "#/definitions/SandboxCustomImage" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "Script": { "type": "object", "description": "Class representing a database script.", "properties": { "properties": { "$ref": "#/definitions/ScriptProperties", "description": "The database script.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" } ] }, "ScriptCheckNameRequest": { "type": "object", "description": "A script name availability request.", "properties": { "name": { "type": "string", "description": "Script name." }, "type": { "type": "string", "description": "The type of resource, Microsoft.Kusto/clusters/databases/scripts.", "enum": [ "Microsoft.Kusto/clusters/databases/scripts" ], "x-ms-enum": { "modelAsString": false } } }, "required": [ "name", "type" ] }, "ScriptLevel": { "type": "string", "description": "Differentiates between the type of script commands included - Database or Cluster. The default is Database.", "enum": [ "Database", "Cluster" ], "x-ms-enum": { "name": "ScriptLevel", "modelAsString": true, "values": [ { "name": "Database", "value": "Database", "description": "Database" }, { "name": "Cluster", "value": "Cluster", "description": "Cluster" } ] } }, "ScriptListResult": { "type": "object", "description": "The list Kusto database script operation response.", "properties": { "value": { "type": "array", "description": "The list of Kusto scripts.", "items": { "$ref": "#/definitions/Script" } }, "nextLink": { "type": "string", "description": "Link to the next page of results." } } }, "ScriptProperties": { "type": "object", "description": "A class representing database script property.", "properties": { "scriptUrl": { "type": "string", "description": "The url to the KQL script blob file. Must not be used together with scriptContent property" }, "scriptUrlSasToken": { "type": "string", "format": "password", "description": "The SaS token that provide read access to the file which contain the script. Must be provided when using scriptUrl property.", "x-ms-mutability": [ "create" ], "x-ms-secret": true }, "scriptContent": { "type": "string", "format": "password", "description": "The script content. This property should be used when the script is provide inline and not through file in a SA. Must not be used together with scriptUrl and scriptUrlSasToken properties.", "x-ms-mutability": [ "create" ], "x-ms-secret": true }, "forceUpdateTag": { "type": "string", "description": "A unique string. If changed the script will be applied again." }, "continueOnErrors": { "type": "boolean", "description": "Flag that indicates whether to continue if one of the command fails.", "default": false }, "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The provisioned state of the resource.", "readOnly": true }, "scriptLevel": { "$ref": "#/definitions/ScriptLevel", "description": "Differentiates between the type of script commands included - Database or Cluster. The default is Database." }, "principalPermissionsAction": { "$ref": "#/definitions/PrincipalPermissionsAction", "description": "Indicates if the permissions for the script caller are kept following completion of the script." }, "managedIdentityResourceId": { "type": "string", "description": "The resource identifier of the managed identity to be used. When provided, the managed identity will be used to read the script content from the scriptUrl." } } }, "SkuDescription": { "type": "object", "description": "The Kusto SKU description of given resource type", "properties": { "resourceType": { "type": "string", "description": "The resource type", "readOnly": true }, "name": { "type": "string", "description": "The name of the SKU", "readOnly": true }, "tier": { "type": "string", "description": "The tier of the SKU", "readOnly": true }, "locations": { "type": "array", "description": "The set of locations that the SKU is available", "items": { "type": "string" }, "readOnly": true }, "locationInfo": { "type": "array", "description": "Locations and zones", "items": { "$ref": "#/definitions/SkuLocationInfoItem" }, "readOnly": true, "x-ms-identifiers": [] }, "restrictions": { "type": "array", "description": "The restrictions because of which SKU cannot be used", "items": {}, "readOnly": true } } }, "SkuDescriptionList": { "type": "object", "description": "The list of the EngagementFabric SKU descriptions", "properties": { "value": { "type": "array", "description": "SKU descriptions", "items": { "$ref": "#/definitions/SkuDescription" }, "readOnly": true }, "nextLink": { "type": "string", "description": "Link to the next page of results." } } }, "SkuLocationInfoItem": { "type": "object", "description": "The locations and zones info for SKU.", "properties": { "location": { "type": "string", "description": "The available location of the SKU." }, "zones": { "type": "array", "description": "The available zone of the SKU.", "items": { "type": "string" } }, "zoneDetails": { "type": "array", "description": "Gets details of capabilities available to a SKU in specific zones.", "items": { "$ref": "#/definitions/ResourceSkuZoneDetails" }, "x-ms-identifiers": [ "name" ] } }, "required": [ "location" ] }, "State": { "type": "string", "description": "The state of the resource.", "enum": [ "Creating", "Unavailable", "Running", "Deleting", "Deleted", "Stopping", "Stopped", "Starting", "Updating", "Migrated" ], "x-ms-enum": { "name": "State", "modelAsString": true, "values": [ { "name": "Creating", "value": "Creating", "description": "Creating" }, { "name": "Unavailable", "value": "Unavailable", "description": "Unavailable" }, { "name": "Running", "value": "Running", "description": "Running" }, { "name": "Deleting", "value": "Deleting", "description": "Deleting" }, { "name": "Deleted", "value": "Deleted", "description": "Deleted" }, { "name": "Stopping", "value": "Stopping", "description": "Stopping" }, { "name": "Stopped", "value": "Stopped", "description": "Stopped" }, { "name": "Starting", "value": "Starting", "description": "Starting" }, { "name": "Updating", "value": "Updating", "description": "Updating" }, { "name": "Migrated", "value": "Migrated", "description": "Migrated" } ] } }, "Status": { "type": "string", "description": "The status of operation.", "enum": [ "Succeeded", "Canceled", "Failed", "Running" ], "x-ms-enum": { "name": "Status", "modelAsString": true, "values": [ { "name": "Succeeded", "value": "Succeeded", "description": "Succeeded" }, { "name": "Canceled", "value": "Canceled", "description": "Canceled" }, { "name": "Failed", "value": "Failed", "description": "Failed" }, { "name": "Running", "value": "Running", "description": "Running" } ] } }, "SuspensionDetails": { "type": "object", "description": "The database suspension details. If the database is suspended, this object contains information related to the database's suspension state.", "properties": { "suspensionStartDate": { "type": "string", "format": "date-time", "description": "The starting date and time of the suspension state." } } }, "TableLevelSharingProperties": { "type": "object", "description": "Tables that will be included and excluded in the follower database", "properties": { "tablesToInclude": { "type": "array", "description": "List of tables to include in the follower database", "items": { "type": "string" } }, "tablesToExclude": { "type": "array", "description": "List of tables to exclude from the follower database", "items": { "type": "string" } }, "externalTablesToInclude": { "type": "array", "description": "List of external tables to include in the follower database", "items": { "type": "string" } }, "externalTablesToExclude": { "type": "array", "description": "List of external tables to exclude from the follower database", "items": { "type": "string" } }, "materializedViewsToInclude": { "type": "array", "description": "List of materialized views to include in the follower database", "items": { "type": "string" } }, "materializedViewsToExclude": { "type": "array", "description": "List of materialized views to exclude from the follower database", "items": { "type": "string" } }, "functionsToInclude": { "type": "array", "description": "List of functions to include in the follower database", "items": { "type": "string" } }, "functionsToExclude": { "type": "array", "description": "List of functions to exclude from the follower database", "items": { "type": "string" } } } }, "TrustedExternalTenant": { "type": "object", "description": "Represents a tenant ID that is trusted by the cluster.", "properties": { "value": { "type": "string", "description": "GUID representing an external tenant." } } }, "Type": { "type": "string", "description": "The type of resource, for instance Microsoft.Kusto/clusters/databases.", "enum": [ "Microsoft.Kusto/clusters/databases", "Microsoft.Kusto/clusters/attachedDatabaseConfigurations" ], "x-ms-enum": { "name": "Type", "modelAsString": false, "values": [ { "name": "Microsoft.Kusto/clusters/databases", "value": "Microsoft.Kusto/clusters/databases", "description": "Microsoft.Kusto/clusters/databases" }, { "name": "Microsoft.Kusto/clusters/attachedDatabaseConfigurations", "value": "Microsoft.Kusto/clusters/attachedDatabaseConfigurations", "description": "Microsoft.Kusto/clusters/attachedDatabaseConfigurations" } ] } }, "VirtualNetworkConfiguration": { "type": "object", "description": "A class that contains virtual network definition.", "properties": { "subnetId": { "type": "string", "description": "The subnet resource id.", "x-ms-mutability": [ "read", "create" ] }, "enginePublicIpId": { "type": "string", "description": "Engine service's public IP address resource id.", "x-ms-mutability": [ "read", "create" ] }, "dataManagementPublicIpId": { "type": "string", "description": "Data management's service public IP address resource id.", "x-ms-mutability": [ "read", "create" ] }, "state": { "type": "string", "description": "When enabled, the cluster is deployed into the configured subnet, when disabled it will be removed from the subnet.", "default": "Enabled", "enum": [ "Enabled", "Disabled" ], "x-ms-enum": { "name": "VnetState", "modelAsString": true, "values": [ { "name": "Enabled", "value": "Enabled", "description": "Enabled" }, { "name": "Disabled", "value": "Disabled", "description": "Disabled" } ] } } }, "required": [ "subnetId", "enginePublicIpId", "dataManagementPublicIpId" ] }, "ZoneStatus": { "type": "string", "description": "Indicates whether the cluster is zonal or non-zonal.", "enum": [ "NonZonal", "ZonalInconsistency", "Zonal" ], "x-ms-enum": { "name": "ZoneStatus", "modelAsString": true, "values": [ { "name": "NonZonal", "value": "NonZonal", "description": "NonZonal" }, { "name": "ZonalInconsistency", "value": "ZonalInconsistency", "description": "ZonalInconsistency" }, { "name": "Zonal", "value": "Zonal", "description": "Zonal" } ] } } }, "parameters": {} }