1. Packages
  2. Azure Native
  3. API Docs
  4. kusto
  5. getReadOnlyFollowingDatabase
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi

azure-native.kusto.getReadOnlyFollowingDatabase

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi

    Returns a database. Azure REST API version: 2022-12-29.

    Using getReadOnlyFollowingDatabase

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getReadOnlyFollowingDatabase(args: GetReadOnlyFollowingDatabaseArgs, opts?: InvokeOptions): Promise<GetReadOnlyFollowingDatabaseResult>
    function getReadOnlyFollowingDatabaseOutput(args: GetReadOnlyFollowingDatabaseOutputArgs, opts?: InvokeOptions): Output<GetReadOnlyFollowingDatabaseResult>
    def get_read_only_following_database(cluster_name: Optional[str] = None,
                                         database_name: Optional[str] = None,
                                         resource_group_name: Optional[str] = None,
                                         opts: Optional[InvokeOptions] = None) -> GetReadOnlyFollowingDatabaseResult
    def get_read_only_following_database_output(cluster_name: Optional[pulumi.Input[str]] = None,
                                         database_name: Optional[pulumi.Input[str]] = None,
                                         resource_group_name: Optional[pulumi.Input[str]] = None,
                                         opts: Optional[InvokeOptions] = None) -> Output[GetReadOnlyFollowingDatabaseResult]
    func LookupReadOnlyFollowingDatabase(ctx *Context, args *LookupReadOnlyFollowingDatabaseArgs, opts ...InvokeOption) (*LookupReadOnlyFollowingDatabaseResult, error)
    func LookupReadOnlyFollowingDatabaseOutput(ctx *Context, args *LookupReadOnlyFollowingDatabaseOutputArgs, opts ...InvokeOption) LookupReadOnlyFollowingDatabaseResultOutput

    > Note: This function is named LookupReadOnlyFollowingDatabase in the Go SDK.

    public static class GetReadOnlyFollowingDatabase 
    {
        public static Task<GetReadOnlyFollowingDatabaseResult> InvokeAsync(GetReadOnlyFollowingDatabaseArgs args, InvokeOptions? opts = null)
        public static Output<GetReadOnlyFollowingDatabaseResult> Invoke(GetReadOnlyFollowingDatabaseInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetReadOnlyFollowingDatabaseResult> getReadOnlyFollowingDatabase(GetReadOnlyFollowingDatabaseArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:kusto:getReadOnlyFollowingDatabase
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ClusterName string
    The name of the Kusto cluster.
    DatabaseName string
    The name of the database in the Kusto cluster.
    ResourceGroupName string
    The name of the resource group containing the Kusto cluster.
    ClusterName string
    The name of the Kusto cluster.
    DatabaseName string
    The name of the database in the Kusto cluster.
    ResourceGroupName string
    The name of the resource group containing the Kusto cluster.
    clusterName String
    The name of the Kusto cluster.
    databaseName String
    The name of the database in the Kusto cluster.
    resourceGroupName String
    The name of the resource group containing the Kusto cluster.
    clusterName string
    The name of the Kusto cluster.
    databaseName string
    The name of the database in the Kusto cluster.
    resourceGroupName string
    The name of the resource group containing the Kusto cluster.
    cluster_name str
    The name of the Kusto cluster.
    database_name str
    The name of the database in the Kusto cluster.
    resource_group_name str
    The name of the resource group containing the Kusto cluster.
    clusterName String
    The name of the Kusto cluster.
    databaseName String
    The name of the database in the Kusto cluster.
    resourceGroupName String
    The name of the resource group containing the Kusto cluster.

    getReadOnlyFollowingDatabase Result

    The following output properties are available:

    AttachedDatabaseConfigurationName string
    The name of the attached database configuration cluster
    DatabaseShareOrigin string
    The origin of the following setup.
    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    LeaderClusterResourceId string
    The name of the leader cluster
    Name string
    The name of the resource
    OriginalDatabaseName string
    The original database name, before databaseNameOverride or databaseNamePrefix where applied.
    PrincipalsModificationKind string
    The principals modification kind of the database
    ProvisioningState string
    The provisioned state of the resource.
    SoftDeletePeriod string
    The time the data should be kept before it stops being accessible to queries in TimeSpan.
    Statistics Pulumi.AzureNative.Kusto.Outputs.DatabaseStatisticsResponse
    The statistics of the database.
    TableLevelSharingProperties Pulumi.AzureNative.Kusto.Outputs.TableLevelSharingPropertiesResponse
    Table level sharing specifications
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    HotCachePeriod string
    The time the data should be kept in cache for fast queries in TimeSpan.
    Location string
    Resource location.
    AttachedDatabaseConfigurationName string
    The name of the attached database configuration cluster
    DatabaseShareOrigin string
    The origin of the following setup.
    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    LeaderClusterResourceId string
    The name of the leader cluster
    Name string
    The name of the resource
    OriginalDatabaseName string
    The original database name, before databaseNameOverride or databaseNamePrefix where applied.
    PrincipalsModificationKind string
    The principals modification kind of the database
    ProvisioningState string
    The provisioned state of the resource.
    SoftDeletePeriod string
    The time the data should be kept before it stops being accessible to queries in TimeSpan.
    Statistics DatabaseStatisticsResponse
    The statistics of the database.
    TableLevelSharingProperties TableLevelSharingPropertiesResponse
    Table level sharing specifications
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    HotCachePeriod string
    The time the data should be kept in cache for fast queries in TimeSpan.
    Location string
    Resource location.
    attachedDatabaseConfigurationName String
    The name of the attached database configuration cluster
    databaseShareOrigin String
    The origin of the following setup.
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    leaderClusterResourceId String
    The name of the leader cluster
    name String
    The name of the resource
    originalDatabaseName String
    The original database name, before databaseNameOverride or databaseNamePrefix where applied.
    principalsModificationKind String
    The principals modification kind of the database
    provisioningState String
    The provisioned state of the resource.
    softDeletePeriod String
    The time the data should be kept before it stops being accessible to queries in TimeSpan.
    statistics DatabaseStatisticsResponse
    The statistics of the database.
    tableLevelSharingProperties TableLevelSharingPropertiesResponse
    Table level sharing specifications
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    hotCachePeriod String
    The time the data should be kept in cache for fast queries in TimeSpan.
    location String
    Resource location.
    attachedDatabaseConfigurationName string
    The name of the attached database configuration cluster
    databaseShareOrigin string
    The origin of the following setup.
    id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    leaderClusterResourceId string
    The name of the leader cluster
    name string
    The name of the resource
    originalDatabaseName string
    The original database name, before databaseNameOverride or databaseNamePrefix where applied.
    principalsModificationKind string
    The principals modification kind of the database
    provisioningState string
    The provisioned state of the resource.
    softDeletePeriod string
    The time the data should be kept before it stops being accessible to queries in TimeSpan.
    statistics DatabaseStatisticsResponse
    The statistics of the database.
    tableLevelSharingProperties TableLevelSharingPropertiesResponse
    Table level sharing specifications
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    hotCachePeriod string
    The time the data should be kept in cache for fast queries in TimeSpan.
    location string
    Resource location.
    attached_database_configuration_name str
    The name of the attached database configuration cluster
    database_share_origin str
    The origin of the following setup.
    id str
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    leader_cluster_resource_id str
    The name of the leader cluster
    name str
    The name of the resource
    original_database_name str
    The original database name, before databaseNameOverride or databaseNamePrefix where applied.
    principals_modification_kind str
    The principals modification kind of the database
    provisioning_state str
    The provisioned state of the resource.
    soft_delete_period str
    The time the data should be kept before it stops being accessible to queries in TimeSpan.
    statistics DatabaseStatisticsResponse
    The statistics of the database.
    table_level_sharing_properties TableLevelSharingPropertiesResponse
    Table level sharing specifications
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    hot_cache_period str
    The time the data should be kept in cache for fast queries in TimeSpan.
    location str
    Resource location.
    attachedDatabaseConfigurationName String
    The name of the attached database configuration cluster
    databaseShareOrigin String
    The origin of the following setup.
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    leaderClusterResourceId String
    The name of the leader cluster
    name String
    The name of the resource
    originalDatabaseName String
    The original database name, before databaseNameOverride or databaseNamePrefix where applied.
    principalsModificationKind String
    The principals modification kind of the database
    provisioningState String
    The provisioned state of the resource.
    softDeletePeriod String
    The time the data should be kept before it stops being accessible to queries in TimeSpan.
    statistics Property Map
    The statistics of the database.
    tableLevelSharingProperties Property Map
    Table level sharing specifications
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    hotCachePeriod String
    The time the data should be kept in cache for fast queries in TimeSpan.
    location String
    Resource location.

    Supporting Types

    DatabaseStatisticsResponse

    Size double
    The database size - the total size of compressed data and index in bytes.
    Size float64
    The database size - the total size of compressed data and index in bytes.
    size Double
    The database size - the total size of compressed data and index in bytes.
    size number
    The database size - the total size of compressed data and index in bytes.
    size float
    The database size - the total size of compressed data and index in bytes.
    size Number
    The database size - the total size of compressed data and index in bytes.

    TableLevelSharingPropertiesResponse

    ExternalTablesToExclude List<string>
    List of external tables to exclude from the follower database
    ExternalTablesToInclude List<string>
    List of external tables to include in the follower database
    FunctionsToExclude List<string>
    List of functions to exclude from the follower database
    FunctionsToInclude List<string>
    List of functions to include in the follower database
    MaterializedViewsToExclude List<string>
    List of materialized views to exclude from the follower database
    MaterializedViewsToInclude List<string>
    List of materialized views to include in the follower database
    TablesToExclude List<string>
    List of tables to exclude from the follower database
    TablesToInclude List<string>
    List of tables to include in the follower database
    ExternalTablesToExclude []string
    List of external tables to exclude from the follower database
    ExternalTablesToInclude []string
    List of external tables to include in the follower database
    FunctionsToExclude []string
    List of functions to exclude from the follower database
    FunctionsToInclude []string
    List of functions to include in the follower database
    MaterializedViewsToExclude []string
    List of materialized views to exclude from the follower database
    MaterializedViewsToInclude []string
    List of materialized views to include in the follower database
    TablesToExclude []string
    List of tables to exclude from the follower database
    TablesToInclude []string
    List of tables to include in the follower database
    externalTablesToExclude List<String>
    List of external tables to exclude from the follower database
    externalTablesToInclude List<String>
    List of external tables to include in the follower database
    functionsToExclude List<String>
    List of functions to exclude from the follower database
    functionsToInclude List<String>
    List of functions to include in the follower database
    materializedViewsToExclude List<String>
    List of materialized views to exclude from the follower database
    materializedViewsToInclude List<String>
    List of materialized views to include in the follower database
    tablesToExclude List<String>
    List of tables to exclude from the follower database
    tablesToInclude List<String>
    List of tables to include in the follower database
    externalTablesToExclude string[]
    List of external tables to exclude from the follower database
    externalTablesToInclude string[]
    List of external tables to include in the follower database
    functionsToExclude string[]
    List of functions to exclude from the follower database
    functionsToInclude string[]
    List of functions to include in the follower database
    materializedViewsToExclude string[]
    List of materialized views to exclude from the follower database
    materializedViewsToInclude string[]
    List of materialized views to include in the follower database
    tablesToExclude string[]
    List of tables to exclude from the follower database
    tablesToInclude string[]
    List of tables to include in the follower database
    external_tables_to_exclude Sequence[str]
    List of external tables to exclude from the follower database
    external_tables_to_include Sequence[str]
    List of external tables to include in the follower database
    functions_to_exclude Sequence[str]
    List of functions to exclude from the follower database
    functions_to_include Sequence[str]
    List of functions to include in the follower database
    materialized_views_to_exclude Sequence[str]
    List of materialized views to exclude from the follower database
    materialized_views_to_include Sequence[str]
    List of materialized views to include in the follower database
    tables_to_exclude Sequence[str]
    List of tables to exclude from the follower database
    tables_to_include Sequence[str]
    List of tables to include in the follower database
    externalTablesToExclude List<String>
    List of external tables to exclude from the follower database
    externalTablesToInclude List<String>
    List of external tables to include in the follower database
    functionsToExclude List<String>
    List of functions to exclude from the follower database
    functionsToInclude List<String>
    List of functions to include in the follower database
    materializedViewsToExclude List<String>
    List of materialized views to exclude from the follower database
    materializedViewsToInclude List<String>
    List of materialized views to include in the follower database
    tablesToExclude List<String>
    List of tables to exclude from the follower database
    tablesToInclude List<String>
    List of tables to include in the follower database

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi