Docs Packages
  1. Packages
  2. Azure Classic
  3. API Docs
  4. storage
  5. getTableEntities

We recommend using Azure Native.

Azure Classic v5.74.0 published on Monday, Apr 29, 2024 by Pulumi
pulumi/pulumi-azure

azure.storage.getTableEntities

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.74.0 published on Monday, Apr 29, 2024 by Pulumi
pulumi/pulumi-azure

    Use this data source to access information about an existing Storage Table Entity.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = azure.storage.getTableEntities({
    tableName: "example-table-name",
    storageAccountName: "example-storage-account-name",
    filter: "PartitionKey eq 'example'",
});

    import pulumi
import pulumi_azure as azure

example = azure.storage.get_table_entities(table_name="example-table-name",
    storage_account_name="example-storage-account-name",
    filter="PartitionKey eq 'example'")

    package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/storage"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := storage.GetTableEntities(ctx, &storage.GetTableEntitiesArgs{
			TableName:          "example-table-name",
			StorageAccountName: "example-storage-account-name",
			Filter:             "PartitionKey eq 'example'",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = Azure.Storage.GetTableEntities.Invoke(new()
    {
        TableName = "example-table-name",
        StorageAccountName = "example-storage-account-name",
        Filter = "PartitionKey eq 'example'",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.storage.StorageFunctions;
import com.pulumi.azure.storage.inputs.GetTableEntitiesArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = StorageFunctions.getTableEntities(GetTableEntitiesArgs.builder()
            .tableName("example-table-name")
            .storageAccountName("example-storage-account-name")
            .filter("PartitionKey eq 'example'")
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      Function: azure:storage:getTableEntities
      Arguments:
        tableName: example-table-name
        storageAccountName: example-storage-account-name
        filter: PartitionKey eq 'example'

    Using getTableEntities

    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 getTableEntities(args: GetTableEntitiesArgs, opts?: InvokeOptions): Promise<GetTableEntitiesResult>
function getTableEntitiesOutput(args: GetTableEntitiesOutputArgs, opts?: InvokeOptions): Output<GetTableEntitiesResult>
    def get_table_entities(filter: Optional[str] = None,
                       selects: Optional[Sequence[str]] = None,
                       storage_account_name: Optional[str] = None,
                       table_name: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetTableEntitiesResult
def get_table_entities_output(filter: Optional[pulumi.Input[str]] = None,
                       selects: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                       storage_account_name: Optional[pulumi.Input[str]] = None,
                       table_name: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetTableEntitiesResult]
    func GetTableEntities(ctx *Context, args *GetTableEntitiesArgs, opts ...InvokeOption) (*GetTableEntitiesResult, error)
func GetTableEntitiesOutput(ctx *Context, args *GetTableEntitiesOutputArgs, opts ...InvokeOption) GetTableEntitiesResultOutput

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

    public static class GetTableEntities 
{
    public static Task<GetTableEntitiesResult> InvokeAsync(GetTableEntitiesArgs args, InvokeOptions? opts = null)
    public static Output<GetTableEntitiesResult> Invoke(GetTableEntitiesInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetTableEntitiesResult> getTableEntities(GetTableEntitiesArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: azure:storage/getTableEntities:getTableEntities
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Filter string
    The filter used to retrieve the entities.
    StorageAccountName string
    The name of the Storage Account where the Table exists.
    TableName string
    The name of the Table.
    Selects List<string>
    A list of properties to select from the returned Storage Table Entities.
    Filter string
    The filter used to retrieve the entities.
    StorageAccountName string
    The name of the Storage Account where the Table exists.
    TableName string
    The name of the Table.
    Selects []string
    A list of properties to select from the returned Storage Table Entities.
    filter String
    The filter used to retrieve the entities.
    storageAccountName String
    The name of the Storage Account where the Table exists.
    tableName String
    The name of the Table.
    selects List<String>
    A list of properties to select from the returned Storage Table Entities.
    filter string
    The filter used to retrieve the entities.
    storageAccountName string
    The name of the Storage Account where the Table exists.
    tableName string
    The name of the Table.
    selects string[]
    A list of properties to select from the returned Storage Table Entities.
    filter str
    The filter used to retrieve the entities.
    storage_account_name str
    The name of the Storage Account where the Table exists.
    table_name str
    The name of the Table.
    selects Sequence[str]
    A list of properties to select from the returned Storage Table Entities.
    filter String
    The filter used to retrieve the entities.
    storageAccountName String
    The name of the Storage Account where the Table exists.
    tableName String
    The name of the Table.
    selects List<String>
    A list of properties to select from the returned Storage Table Entities.

    getTableEntities Result

    The following output properties are available:

    Filter string
    Id string
    The provider-assigned unique ID for this managed resource.
    Items List<GetTableEntitiesItem>
    A list of items blocks as defined below.
    StorageAccountName string
    TableName string
    Selects List<string>
    Filter string
    Id string
    The provider-assigned unique ID for this managed resource.
    Items []GetTableEntitiesItem
    A list of items blocks as defined below.
    StorageAccountName string
    TableName string
    Selects []string
    filter String
    id String
    The provider-assigned unique ID for this managed resource.
    items List<GetTableEntitiesItem>
    A list of items blocks as defined below.
    storageAccountName String
    tableName String
    selects List<String>
    filter string
    id string
    The provider-assigned unique ID for this managed resource.
    items GetTableEntitiesItem[]
    A list of items blocks as defined below.
    storageAccountName string
    tableName string
    selects string[]
    filter str
    id str
    The provider-assigned unique ID for this managed resource.
    items Sequence[GetTableEntitiesItem]
    A list of items blocks as defined below.
    storage_account_name str
    table_name str
    selects Sequence[str]
    filter String
    id String
    The provider-assigned unique ID for this managed resource.
    items List<Property Map>
    A list of items blocks as defined below.
    storageAccountName String
    tableName String
    selects List<String>

    Supporting Types

    GetTableEntitiesItem

    PartitionKey string
    Partition Key of the Entity.
    Properties Dictionary<string, string>
    A map of any additional properties in key-value format.
    RowKey string
    Row Key of the Entity.
    PartitionKey string
    Partition Key of the Entity.
    Properties map[string]string
    A map of any additional properties in key-value format.
    RowKey string
    Row Key of the Entity.
    partitionKey String
    Partition Key of the Entity.
    properties Map<String,String>
    A map of any additional properties in key-value format.
    rowKey String
    Row Key of the Entity.
    partitionKey string
    Partition Key of the Entity.
    properties {[key: string]: string}
    A map of any additional properties in key-value format.
    rowKey string
    Row Key of the Entity.
    partition_key str
    Partition Key of the Entity.
    properties Mapping[str, str]
    A map of any additional properties in key-value format.
    row_key str
    Row Key of the Entity.
    partitionKey String
    Partition Key of the Entity.
    properties Map<String>
    A map of any additional properties in key-value format.
    rowKey String
    Row Key of the Entity.

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure Classic v5.74.0 published on Monday, Apr 29, 2024 by Pulumi
    pulumi/pulumi-azure