1. Packages
  2. Databricks Provider
  3. API Docs
  4. getOnlineStores
Databricks v1.77.0 published on Tuesday, Nov 4, 2025 by Pulumi
pulumi/pulumi-databricks

databricks.getOnlineStores

Get Started
databricks logo
Databricks v1.77.0 published on Tuesday, Nov 4, 2025 by Pulumi
pulumi/pulumi-databricks

    Private Preview

    Using getOnlineStores

    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 getOnlineStores(args: GetOnlineStoresArgs, opts?: InvokeOptions): Promise<GetOnlineStoresResult>
function getOnlineStoresOutput(args: GetOnlineStoresOutputArgs, opts?: InvokeOptions): Output<GetOnlineStoresResult>
    def get_online_stores(page_size: Optional[int] = None,
                      opts: Optional[InvokeOptions] = None) -> GetOnlineStoresResult
def get_online_stores_output(page_size: Optional[pulumi.Input[int]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetOnlineStoresResult]
    func GetOnlineStores(ctx *Context, args *GetOnlineStoresArgs, opts ...InvokeOption) (*GetOnlineStoresResult, error)
func GetOnlineStoresOutput(ctx *Context, args *GetOnlineStoresOutputArgs, opts ...InvokeOption) GetOnlineStoresResultOutput

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

    public static class GetOnlineStores 
{
    public static Task<GetOnlineStoresResult> InvokeAsync(GetOnlineStoresArgs args, InvokeOptions? opts = null)
    public static Output<GetOnlineStoresResult> Invoke(GetOnlineStoresInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetOnlineStoresResult> getOnlineStores(GetOnlineStoresArgs args, InvokeOptions options)
public static Output<GetOnlineStoresResult> getOnlineStores(GetOnlineStoresArgs args, InvokeOptions options)

    fn::invoke:
  function: databricks:index/getOnlineStores:getOnlineStores
  arguments:
    # arguments dictionary

    The following arguments are supported:

    PageSize int
    The maximum number of results to return. Defaults to 100 if not specified
    PageSize int
    The maximum number of results to return. Defaults to 100 if not specified
    pageSize Integer
    The maximum number of results to return. Defaults to 100 if not specified
    pageSize number
    The maximum number of results to return. Defaults to 100 if not specified
    page_size int
    The maximum number of results to return. Defaults to 100 if not specified
    pageSize Number
    The maximum number of results to return. Defaults to 100 if not specified

    getOnlineStores Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    OnlineStores List<GetOnlineStoresOnlineStore>
    PageSize int
    Id string
    The provider-assigned unique ID for this managed resource.
    OnlineStores []GetOnlineStoresOnlineStore
    PageSize int
    id String
    The provider-assigned unique ID for this managed resource.
    onlineStores List<GetOnlineStoresOnlineStore>
    pageSize Integer
    id string
    The provider-assigned unique ID for this managed resource.
    onlineStores GetOnlineStoresOnlineStore[]
    pageSize number
    id str
    The provider-assigned unique ID for this managed resource.
    online_stores Sequence[GetOnlineStoresOnlineStore]
    page_size int
    id String
    The provider-assigned unique ID for this managed resource.
    onlineStores List<Property Map>
    pageSize Number

    Supporting Types

    GetOnlineStoresOnlineStore

    Capacity string
    (string) - The capacity of the online store. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
    CreationTime string
    (string) - The timestamp when the online store was created
    Creator string
    (string) - The email of the creator of the online store
    Name string
    (string) - The name of the online store. This is the unique identifier for the online store
    ReadReplicaCount int
    (integer) - The number of read replicas for the online store. Defaults to 0
    State string
    (string) - The current state of the online store. Possible values are: AVAILABLE, DELETING, FAILING_OVER, STARTING, STOPPED, UPDATING
    Capacity string
    (string) - The capacity of the online store. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
    CreationTime string
    (string) - The timestamp when the online store was created
    Creator string
    (string) - The email of the creator of the online store
    Name string
    (string) - The name of the online store. This is the unique identifier for the online store
    ReadReplicaCount int
    (integer) - The number of read replicas for the online store. Defaults to 0
    State string
    (string) - The current state of the online store. Possible values are: AVAILABLE, DELETING, FAILING_OVER, STARTING, STOPPED, UPDATING
    capacity String
    (string) - The capacity of the online store. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
    creationTime String
    (string) - The timestamp when the online store was created
    creator String
    (string) - The email of the creator of the online store
    name String
    (string) - The name of the online store. This is the unique identifier for the online store
    readReplicaCount Integer
    (integer) - The number of read replicas for the online store. Defaults to 0
    state String
    (string) - The current state of the online store. Possible values are: AVAILABLE, DELETING, FAILING_OVER, STARTING, STOPPED, UPDATING
    capacity string
    (string) - The capacity of the online store. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
    creationTime string
    (string) - The timestamp when the online store was created
    creator string
    (string) - The email of the creator of the online store
    name string
    (string) - The name of the online store. This is the unique identifier for the online store
    readReplicaCount number
    (integer) - The number of read replicas for the online store. Defaults to 0
    state string
    (string) - The current state of the online store. Possible values are: AVAILABLE, DELETING, FAILING_OVER, STARTING, STOPPED, UPDATING
    capacity str
    (string) - The capacity of the online store. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
    creation_time str
    (string) - The timestamp when the online store was created
    creator str
    (string) - The email of the creator of the online store
    name str
    (string) - The name of the online store. This is the unique identifier for the online store
    read_replica_count int
    (integer) - The number of read replicas for the online store. Defaults to 0
    state str
    (string) - The current state of the online store. Possible values are: AVAILABLE, DELETING, FAILING_OVER, STARTING, STOPPED, UPDATING
    capacity String
    (string) - The capacity of the online store. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
    creationTime String
    (string) - The timestamp when the online store was created
    creator String
    (string) - The email of the creator of the online store
    name String
    (string) - The name of the online store. This is the unique identifier for the online store
    readReplicaCount Number
    (integer) - The number of read replicas for the online store. Defaults to 0
    state String
    (string) - The current state of the online store. Possible values are: AVAILABLE, DELETING, FAILING_OVER, STARTING, STOPPED, UPDATING

    Package Details

    Repository
    databricks pulumi/pulumi-databricks
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the databricks Terraform Provider.
    databricks logo
    Databricks v1.77.0 published on Tuesday, Nov 4, 2025 by Pulumi
    pulumi/pulumi-databricks
      Meet Neo: Your AI Platform Teammate