kusto.azure.com/v1api20230815
APIVersion
| Value | Description |
|---|---|
| “2023-08-15” |
Cluster
Generator information: - Generated from: /azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/kusto.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}
Used by: ClusterList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | Cluster_Spec Optional |
|
| status | Cluster_STATUS Optional |
Cluster_Spec
| Property | Description | Type |
|---|---|---|
| acceptedAudiences | The cluster’s accepted audiences. | AcceptedAudiences[] Optional |
| allowedFqdnList | List of allowed FQDNs(Fully Qualified Domain Name) for egress from Cluster. | string[] Optional |
| allowedIpRangeList | The list of ips in the format of CIDR allowed to connect to the cluster. | string[] Optional |
| azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
| enableAutoStop | A boolean value that indicates if the cluster could be automatically stopped (due to lack of data or no activity for many days). | bool Optional |
| enableDiskEncryption | A boolean value that indicates if the cluster’s disks are encrypted. | bool Optional |
| enableDoubleEncryption | A boolean value that indicates if double encryption is enabled. | bool Optional |
| enablePurge | A boolean value that indicates if the purge operations are enabled. | bool Optional |
| enableStreamingIngest | A boolean value that indicates if the streaming ingest is enabled. | bool Optional |
| engineType | The engine type | ClusterProperties_EngineType Optional |
| identity | The identity of the cluster, if configured. | Identity Optional |
| keyVaultProperties | KeyVault properties for the cluster encryption. | KeyVaultProperties Optional |
| languageExtensions | List of the cluster’s language extensions. | LanguageExtensionsList Optional |
| location | The geo-location where the resource lives | string Required |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | ClusterOperatorSpec Optional |
| optimizedAutoscale | Optimized auto scale definition. | OptimizedAutoscale Optional |
| owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource | genruntime.KnownResourceReference Required |
| publicIPType | Indicates what public IP type to create - IPv4 (default), or DualStack (both IPv4 and IPv6) | ClusterProperties_PublicIPType Optional |
| publicNetworkAccess | Public network access to the cluster is enabled by default. When disabled, only private endpoint connection to the cluster is allowed | ClusterProperties_PublicNetworkAccess Optional |
| restrictOutboundNetworkAccess | Whether or not to restrict outbound network access. Value is optional but if passed in, must be ‘Enabled’ or ‘Disabled’ | ClusterProperties_RestrictOutboundNetworkAccess Optional |
| sku | The SKU of the cluster. | AzureSku Required |
| tags | Resource tags. | map[string]string Optional |
| trustedExternalTenants | The cluster’s external tenants. | TrustedExternalTenant[] Optional |
| virtualClusterGraduationProperties | Virtual Cluster graduation properties | genruntime.SecretReference Optional |
| virtualNetworkConfiguration | Virtual network definition. | VirtualNetworkConfiguration Optional |
| zones | The availability zones of the cluster. | string[] Optional |
Cluster_STATUS
| Property | Description | Type |
|---|---|---|
| acceptedAudiences | The cluster’s accepted audiences. | AcceptedAudiences_STATUS[] Optional |
| allowedFqdnList | List of allowed FQDNs(Fully Qualified Domain Name) for egress from Cluster. | string[] Optional |
| allowedIpRangeList | The list of ips in the format of CIDR allowed to connect to the cluster. | string[] Optional |
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| dataIngestionUri | The cluster data ingestion URI. | string Optional |
| enableAutoStop | A boolean value that indicates if the cluster could be automatically stopped (due to lack of data or no activity for many days). | bool Optional |
| enableDiskEncryption | A boolean value that indicates if the cluster’s disks are encrypted. | bool Optional |
| enableDoubleEncryption | A boolean value that indicates if double encryption is enabled. | bool Optional |
| enablePurge | A boolean value that indicates if the purge operations are enabled. | bool Optional |
| enableStreamingIngest | A boolean value that indicates if the streaming ingest is enabled. | bool Optional |
| engineType | The engine type | ClusterProperties_EngineType_STATUS Optional |
| etag | A unique read-only string that changes whenever the resource is updated. | string Optional |
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
| identity | The identity of the cluster, if configured. | Identity_STATUS Optional |
| keyVaultProperties | KeyVault properties for the cluster encryption. | KeyVaultProperties_STATUS Optional |
| languageExtensions | List of the cluster’s language extensions. | LanguageExtensionsList_STATUS Optional |
| location | The geo-location where the resource lives | string Optional |
| migrationCluster | Properties of the peer cluster involved in a migration to/from this cluster. | MigrationClusterProperties_STATUS Optional |
| name | The name of the resource | string Optional |
| optimizedAutoscale | Optimized auto scale definition. | OptimizedAutoscale_STATUS Optional |
| privateEndpointConnections | A list of private endpoint connections. | PrivateEndpointConnection_STATUS[] Optional |
| provisioningState | The provisioned state of the resource. | ProvisioningState_STATUS Optional |
| publicIPType | Indicates what public IP type to create - IPv4 (default), or DualStack (both IPv4 and IPv6) | ClusterProperties_PublicIPType_STATUS Optional |
| publicNetworkAccess | Public network access to the cluster is enabled by default. When disabled, only private endpoint connection to the cluster is allowed | ClusterProperties_PublicNetworkAccess_STATUS Optional |
| restrictOutboundNetworkAccess | Whether or not to restrict outbound network access. Value is optional but if passed in, must be ‘Enabled’ or ‘Disabled’ | ClusterProperties_RestrictOutboundNetworkAccess_STATUS Optional |
| sku | The SKU of the cluster. | AzureSku_STATUS Optional |
| state | The state of the resource. | ClusterProperties_State_STATUS Optional |
| stateReason | The reason for the cluster’s current state. | string Optional |
| systemData | Metadata pertaining to creation and last modification of the resource. | SystemData_STATUS Optional |
| tags | Resource tags. | map[string]string Optional |
| trustedExternalTenants | The cluster’s external tenants. | TrustedExternalTenant_STATUS[] Optional |
| type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
| uri | The cluster URI. | string Optional |
| virtualNetworkConfiguration | Virtual network definition. | VirtualNetworkConfiguration_STATUS Optional |
| zones | The availability zones of the cluster. | string[] Optional |
ClusterList
Generator information: - Generated from: /azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/kusto.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | Cluster[] Optional |
Database
Generator information: - Generated from: /azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/kusto.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}
Used by: DatabaseList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | Database_Spec Optional |
|
| status | Database_STATUS Optional |
Database_Spec
| Property | Description | Type |
|---|---|---|
| azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | DatabaseOperatorSpec Optional |
| owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a kusto.azure.com/Cluster resource | genruntime.KnownResourceReference Required |
| readWriteDatabase | Mutually exclusive with all other properties | ReadWriteDatabase Optional |
Database_STATUS
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| name | The name of the resource | string Optional |
| readWrite | Mutually exclusive with all other properties | ReadWriteDatabase_STATUS Optional |
DatabaseList
Generator information: - Generated from: /azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/kusto.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | Database[] Optional |
DataConnection
Generator information: - Generated from: /azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/kusto.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/dataConnections/{dataConnectionName}
Used by: DataConnectionList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | DataConnection_Spec Optional |
|
| status | DataConnection_STATUS Optional |
DataConnection_Spec
| Property | Description | Type |
|---|---|---|
| azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
| cosmosDbDataConnection | Mutually exclusive with all other properties | CosmosDbDataConnection Optional |
| eventGridDataConnection | Mutually exclusive with all other properties | EventGridDataConnection Optional |
| eventHubDataConnection | Mutually exclusive with all other properties | EventHubDataConnection Optional |
| iotHubDataConnection | Mutually exclusive with all other properties | IotHubDataConnection Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | DataConnectionOperatorSpec Optional |
| owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a kusto.azure.com/Database resource | genruntime.KnownResourceReference Required |
DataConnection_STATUS
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| cosmosDb | Mutually exclusive with all other properties | CosmosDbDataConnection_STATUS Optional |
| eventGrid | Mutually exclusive with all other properties | EventGridDataConnection_STATUS Optional |
| eventHub | Mutually exclusive with all other properties | EventHubDataConnection_STATUS Optional |
| iotHub | Mutually exclusive with all other properties | IotHubDataConnection_STATUS Optional |
| name | The name of the resource | string Optional |
DataConnectionList
Generator information: - Generated from: /azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/kusto.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/dataConnections/{dataConnectionName}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | DataConnection[] Optional |
Cluster_Spec
Used by: Cluster.
| Property | Description | Type |
|---|---|---|
| acceptedAudiences | The cluster’s accepted audiences. | AcceptedAudiences[] Optional |
| allowedFqdnList | List of allowed FQDNs(Fully Qualified Domain Name) for egress from Cluster. | string[] Optional |
| allowedIpRangeList | The list of ips in the format of CIDR allowed to connect to the cluster. | string[] Optional |
| azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
| enableAutoStop | A boolean value that indicates if the cluster could be automatically stopped (due to lack of data or no activity for many days). | bool Optional |
| enableDiskEncryption | A boolean value that indicates if the cluster’s disks are encrypted. | bool Optional |
| enableDoubleEncryption | A boolean value that indicates if double encryption is enabled. | bool Optional |
| enablePurge | A boolean value that indicates if the purge operations are enabled. | bool Optional |
| enableStreamingIngest | A boolean value that indicates if the streaming ingest is enabled. | bool Optional |
| engineType | The engine type | ClusterProperties_EngineType Optional |
| identity | The identity of the cluster, if configured. | Identity Optional |
| keyVaultProperties | KeyVault properties for the cluster encryption. | KeyVaultProperties Optional |
| languageExtensions | List of the cluster’s language extensions. | LanguageExtensionsList Optional |
| location | The geo-location where the resource lives | string Required |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | ClusterOperatorSpec Optional |
| optimizedAutoscale | Optimized auto scale definition. | OptimizedAutoscale Optional |
| owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource | genruntime.KnownResourceReference Required |
| publicIPType | Indicates what public IP type to create - IPv4 (default), or DualStack (both IPv4 and IPv6) | ClusterProperties_PublicIPType Optional |
| publicNetworkAccess | Public network access to the cluster is enabled by default. When disabled, only private endpoint connection to the cluster is allowed | ClusterProperties_PublicNetworkAccess Optional |
| restrictOutboundNetworkAccess | Whether or not to restrict outbound network access. Value is optional but if passed in, must be ‘Enabled’ or ‘Disabled’ | ClusterProperties_RestrictOutboundNetworkAccess Optional |
| sku | The SKU of the cluster. | AzureSku Required |
| tags | Resource tags. | map[string]string Optional |
| trustedExternalTenants | The cluster’s external tenants. | TrustedExternalTenant[] Optional |
| virtualClusterGraduationProperties | Virtual Cluster graduation properties | genruntime.SecretReference Optional |
| virtualNetworkConfiguration | Virtual network definition. | VirtualNetworkConfiguration Optional |
| zones | The availability zones of the cluster. | string[] Optional |
Cluster_STATUS
Class representing a Kusto cluster.
Used by: Cluster.
| Property | Description | Type |
|---|---|---|
| acceptedAudiences | The cluster’s accepted audiences. | AcceptedAudiences_STATUS[] Optional |
| allowedFqdnList | List of allowed FQDNs(Fully Qualified Domain Name) for egress from Cluster. | string[] Optional |
| allowedIpRangeList | The list of ips in the format of CIDR allowed to connect to the cluster. | string[] Optional |
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| dataIngestionUri | The cluster data ingestion URI. | string Optional |
| enableAutoStop | A boolean value that indicates if the cluster could be automatically stopped (due to lack of data or no activity for many days). | bool Optional |
| enableDiskEncryption | A boolean value that indicates if the cluster’s disks are encrypted. | bool Optional |
| enableDoubleEncryption | A boolean value that indicates if double encryption is enabled. | bool Optional |
| enablePurge | A boolean value that indicates if the purge operations are enabled. | bool Optional |
| enableStreamingIngest | A boolean value that indicates if the streaming ingest is enabled. | bool Optional |
| engineType | The engine type | ClusterProperties_EngineType_STATUS Optional |
| etag | A unique read-only string that changes whenever the resource is updated. | string Optional |
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
| identity | The identity of the cluster, if configured. | Identity_STATUS Optional |
| keyVaultProperties | KeyVault properties for the cluster encryption. | KeyVaultProperties_STATUS Optional |
| languageExtensions | List of the cluster’s language extensions. | LanguageExtensionsList_STATUS Optional |
| location | The geo-location where the resource lives | string Optional |
| migrationCluster | Properties of the peer cluster involved in a migration to/from this cluster. | MigrationClusterProperties_STATUS Optional |
| name | The name of the resource | string Optional |
| optimizedAutoscale | Optimized auto scale definition. | OptimizedAutoscale_STATUS Optional |
| privateEndpointConnections | A list of private endpoint connections. | PrivateEndpointConnection_STATUS[] Optional |
| provisioningState | The provisioned state of the resource. | ProvisioningState_STATUS Optional |
| publicIPType | Indicates what public IP type to create - IPv4 (default), or DualStack (both IPv4 and IPv6) | ClusterProperties_PublicIPType_STATUS Optional |
| publicNetworkAccess | Public network access to the cluster is enabled by default. When disabled, only private endpoint connection to the cluster is allowed | ClusterProperties_PublicNetworkAccess_STATUS Optional |
| restrictOutboundNetworkAccess | Whether or not to restrict outbound network access. Value is optional but if passed in, must be ‘Enabled’ or ‘Disabled’ | ClusterProperties_RestrictOutboundNetworkAccess_STATUS Optional |
| sku | The SKU of the cluster. | AzureSku_STATUS Optional |
| state | The state of the resource. | ClusterProperties_State_STATUS Optional |
| stateReason | The reason for the cluster’s current state. | string Optional |
| systemData | Metadata pertaining to creation and last modification of the resource. | SystemData_STATUS Optional |
| tags | Resource tags. | map[string]string Optional |
| trustedExternalTenants | The cluster’s external tenants. | TrustedExternalTenant_STATUS[] Optional |
| type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
| uri | The cluster URI. | string Optional |
| virtualNetworkConfiguration | Virtual network definition. | VirtualNetworkConfiguration_STATUS Optional |
| zones | The availability zones of the cluster. | string[] Optional |
Database_Spec
Used by: Database.
| Property | Description | Type |
|---|---|---|
| azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | DatabaseOperatorSpec Optional |
| owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a kusto.azure.com/Cluster resource | genruntime.KnownResourceReference Required |
| readWriteDatabase | Mutually exclusive with all other properties | ReadWriteDatabase Optional |
Database_STATUS
Used by: Database.
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| name | The name of the resource | string Optional |
| readWrite | Mutually exclusive with all other properties | ReadWriteDatabase_STATUS Optional |
DataConnection_Spec
Used by: DataConnection.
| Property | Description | Type |
|---|---|---|
| azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
| cosmosDbDataConnection | Mutually exclusive with all other properties | CosmosDbDataConnection Optional |
| eventGridDataConnection | Mutually exclusive with all other properties | EventGridDataConnection Optional |
| eventHubDataConnection | Mutually exclusive with all other properties | EventHubDataConnection Optional |
| iotHubDataConnection | Mutually exclusive with all other properties | IotHubDataConnection Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | DataConnectionOperatorSpec Optional |
| owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a kusto.azure.com/Database resource | genruntime.KnownResourceReference Required |
DataConnection_STATUS
Used by: DataConnection.
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| cosmosDb | Mutually exclusive with all other properties | CosmosDbDataConnection_STATUS Optional |
| eventGrid | Mutually exclusive with all other properties | EventGridDataConnection_STATUS Optional |
| eventHub | Mutually exclusive with all other properties | EventHubDataConnection_STATUS Optional |
| iotHub | Mutually exclusive with all other properties | IotHubDataConnection_STATUS Optional |
| name | The name of the resource | string Optional |
AcceptedAudiences
Represents an accepted audience trusted by the cluster.
Used by: Cluster_Spec.
| Property | Description | Type |
|---|---|---|
| value | GUID or valid URL representing an accepted audience. | string Optional |
AcceptedAudiences_STATUS
Represents an accepted audience trusted by the cluster.
Used by: Cluster_STATUS.
| Property | Description | Type |
|---|---|---|
| value | GUID or valid URL representing an accepted audience. | string Optional |
AzureSku
Azure SKU definition.
Used by: Cluster_Spec.
| Property | Description | Type |
|---|---|---|
| capacity | The number of instances of the cluster. | int Optional |
| name | SKU name. | AzureSku_Name Required |
| tier | SKU tier. | AzureSku_Tier Required |
AzureSku_STATUS
Azure SKU definition.
Used by: Cluster_STATUS.
| Property | Description | Type |
|---|---|---|
| capacity | The number of instances of the cluster. | int Optional |
| name | SKU name. | AzureSku_Name_STATUS Optional |
| tier | SKU tier. | AzureSku_Tier_STATUS Optional |
ClusterOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: Cluster_Spec.
| Property | Description | Type |
|---|---|---|
| configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | core.DestinationExpression[] Optional |
| secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | core.DestinationExpression[] Optional |
ClusterProperties_EngineType
Used by: Cluster_Spec.
| Value | Description |
|---|---|
| “V2” | |
| “V3” |
ClusterProperties_EngineType_STATUS
Used by: Cluster_STATUS.
| Value | Description |
|---|---|
| “V2” | |
| “V3” |
ClusterProperties_PublicIPType
Used by: Cluster_Spec.
| Value | Description |
|---|---|
| “DualStack” | |
| “IPv4” |
ClusterProperties_PublicIPType_STATUS
Used by: Cluster_STATUS.
| Value | Description |
|---|---|
| “DualStack” | |
| “IPv4” |
ClusterProperties_PublicNetworkAccess
Used by: Cluster_Spec.
| Value | Description |
|---|---|
| “Disabled” | |
| “Enabled” |
ClusterProperties_PublicNetworkAccess_STATUS
Used by: Cluster_STATUS.
| Value | Description |
|---|---|
| “Disabled” | |
| “Enabled” |
ClusterProperties_RestrictOutboundNetworkAccess
Used by: Cluster_Spec.
| Value | Description |
|---|---|
| “Disabled” | |
| “Enabled” |
ClusterProperties_RestrictOutboundNetworkAccess_STATUS
Used by: Cluster_STATUS.
| Value | Description |
|---|---|
| “Disabled” | |
| “Enabled” |
ClusterProperties_State_STATUS
Used by: Cluster_STATUS.
| Value | Description |
|---|---|
| “Creating” | |
| “Deleted” | |
| “Deleting” | |
| “Migrated” | |
| “Running” | |
| “Starting” | |
| “Stopped” | |
| “Stopping” | |
| “Unavailable” | |
| “Updating” |
CosmosDbDataConnection
Used by: DataConnection_Spec.
| Property | Description | Type |
|---|---|---|
| cosmosDbAccountResourceReference | The resource ID of the Cosmos DB account used to create the data connection. | genruntime.ResourceReference Required |
| cosmosDbContainer | The name of an existing container in the Cosmos DB database. | string Required |
| cosmosDbDatabase | The name of an existing database in the Cosmos DB account. | string Required |
| kind | Kind of the endpoint for the data connection | CosmosDbDataConnection_Kind Required |
| location | Resource location. | string Optional |
| managedIdentityResourceReference | The resource ID of a managed system or user-assigned identity. The identity is used to authenticate with Cosmos DB. | genruntime.ResourceReference Required |
| mappingRuleName | The name of an existing mapping rule to use when ingesting the retrieved data. | string Optional |
| retrievalStartDate | Optional. If defined, the data connection retrieves Cosmos DB documents created or updated after the specified retrieval start date. | string Optional |
| tableName | The case-sensitive name of the existing target table in your cluster. Retrieved data is ingested into this table. | string Required |
CosmosDbDataConnection_STATUS
Used by: DataConnection_STATUS.
| Property | Description | Type |
|---|---|---|
| cosmosDbAccountResourceId | The resource ID of the Cosmos DB account used to create the data connection. | string Optional |
| cosmosDbContainer | The name of an existing container in the Cosmos DB database. | string Optional |
| cosmosDbDatabase | The name of an existing database in the Cosmos DB account. | string Optional |
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
| kind | Kind of the endpoint for the data connection | CosmosDbDataConnection_Kind_STATUS Optional |
| location | Resource location. | string Optional |
| managedIdentityObjectId | The object ID of the managed identity resource. | string Optional |
| managedIdentityResourceId | The resource ID of a managed system or user-assigned identity. The identity is used to authenticate with Cosmos DB. | string Optional |
| mappingRuleName | The name of an existing mapping rule to use when ingesting the retrieved data. | string Optional |
| provisioningState | The provisioned state of the resource. | ProvisioningState_STATUS Optional |
| retrievalStartDate | Optional. If defined, the data connection retrieves Cosmos DB documents created or updated after the specified retrieval start date. | string Optional |
| tableName | The case-sensitive name of the existing target table in your cluster. Retrieved data is ingested into this table. | string Optional |
| type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
DatabaseOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: Database_Spec.
| Property | Description | Type |
|---|---|---|
| configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | core.DestinationExpression[] Optional |
| secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | core.DestinationExpression[] Optional |
DataConnectionOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: DataConnection_Spec.
| Property | Description | Type |
|---|---|---|
| configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | core.DestinationExpression[] Optional |
| secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | core.DestinationExpression[] Optional |
EventGridDataConnection
Used by: DataConnection_Spec.
| Property | Description | Type |
|---|---|---|
| blobStorageEventType | The name of blob storage event type to process. | BlobStorageEventType Optional |
| consumerGroup | The event hub consumer group. | string Required |
| databaseRouting | Indication for database routing information from the data connection, by default only database routing information is allowed | EventGridConnectionProperties_DatabaseRouting Optional |
| dataFormat | The data format of the message. Optionally the data format can be added to each message. | EventGridDataFormat Optional |
| eventGridResourceReference | The resource ID of the event grid that is subscribed to the storage account events. | genruntime.ResourceReference Optional |
| eventHubResourceReference | The resource ID where the event grid is configured to send events. | genruntime.ResourceReference Required |
| ignoreFirstRecord | A Boolean value that, if set to true, indicates that ingestion should ignore the first record of every file | bool Optional |
| kind | Kind of the endpoint for the data connection | EventGridDataConnection_Kind Required |
| location | Resource location. | string Optional |
| managedIdentityResourceReference | The resource ID of a managed identity (system or user assigned) to be used to authenticate with event hub and storage account. | genruntime.ResourceReference Optional |
| mappingRuleName | The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message. | string Optional |
| storageAccountResourceReference | The resource ID of the storage account where the data resides. | genruntime.ResourceReference Required |
| tableName | The table where the data should be ingested. Optionally the table information can be added to each message. | string Optional |
EventGridDataConnection_STATUS
Used by: DataConnection_STATUS.
| Property | Description | Type |
|---|---|---|
| blobStorageEventType | The name of blob storage event type to process. | BlobStorageEventType_STATUS Optional |
| consumerGroup | The event hub consumer group. | string Optional |
| databaseRouting | Indication for database routing information from the data connection, by default only database routing information is allowed | EventGridConnectionProperties_DatabaseRouting_STATUS Optional |
| dataFormat | The data format of the message. Optionally the data format can be added to each message. | EventGridDataFormat_STATUS Optional |
| eventGridResourceId | The resource ID of the event grid that is subscribed to the storage account events. | string Optional |
| eventHubResourceId | The resource ID where the event grid is configured to send events. | string Optional |
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
| ignoreFirstRecord | A Boolean value that, if set to true, indicates that ingestion should ignore the first record of every file | bool Optional |
| kind | Kind of the endpoint for the data connection | EventGridDataConnection_Kind_STATUS Optional |
| location | Resource location. | string Optional |
| managedIdentityObjectId | The object ID of managedIdentityResourceId | string Optional |
| managedIdentityResourceId | The resource ID of a managed identity (system or user assigned) to be used to authenticate with event hub and storage account. | string Optional |
| mappingRuleName | The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message. | string Optional |
| provisioningState | The provisioned state of the resource. | ProvisioningState_STATUS Optional |
| storageAccountResourceId | The resource ID of the storage account where the data resides. | string Optional |
| tableName | The table where the data should be ingested. Optionally the table information can be added to each message. | string Optional |
| type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
EventHubDataConnection
Used by: DataConnection_Spec.
| Property | Description | Type |
|---|---|---|
| compression | The event hub messages compression type | Compression Optional |
| consumerGroup | The event hub consumer group. | string Required |
| databaseRouting | Indication for database routing information from the data connection, by default only database routing information is allowed | EventHubConnectionProperties_DatabaseRouting Optional |
| dataFormat | The data format of the message. Optionally the data format can be added to each message. | EventHubDataFormat Optional |
| eventHubResourceReference | The resource ID of the event hub to be used to create a data connection. | genruntime.ResourceReference Required |
| eventSystemProperties | System properties of the event hub | string[] Optional |
| kind | Kind of the endpoint for the data connection | EventHubDataConnection_Kind Required |
| location | Resource location. | string Optional |
| managedIdentityResourceReference | The resource ID of a managed identity (system or user assigned) to be used to authenticate with event hub. | genruntime.ResourceReference Optional |
| mappingRuleName | The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message. | string Optional |
| retrievalStartDate | 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. | string Optional |
| tableName | The table where the data should be ingested. Optionally the table information can be added to each message. | string Optional |
EventHubDataConnection_STATUS
Used by: DataConnection_STATUS.
| Property | Description | Type |
|---|---|---|
| compression | The event hub messages compression type | Compression_STATUS Optional |
| consumerGroup | The event hub consumer group. | string Optional |
| databaseRouting | Indication for database routing information from the data connection, by default only database routing information is allowed | EventHubConnectionProperties_DatabaseRouting_STATUS Optional |
| dataFormat | The data format of the message. Optionally the data format can be added to each message. | EventHubDataFormat_STATUS Optional |
| eventHubResourceId | The resource ID of the event hub to be used to create a data connection. | string Optional |
| eventSystemProperties | System properties of the event hub | string[] Optional |
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
| kind | Kind of the endpoint for the data connection | EventHubDataConnection_Kind_STATUS Optional |
| location | Resource location. | string Optional |
| managedIdentityObjectId | The object ID of the managedIdentityResourceId | string Optional |
| managedIdentityResourceId | The resource ID of a managed identity (system or user assigned) to be used to authenticate with event hub. | string Optional |
| mappingRuleName | The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message. | string Optional |
| provisioningState | The provisioned state of the resource. | ProvisioningState_STATUS Optional |
| retrievalStartDate | 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. | string Optional |
| tableName | The table where the data should be ingested. Optionally the table information can be added to each message. | string Optional |
| type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
Identity
Identity for the resource.
Used by: Cluster_Spec.
| Property | Description | Type |
|---|---|---|
| type | 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. | Identity_Type Required |
| userAssignedIdentities | 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}’. | UserAssignedIdentityDetails[] Optional |
Identity_STATUS
Identity for the resource.
Used by: Cluster_STATUS.
| Property | Description | Type |
|---|---|---|
| principalId | The principal ID of resource identity. | string Optional |
| tenantId | The tenant ID of resource. | string Optional |
| type | 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. | Identity_Type_STATUS Optional |
| userAssignedIdentities | 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}’. | map[string]Identity_UserAssignedIdentities_STATUS Optional |
IotHubDataConnection
Used by: DataConnection_Spec.
| Property | Description | Type |
|---|---|---|
| consumerGroup | The iot hub consumer group. | string Required |
| databaseRouting | Indication for database routing information from the data connection, by default only database routing information is allowed | IotHubConnectionProperties_DatabaseRouting Optional |
| dataFormat | The data format of the message. Optionally the data format can be added to each message. | IotHubDataFormat Optional |
| eventSystemProperties | System properties of the iot hub | string[] Optional |
| iotHubResourceReference | The resource ID of the Iot hub to be used to create a data connection. | genruntime.ResourceReference Required |
| kind | Kind of the endpoint for the data connection | IotHubDataConnection_Kind Required |
| location | Resource location. | string Optional |
| mappingRuleName | The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message. | string Optional |
| retrievalStartDate | 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. | string Optional |
| sharedAccessPolicyName | The name of the share access policy | string Required |
| tableName | The table where the data should be ingested. Optionally the table information can be added to each message. | string Optional |
IotHubDataConnection_STATUS
Used by: DataConnection_STATUS.
| Property | Description | Type |
|---|---|---|
| consumerGroup | The iot hub consumer group. | string Optional |
| databaseRouting | Indication for database routing information from the data connection, by default only database routing information is allowed | IotHubConnectionProperties_DatabaseRouting_STATUS Optional |
| dataFormat | The data format of the message. Optionally the data format can be added to each message. | IotHubDataFormat_STATUS Optional |
| eventSystemProperties | System properties of the iot hub | string[] Optional |
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
| iotHubResourceId | The resource ID of the Iot hub to be used to create a data connection. | string Optional |
| kind | Kind of the endpoint for the data connection | IotHubDataConnection_Kind_STATUS Optional |
| location | Resource location. | string Optional |
| mappingRuleName | The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message. | string Optional |
| provisioningState | The provisioned state of the resource. | ProvisioningState_STATUS Optional |
| retrievalStartDate | 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. | string Optional |
| sharedAccessPolicyName | The name of the share access policy | string Optional |
| tableName | The table where the data should be ingested. Optionally the table information can be added to each message. | string Optional |
| type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
KeyVaultProperties
Properties of the key vault.
Used by: Cluster_Spec, and ReadWriteDatabase.
| Property | Description | Type |
|---|---|---|
| keyName | The name of the key vault key. | string Optional |
| keyVaultUri | The Uri of the key vault. | string Optional |
| keyVersion | The version of the key vault key. | string Optional |
| userIdentityReference | The user assigned identity (ARM resource id) that has access to the key. | genruntime.ResourceReference Optional |
KeyVaultProperties_STATUS
Properties of the key vault.
Used by: Cluster_STATUS, and ReadWriteDatabase_STATUS.
| Property | Description | Type |
|---|---|---|
| keyName | The name of the key vault key. | string Optional |
| keyVaultUri | The Uri of the key vault. | string Optional |
| keyVersion | The version of the key vault key. | string Optional |
| userIdentity | The user assigned identity (ARM resource id) that has access to the key. | string Optional |
LanguageExtensionsList
The list of language extension objects.
Used by: Cluster_Spec.
| Property | Description | Type |
|---|---|---|
| value | The list of language extensions. | LanguageExtension[] Optional |
LanguageExtensionsList_STATUS
The list of language extension objects.
Used by: Cluster_STATUS.
| Property | Description | Type |
|---|---|---|
| value | The list of language extensions. | LanguageExtension_STATUS[] Optional |
MigrationClusterProperties_STATUS
Represents a properties of a cluster that is part of a migration.
Used by: Cluster_STATUS.
| Property | Description | Type |
|---|---|---|
| dataIngestionUri | The public data ingestion URL of the cluster. | string Optional |
| id | The resource ID of the cluster. | string Optional |
| role | The role of the cluster in the migration process. | MigrationClusterProperties_Role_STATUS Optional |
| uri | The public URL of the cluster. | string Optional |
OptimizedAutoscale
A class that contains the optimized auto scale definition.
Used by: Cluster_Spec.
| Property | Description | Type |
|---|---|---|
| isEnabled | A boolean value that indicate if the optimized autoscale feature is enabled or not. | bool Required |
| maximum | Maximum allowed instances count. | int Required |
| minimum | Minimum allowed instances count. | int Required |
| version | The version of the template defined, for instance 1. | int Required |
OptimizedAutoscale_STATUS
A class that contains the optimized auto scale definition.
Used by: Cluster_STATUS.
| Property | Description | Type |
|---|---|---|
| isEnabled | A boolean value that indicate if the optimized autoscale feature is enabled or not. | bool Optional |
| maximum | Maximum allowed instances count. | int Optional |
| minimum | Minimum allowed instances count. | int Optional |
| version | The version of the template defined, for instance 1. | int Optional |
PrivateEndpointConnection_STATUS
A private endpoint connection
Used by: Cluster_STATUS.
| Property | Description | Type |
|---|---|---|
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
ProvisioningState_STATUS
The provisioned state of the resource.
Used by: Cluster_STATUS, CosmosDbDataConnection_STATUS, EventGridDataConnection_STATUS, EventHubDataConnection_STATUS, IotHubDataConnection_STATUS, and ReadWriteDatabase_STATUS.
| Value | Description |
|---|---|
| “Canceled” | |
| “Creating” | |
| “Deleting” | |
| “Failed” | |
| “Moving” | |
| “Running” | |
| “Succeeded” |
ReadWriteDatabase
Used by: Database_Spec.
| Property | Description | Type |
|---|---|---|
| hotCachePeriod | The time the data should be kept in cache for fast queries in TimeSpan. | string Optional |
| keyVaultProperties | KeyVault properties for the database encryption. | KeyVaultProperties Optional |
| kind | Kind of the database | ReadWriteDatabase_Kind Required |
| location | Resource location. | string Optional |
| softDeletePeriod | The time the data should be kept before it stops being accessible to queries in TimeSpan. | string Optional |
ReadWriteDatabase_STATUS
Used by: Database_STATUS.
| Property | Description | Type |
|---|---|---|
| hotCachePeriod | The time the data should be kept in cache for fast queries in TimeSpan. | string Optional |
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
| isFollowed | Indicates whether the database is followed. | bool Optional |
| keyVaultProperties | KeyVault properties for the database encryption. | KeyVaultProperties_STATUS Optional |
| kind | Kind of the database | ReadWriteDatabase_Kind_STATUS Optional |
| location | Resource location. | string Optional |
| provisioningState | The provisioned state of the resource. | ProvisioningState_STATUS Optional |
| softDeletePeriod | The time the data should be kept before it stops being accessible to queries in TimeSpan. | string Optional |
| statistics | The statistics of the database. | DatabaseStatistics_STATUS Optional |
| suspensionDetails | The database suspension details. If the database is suspended, this object contains information related to the database’s suspension state. | SuspensionDetails_STATUS Optional |
| type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
SystemData_STATUS
Metadata pertaining to creation and last modification of the resource.
Used by: Cluster_STATUS.
| Property | Description | Type |
|---|---|---|
| createdAt | The timestamp of resource creation (UTC). | string Optional |
| createdBy | The identity that created the resource. | string Optional |
| createdByType | The type of identity that created the resource. | SystemData_CreatedByType_STATUS Optional |
| lastModifiedAt | The timestamp of resource last modification (UTC) | string Optional |
| lastModifiedBy | The identity that last modified the resource. | string Optional |
| lastModifiedByType | The type of identity that last modified the resource. | SystemData_LastModifiedByType_STATUS Optional |
TrustedExternalTenant
Represents a tenant ID that is trusted by the cluster.
Used by: Cluster_Spec.
| Property | Description | Type |
|---|---|---|
| value | GUID representing an external tenant. | string Optional |
TrustedExternalTenant_STATUS
Represents a tenant ID that is trusted by the cluster.
Used by: Cluster_STATUS.
| Property | Description | Type |
|---|---|---|
| value | GUID representing an external tenant. | string Optional |
VirtualNetworkConfiguration
A class that contains virtual network definition.
Used by: Cluster_Spec.
| Property | Description | Type |
|---|---|---|
| dataManagementPublicIpReference | Data management’s service public IP address resource id. | genruntime.ResourceReference Required |
| enginePublicIpReference | Engine service’s public IP address resource id. | genruntime.ResourceReference Required |
| state | When enabled, the cluster is deployed into the configured subnet, when disabled it will be removed from the subnet. | VirtualNetworkConfiguration_State Optional |
| subnetReference | The subnet resource id. | genruntime.ResourceReference Required |
VirtualNetworkConfiguration_STATUS
A class that contains virtual network definition.
Used by: Cluster_STATUS.
| Property | Description | Type |
|---|---|---|
| dataManagementPublicIpId | Data management’s service public IP address resource id. | string Optional |
| enginePublicIpId | Engine service’s public IP address resource id. | string Optional |
| state | When enabled, the cluster is deployed into the configured subnet, when disabled it will be removed from the subnet. | VirtualNetworkConfiguration_State_STATUS Optional |
| subnetId | The subnet resource id. | string Optional |
AzureSku_Name
Used by: AzureSku.
| Value | Description |
|---|---|
| “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_D16d_v5” | |
| “Standard_D32d_v4” | |
| “Standard_D32d_v5” | |
| “Standard_DS13_v2+1TB_PS” | |
| “Standard_DS13_v2+2TB_PS” | |
| “Standard_DS14_v2+3TB_PS” | |
| “Standard_DS14_v2+4TB_PS” | |
| “Standard_E16a_v4” | |
| “Standard_E16ads_v5” | |
| “Standard_E16as_v4+3TB_PS” | |
| “Standard_E16as_v4+4TB_PS” | |
| “Standard_E16as_v5+3TB_PS” | |
| “Standard_E16as_v5+4TB_PS” | |
| “Standard_E16d_v4” | |
| “Standard_E16d_v5” | |
| “Standard_E16s_v4+3TB_PS” | |
| “Standard_E16s_v4+4TB_PS” | |
| “Standard_E16s_v5+3TB_PS” | |
| “Standard_E16s_v5+4TB_PS” | |
| “Standard_E2a_v4” | |
| “Standard_E2ads_v5” | |
| “Standard_E2d_v4” | |
| “Standard_E2d_v5” | |
| “Standard_E4a_v4” | |
| “Standard_E4ads_v5” | |
| “Standard_E4d_v4” | |
| “Standard_E4d_v5” | |
| “Standard_E64i_v3” | |
| “Standard_E80ids_v4” | |
| “Standard_E8a_v4” | |
| “Standard_E8ads_v5” | |
| “Standard_E8as_v4+1TB_PS” | |
| “Standard_E8as_v4+2TB_PS” | |
| “Standard_E8as_v5+1TB_PS” | |
| “Standard_E8as_v5+2TB_PS” | |
| “Standard_E8d_v4” | |
| “Standard_E8d_v5” | |
| “Standard_E8s_v4+1TB_PS” | |
| “Standard_E8s_v4+2TB_PS” | |
| “Standard_E8s_v5+1TB_PS” | |
| “Standard_E8s_v5+2TB_PS” | |
| “Standard_EC16ads_v5” | |
| “Standard_EC16as_v5+3TB_PS” | |
| “Standard_EC16as_v5+4TB_PS” | |
| “Standard_EC8ads_v5” | |
| “Standard_EC8as_v5+1TB_PS” | |
| “Standard_EC8as_v5+2TB_PS” | |
| “Standard_L16as_v3” | |
| “Standard_L16s” | |
| “Standard_L16s_v2” | |
| “Standard_L16s_v3” | |
| “Standard_L32as_v3” | |
| “Standard_L32s_v3” | |
| “Standard_L4s” | |
| “Standard_L8as_v3” | |
| “Standard_L8s” | |
| “Standard_L8s_v2” | |
| “Standard_L8s_v3” |
AzureSku_Name_STATUS
Used by: AzureSku_STATUS.
| Value | Description |
|---|---|
| “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_D16d_v5” | |
| “Standard_D32d_v4” | |
| “Standard_D32d_v5” | |
| “Standard_DS13_v2+1TB_PS” | |
| “Standard_DS13_v2+2TB_PS” | |
| “Standard_DS14_v2+3TB_PS” | |
| “Standard_DS14_v2+4TB_PS” | |
| “Standard_E16a_v4” | |
| “Standard_E16ads_v5” | |
| “Standard_E16as_v4+3TB_PS” | |
| “Standard_E16as_v4+4TB_PS” | |
| “Standard_E16as_v5+3TB_PS” | |
| “Standard_E16as_v5+4TB_PS” | |
| “Standard_E16d_v4” | |
| “Standard_E16d_v5” | |
| “Standard_E16s_v4+3TB_PS” | |
| “Standard_E16s_v4+4TB_PS” | |
| “Standard_E16s_v5+3TB_PS” | |
| “Standard_E16s_v5+4TB_PS” | |
| “Standard_E2a_v4” | |
| “Standard_E2ads_v5” | |
| “Standard_E2d_v4” | |
| “Standard_E2d_v5” | |
| “Standard_E4a_v4” | |
| “Standard_E4ads_v5” | |
| “Standard_E4d_v4” | |
| “Standard_E4d_v5” | |
| “Standard_E64i_v3” | |
| “Standard_E80ids_v4” | |
| “Standard_E8a_v4” | |
| “Standard_E8ads_v5” | |
| “Standard_E8as_v4+1TB_PS” | |
| “Standard_E8as_v4+2TB_PS” | |
| “Standard_E8as_v5+1TB_PS” | |
| “Standard_E8as_v5+2TB_PS” | |
| “Standard_E8d_v4” | |
| “Standard_E8d_v5” | |
| “Standard_E8s_v4+1TB_PS” | |
| “Standard_E8s_v4+2TB_PS” | |
| “Standard_E8s_v5+1TB_PS” | |
| “Standard_E8s_v5+2TB_PS” | |
| “Standard_EC16ads_v5” | |
| “Standard_EC16as_v5+3TB_PS” | |
| “Standard_EC16as_v5+4TB_PS” | |
| “Standard_EC8ads_v5” | |
| “Standard_EC8as_v5+1TB_PS” | |
| “Standard_EC8as_v5+2TB_PS” | |
| “Standard_L16as_v3” | |
| “Standard_L16s” | |
| “Standard_L16s_v2” | |
| “Standard_L16s_v3” | |
| “Standard_L32as_v3” | |
| “Standard_L32s_v3” | |
| “Standard_L4s” | |
| “Standard_L8as_v3” | |
| “Standard_L8s” | |
| “Standard_L8s_v2” | |
| “Standard_L8s_v3” |
AzureSku_Tier
Used by: AzureSku.
| Value | Description |
|---|---|
| “Basic” | |
| “Standard” |
AzureSku_Tier_STATUS
Used by: AzureSku_STATUS.
| Value | Description |
|---|---|
| “Basic” | |
| “Standard” |
BlobStorageEventType
The name of blob storage event type to process.
Used by: EventGridDataConnection.
| Value | Description |
|---|---|
| “Microsoft.Storage.BlobCreated” | |
| “Microsoft.Storage.BlobRenamed” |
BlobStorageEventType_STATUS
The name of blob storage event type to process.
Used by: EventGridDataConnection_STATUS.
| Value | Description |
|---|---|
| “Microsoft.Storage.BlobCreated” | |
| “Microsoft.Storage.BlobRenamed” |
Compression
The compression type
Used by: EventHubDataConnection.
| Value | Description |
|---|---|
| “GZip” | |
| “None” |
Compression_STATUS
The compression type
Used by: EventHubDataConnection_STATUS.
| Value | Description |
|---|---|
| “GZip” | |
| “None” |
CosmosDbDataConnection_Kind
Used by: CosmosDbDataConnection.
| Value | Description |
|---|---|
| “CosmosDb” |
CosmosDbDataConnection_Kind_STATUS
Used by: CosmosDbDataConnection_STATUS.
| Value | Description |
|---|---|
| “CosmosDb” |
DatabaseStatistics_STATUS
A class that contains database statistics information.
Used by: ReadWriteDatabase_STATUS.
| Property | Description | Type |
|---|---|---|
| size | The database size - the total size of compressed data and index in bytes. | float64 Optional |
EventGridConnectionProperties_DatabaseRouting
Used by: EventGridDataConnection.
| Value | Description |
|---|---|
| “Multi” | |
| “Single” |
EventGridConnectionProperties_DatabaseRouting_STATUS
Used by: EventGridDataConnection_STATUS.
| Value | Description |
|---|---|
| “Multi” | |
| “Single” |
EventGridDataConnection_Kind
Used by: EventGridDataConnection.
| Value | Description |
|---|---|
| “EventGrid” |
EventGridDataConnection_Kind_STATUS
Used by: EventGridDataConnection_STATUS.
| Value | Description |
|---|---|
| “EventGrid” |
EventGridDataFormat
The data format of the message. Optionally the data format can be added to each message.
Used by: EventGridDataConnection.
| Value | Description |
|---|---|
| “APACHEAVRO” | |
| “AVRO” | |
| “CSV” | |
| “JSON” | |
| “MULTIJSON” | |
| “ORC” | |
| “PARQUET” | |
| “PSV” | |
| “RAW” | |
| “SCSV” | |
| “SINGLEJSON” | |
| “SOHSV” | |
| “TSV” | |
| “TSVE” | |
| “TXT” | |
| “W3CLOGFILE” |
EventGridDataFormat_STATUS
The data format of the message. Optionally the data format can be added to each message.
Used by: EventGridDataConnection_STATUS.
| Value | Description |
|---|---|
| “APACHEAVRO” | |
| “AVRO” | |
| “CSV” | |
| “JSON” | |
| “MULTIJSON” | |
| “ORC” | |
| “PARQUET” | |
| “PSV” | |
| “RAW” | |
| “SCSV” | |
| “SINGLEJSON” | |
| “SOHSV” | |
| “TSV” | |
| “TSVE” | |
| “TXT” | |
| “W3CLOGFILE” |
EventHubConnectionProperties_DatabaseRouting
Used by: EventHubDataConnection.
| Value | Description |
|---|---|
| “Multi” | |
| “Single” |
EventHubConnectionProperties_DatabaseRouting_STATUS
Used by: EventHubDataConnection_STATUS.
| Value | Description |
|---|---|
| “Multi” | |
| “Single” |
EventHubDataConnection_Kind
Used by: EventHubDataConnection.
| Value | Description |
|---|---|
| “EventHub” |
EventHubDataConnection_Kind_STATUS
Used by: EventHubDataConnection_STATUS.
| Value | Description |
|---|---|
| “EventHub” |
EventHubDataFormat
The data format of the message. Optionally the data format can be added to each message.
Used by: EventHubDataConnection.
| Value | Description |
|---|---|
| “APACHEAVRO” | |
| “AVRO” | |
| “CSV” | |
| “JSON” | |
| “MULTIJSON” | |
| “ORC” | |
| “PARQUET” | |
| “PSV” | |
| “RAW” | |
| “SCSV” | |
| “SINGLEJSON” | |
| “SOHSV” | |
| “TSV” | |
| “TSVE” | |
| “TXT” | |
| “W3CLOGFILE” |
EventHubDataFormat_STATUS
The data format of the message. Optionally the data format can be added to each message.
Used by: EventHubDataConnection_STATUS.
| Value | Description |
|---|---|
| “APACHEAVRO” | |
| “AVRO” | |
| “CSV” | |
| “JSON” | |
| “MULTIJSON” | |
| “ORC” | |
| “PARQUET” | |
| “PSV” | |
| “RAW” | |
| “SCSV” | |
| “SINGLEJSON” | |
| “SOHSV” | |
| “TSV” | |
| “TSVE” | |
| “TXT” | |
| “W3CLOGFILE” |
Identity_Type
Used by: Identity.
| Value | Description |
|---|---|
| “None” | |
| “SystemAssigned” | |
| “SystemAssigned, UserAssigned” | |
| “UserAssigned” |
Identity_Type_STATUS
Used by: Identity_STATUS.
| Value | Description |
|---|---|
| “None” | |
| “SystemAssigned” | |
| “SystemAssigned, UserAssigned” | |
| “UserAssigned” |
Identity_UserAssignedIdentities_STATUS
Used by: Identity_STATUS.
| Property | Description | Type |
|---|---|---|
| clientId | The client id of user assigned identity. | string Optional |
| principalId | The principal id of user assigned identity. | string Optional |
IotHubConnectionProperties_DatabaseRouting
Used by: IotHubDataConnection.
| Value | Description |
|---|---|
| “Multi” | |
| “Single” |
IotHubConnectionProperties_DatabaseRouting_STATUS
Used by: IotHubDataConnection_STATUS.
| Value | Description |
|---|---|
| “Multi” | |
| “Single” |
IotHubDataConnection_Kind
Used by: IotHubDataConnection.
| Value | Description |
|---|---|
| “IotHub” |
IotHubDataConnection_Kind_STATUS
Used by: IotHubDataConnection_STATUS.
| Value | Description |
|---|---|
| “IotHub” |
IotHubDataFormat
The data format of the message. Optionally the data format can be added to each message.
Used by: IotHubDataConnection.
| Value | Description |
|---|---|
| “APACHEAVRO” | |
| “AVRO” | |
| “CSV” | |
| “JSON” | |
| “MULTIJSON” | |
| “ORC” | |
| “PARQUET” | |
| “PSV” | |
| “RAW” | |
| “SCSV” | |
| “SINGLEJSON” | |
| “SOHSV” | |
| “TSV” | |
| “TSVE” | |
| “TXT” | |
| “W3CLOGFILE” |
IotHubDataFormat_STATUS
The data format of the message. Optionally the data format can be added to each message.
Used by: IotHubDataConnection_STATUS.
| Value | Description |
|---|---|
| “APACHEAVRO” | |
| “AVRO” | |
| “CSV” | |
| “JSON” | |
| “MULTIJSON” | |
| “ORC” | |
| “PARQUET” | |
| “PSV” | |
| “RAW” | |
| “SCSV” | |
| “SINGLEJSON” | |
| “SOHSV” | |
| “TSV” | |
| “TSVE” | |
| “TXT” | |
| “W3CLOGFILE” |
LanguageExtension
The language extension object.
Used by: LanguageExtensionsList.
| Property | Description | Type |
|---|---|---|
| languageExtensionCustomImageName | The language extension custom image name. | string Optional |
| languageExtensionImageName | The language extension image name. | LanguageExtensionImageName Optional |
| languageExtensionName | The language extension name. | LanguageExtensionName Optional |
LanguageExtension_STATUS
The language extension object.
Used by: LanguageExtensionsList_STATUS.
| Property | Description | Type |
|---|---|---|
| languageExtensionCustomImageName | The language extension custom image name. | string Optional |
| languageExtensionImageName | The language extension image name. | LanguageExtensionImageName_STATUS Optional |
| languageExtensionName | The language extension name. | LanguageExtensionName_STATUS Optional |
MigrationClusterProperties_Role_STATUS
Used by: MigrationClusterProperties_STATUS.
| Value | Description |
|---|---|
| “Destination” | |
| “Source” |
ReadWriteDatabase_Kind
Used by: ReadWriteDatabase.
| Value | Description |
|---|---|
| “ReadWrite” |
ReadWriteDatabase_Kind_STATUS
Used by: ReadWriteDatabase_STATUS.
| Value | Description |
|---|---|
| “ReadWrite” |
SuspensionDetails_STATUS
The database suspension details. If the database is suspended, this object contains information related to the database’s suspension state.
Used by: ReadWriteDatabase_STATUS.
| Property | Description | Type |
|---|---|---|
| suspensionStartDate | The starting date and time of the suspension state. | string Optional |
SystemData_CreatedByType_STATUS
Used by: SystemData_STATUS.
| Value | Description |
|---|---|
| “Application” | |
| “Key” | |
| “ManagedIdentity” | |
| “User” |
SystemData_LastModifiedByType_STATUS
Used by: SystemData_STATUS.
| Value | Description |
|---|---|
| “Application” | |
| “Key” | |
| “ManagedIdentity” | |
| “User” |
UserAssignedIdentityDetails
Information about the user assigned identity for the resource
Used by: Identity.
| Property | Description | Type |
|---|---|---|
| reference | genruntime.ResourceReference Optional |
VirtualNetworkConfiguration_State
Used by: VirtualNetworkConfiguration.
| Value | Description |
|---|---|
| “Disabled” | |
| “Enabled” |
VirtualNetworkConfiguration_State_STATUS
Used by: VirtualNetworkConfiguration_STATUS.
| Value | Description |
|---|---|
| “Disabled” | |
| “Enabled” |
LanguageExtensionImageName
Language extension image name.
Used by: LanguageExtension.
| Value | Description |
|---|---|
| “Python3_10_8” | |
| “Python3_10_8_DL” | |
| “Python3_6_5” | |
| “PythonCustomImage” | |
| “R” |
LanguageExtensionImageName_STATUS
Language extension image name.
Used by: LanguageExtension_STATUS.
| Value | Description |
|---|---|
| “Python3_10_8” | |
| “Python3_10_8_DL” | |
| “Python3_6_5” | |
| “PythonCustomImage” | |
| “R” |
LanguageExtensionName
Language extension that can run within KQL query.
Used by: LanguageExtension.
| Value | Description |
|---|---|
| “PYTHON” | |
| “R” |
LanguageExtensionName_STATUS
Language extension that can run within KQL query.
Used by: LanguageExtension_STATUS.
| Value | Description |
|---|---|
| “PYTHON” | |
| “R” |