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

We recommend using Azure Native.

Azure v6.21.0 published on Friday, Mar 7, 2025 by Pulumi

azure.storage.getTableEntity

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.21.0 published on Friday, Mar 7, 2025 by Pulumi

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.getTableEntity({
    storageTableId: exampleAzurermStorageTable.id,
    partitionKey: "example-partition-key",
    rowKey: "example-row-key",
});
Copy
import pulumi
import pulumi_azure as azure

example = azure.storage.get_table_entity(storage_table_id=example_azurerm_storage_table["id"],
    partition_key="example-partition-key",
    row_key="example-row-key")
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := storage.LookupTableEntity(ctx, &storage.LookupTableEntityArgs{
			StorageTableId: exampleAzurermStorageTable.Id,
			PartitionKey:   "example-partition-key",
			RowKey:         "example-row-key",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = Azure.Storage.GetTableEntity.Invoke(new()
    {
        StorageTableId = exampleAzurermStorageTable.Id,
        PartitionKey = "example-partition-key",
        RowKey = "example-row-key",
    });

});
Copy
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.GetTableEntityArgs;
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.getTableEntity(GetTableEntityArgs.builder()
            .storageTableId(exampleAzurermStorageTable.id())
            .partitionKey("example-partition-key")
            .rowKey("example-row-key")
            .build());

    }
}
Copy
variables:
  example:
    fn::invoke:
      function: azure:storage:getTableEntity
      arguments:
        storageTableId: ${exampleAzurermStorageTable.id}
        partitionKey: example-partition-key
        rowKey: example-row-key
Copy

Using getTableEntity

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 getTableEntity(args: GetTableEntityArgs, opts?: InvokeOptions): Promise<GetTableEntityResult>
function getTableEntityOutput(args: GetTableEntityOutputArgs, opts?: InvokeOptions): Output<GetTableEntityResult>
Copy
def get_table_entity(partition_key: Optional[str] = None,
                     row_key: Optional[str] = None,
                     storage_table_id: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetTableEntityResult
def get_table_entity_output(partition_key: Optional[pulumi.Input[str]] = None,
                     row_key: Optional[pulumi.Input[str]] = None,
                     storage_table_id: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetTableEntityResult]
Copy
func LookupTableEntity(ctx *Context, args *LookupTableEntityArgs, opts ...InvokeOption) (*LookupTableEntityResult, error)
func LookupTableEntityOutput(ctx *Context, args *LookupTableEntityOutputArgs, opts ...InvokeOption) LookupTableEntityResultOutput
Copy

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

public static class GetTableEntity 
{
    public static Task<GetTableEntityResult> InvokeAsync(GetTableEntityArgs args, InvokeOptions? opts = null)
    public static Output<GetTableEntityResult> Invoke(GetTableEntityInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetTableEntityResult> getTableEntity(GetTableEntityArgs args, InvokeOptions options)
public static Output<GetTableEntityResult> getTableEntity(GetTableEntityArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure:storage/getTableEntity:getTableEntity
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

PartitionKey This property is required. string
The key for the partition where the entity will be retrieved.
RowKey This property is required. string
The key for the row where the entity will be retrieved.
StorageTableId This property is required. string
The Storage Table ID where the entity exists.
PartitionKey This property is required. string
The key for the partition where the entity will be retrieved.
RowKey This property is required. string
The key for the row where the entity will be retrieved.
StorageTableId This property is required. string
The Storage Table ID where the entity exists.
partitionKey This property is required. String
The key for the partition where the entity will be retrieved.
rowKey This property is required. String
The key for the row where the entity will be retrieved.
storageTableId This property is required. String
The Storage Table ID where the entity exists.
partitionKey This property is required. string
The key for the partition where the entity will be retrieved.
rowKey This property is required. string
The key for the row where the entity will be retrieved.
storageTableId This property is required. string
The Storage Table ID where the entity exists.
partition_key This property is required. str
The key for the partition where the entity will be retrieved.
row_key This property is required. str
The key for the row where the entity will be retrieved.
storage_table_id This property is required. str
The Storage Table ID where the entity exists.
partitionKey This property is required. String
The key for the partition where the entity will be retrieved.
rowKey This property is required. String
The key for the row where the entity will be retrieved.
storageTableId This property is required. String
The Storage Table ID where the entity exists.

getTableEntity Result

The following output properties are available:

Entity Dictionary<string, string>
A map of key/value pairs that describe the entity to be stored in the storage table.
Id string
The provider-assigned unique ID for this managed resource.
PartitionKey string
RowKey string
StorageTableId string
Entity map[string]string
A map of key/value pairs that describe the entity to be stored in the storage table.
Id string
The provider-assigned unique ID for this managed resource.
PartitionKey string
RowKey string
StorageTableId string
entity Map<String,String>
A map of key/value pairs that describe the entity to be stored in the storage table.
id String
The provider-assigned unique ID for this managed resource.
partitionKey String
rowKey String
storageTableId String
entity {[key: string]: string}
A map of key/value pairs that describe the entity to be stored in the storage table.
id string
The provider-assigned unique ID for this managed resource.
partitionKey string
rowKey string
storageTableId string
entity Mapping[str, str]
A map of key/value pairs that describe the entity to be stored in the storage table.
id str
The provider-assigned unique ID for this managed resource.
partition_key str
row_key str
storage_table_id str
entity Map<String>
A map of key/value pairs that describe the entity to be stored in the storage table.
id String
The provider-assigned unique ID for this managed resource.
partitionKey String
rowKey String
storageTableId String

Package Details

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

We recommend using Azure Native.

Azure v6.21.0 published on Friday, Mar 7, 2025 by Pulumi