@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 6.87 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Gets a Kusto cluster.
*
* Uses Azure REST API version 2024-04-13.
*
* Other available API versions: 2018-09-07-preview, 2019-01-21, 2019-05-15, 2019-09-07, 2019-11-09, 2020-02-15, 2020-06-14, 2020-09-18, 2021-01-01, 2021-08-27, 2022-02-01, 2022-07-07, 2022-11-11, 2022-12-29, 2023-05-02, 2023-08-15. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native kusto [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getCluster(args: GetClusterArgs, opts?: pulumi.InvokeOptions): Promise<GetClusterResult>;
export interface GetClusterArgs {
/**
* The name of the Kusto cluster.
*/
clusterName: string;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: string;
}
/**
* Class representing a Kusto cluster.
*/
export interface GetClusterResult {
/**
* The cluster's accepted audiences.
*/
readonly acceptedAudiences?: outputs.kusto.AcceptedAudiencesResponse[];
/**
* List of allowed FQDNs(Fully Qualified Domain Name) for egress from Cluster.
*/
readonly allowedFqdnList?: string[];
/**
* The list of ips in the format of CIDR allowed to connect to the cluster.
*/
readonly allowedIpRangeList?: string[];
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: string;
/**
* List of callout policies for egress from Cluster.
*/
readonly calloutPolicies?: outputs.kusto.CalloutPolicyResponse[];
/**
* The cluster data ingestion URI.
*/
readonly dataIngestionUri: string;
/**
* A boolean value that indicates if the cluster could be automatically stopped (due to lack of data or no activity for many days).
*/
readonly enableAutoStop?: boolean;
/**
* A boolean value that indicates if the cluster's disks are encrypted.
*/
readonly enableDiskEncryption?: boolean;
/**
* A boolean value that indicates if double encryption is enabled.
*/
readonly enableDoubleEncryption?: boolean;
/**
* A boolean value that indicates if the purge operations are enabled.
*/
readonly enablePurge?: boolean;
/**
* A boolean value that indicates if the streaming ingest is enabled.
*/
readonly enableStreamingIngest?: boolean;
/**
* The engine type
*/
readonly engineType?: string;
/**
* A unique read-only string that changes whenever the resource is updated.
*/
readonly etag: string;
/**
* Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
*/
readonly id: string;
/**
* The identity of the cluster, if configured.
*/
readonly identity?: outputs.kusto.IdentityResponse;
/**
* KeyVault properties for the cluster encryption.
*/
readonly keyVaultProperties?: outputs.kusto.KeyVaultPropertiesResponse;
/**
* List of the cluster's language extensions.
*/
readonly languageExtensions?: outputs.kusto.LanguageExtensionsListResponse;
/**
* The geo-location where the resource lives
*/
readonly location: string;
/**
* Properties of the peer cluster involved in a migration to/from this cluster.
*/
readonly migrationCluster: outputs.kusto.MigrationClusterPropertiesResponse;
/**
* The name of the resource
*/
readonly name: string;
/**
* Optimized auto scale definition.
*/
readonly optimizedAutoscale?: outputs.kusto.OptimizedAutoscaleResponse;
/**
* A list of private endpoint connections.
*/
readonly privateEndpointConnections: outputs.kusto.PrivateEndpointConnectionResponse[];
/**
* The provisioned state of the resource.
*/
readonly provisioningState: string;
/**
* Indicates what public IP type to create - IPv4 (default), or DualStack (both IPv4 and IPv6)
*/
readonly publicIPType?: string;
/**
* Public network access to the cluster is enabled by default. When disabled, only private endpoint connection to the cluster is allowed
*/
readonly publicNetworkAccess?: string;
/**
* Whether or not to restrict outbound network access. Value is optional but if passed in, must be 'Enabled' or 'Disabled'
*/
readonly restrictOutboundNetworkAccess?: string;
/**
* The SKU of the cluster.
*/
readonly sku: outputs.kusto.AzureSkuResponse;
/**
* The state of the resource.
*/
readonly state: string;
/**
* The reason for the cluster's current state.
*/
readonly stateReason: string;
/**
* Metadata pertaining to creation and last modification of the resource.
*/
readonly systemData: outputs.kusto.SystemDataResponse;
/**
* Resource tags.
*/
readonly tags?: {
[key: string]: string;
};
/**
* The cluster's external tenants.
*/
readonly trustedExternalTenants?: outputs.kusto.TrustedExternalTenantResponse[];
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*/
readonly type: string;
/**
* The cluster URI.
*/
readonly uri: string;
/**
* Virtual network definition.
*/
readonly virtualNetworkConfiguration?: outputs.kusto.VirtualNetworkConfigurationResponse;
/**
* Indicates whether the cluster is zonal or non-zonal.
*/
readonly zoneStatus: string;
/**
* The availability zones of the cluster.
*/
readonly zones?: string[];
}
/**
* Gets a Kusto cluster.
*
* Uses Azure REST API version 2024-04-13.
*
* Other available API versions: 2018-09-07-preview, 2019-01-21, 2019-05-15, 2019-09-07, 2019-11-09, 2020-02-15, 2020-06-14, 2020-09-18, 2021-01-01, 2021-08-27, 2022-02-01, 2022-07-07, 2022-11-11, 2022-12-29, 2023-05-02, 2023-08-15. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native kusto [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getClusterOutput(args: GetClusterOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetClusterResult>;
export interface GetClusterOutputArgs {
/**
* The name of the Kusto cluster.
*/
clusterName: pulumi.Input<string>;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
}