Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. documentdb
  5. getTableResourceTableRoleDefinition
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.documentdb.getTableResourceTableRoleDefinition

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Retrieves the properties of an existing Azure Cosmos DB Table Role Definition with the given Id. Azure REST API version: 2024-12-01-preview.

Using getTableResourceTableRoleDefinition

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 getTableResourceTableRoleDefinition(args: GetTableResourceTableRoleDefinitionArgs, opts?: InvokeOptions): Promise<GetTableResourceTableRoleDefinitionResult>
function getTableResourceTableRoleDefinitionOutput(args: GetTableResourceTableRoleDefinitionOutputArgs, opts?: InvokeOptions): Output<GetTableResourceTableRoleDefinitionResult>
Copy
def get_table_resource_table_role_definition(account_name: Optional[str] = None,
                                             resource_group_name: Optional[str] = None,
                                             role_definition_id: Optional[str] = None,
                                             opts: Optional[InvokeOptions] = None) -> GetTableResourceTableRoleDefinitionResult
def get_table_resource_table_role_definition_output(account_name: Optional[pulumi.Input[str]] = None,
                                             resource_group_name: Optional[pulumi.Input[str]] = None,
                                             role_definition_id: Optional[pulumi.Input[str]] = None,
                                             opts: Optional[InvokeOptions] = None) -> Output[GetTableResourceTableRoleDefinitionResult]
Copy
func LookupTableResourceTableRoleDefinition(ctx *Context, args *LookupTableResourceTableRoleDefinitionArgs, opts ...InvokeOption) (*LookupTableResourceTableRoleDefinitionResult, error)
func LookupTableResourceTableRoleDefinitionOutput(ctx *Context, args *LookupTableResourceTableRoleDefinitionOutputArgs, opts ...InvokeOption) LookupTableResourceTableRoleDefinitionResultOutput
Copy

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

public static class GetTableResourceTableRoleDefinition 
{
    public static Task<GetTableResourceTableRoleDefinitionResult> InvokeAsync(GetTableResourceTableRoleDefinitionArgs args, InvokeOptions? opts = null)
    public static Output<GetTableResourceTableRoleDefinitionResult> Invoke(GetTableResourceTableRoleDefinitionInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetTableResourceTableRoleDefinitionResult> getTableResourceTableRoleDefinition(GetTableResourceTableRoleDefinitionArgs args, InvokeOptions options)
public static Output<GetTableResourceTableRoleDefinitionResult> getTableResourceTableRoleDefinition(GetTableResourceTableRoleDefinitionArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:documentdb:getTableResourceTableRoleDefinition
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

AccountName
This property is required.
Changes to this property will trigger replacement.
string
Cosmos DB database account name.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
RoleDefinitionId
This property is required.
Changes to this property will trigger replacement.
string
The GUID for the Role Definition.
AccountName
This property is required.
Changes to this property will trigger replacement.
string
Cosmos DB database account name.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
RoleDefinitionId
This property is required.
Changes to this property will trigger replacement.
string
The GUID for the Role Definition.
accountName
This property is required.
Changes to this property will trigger replacement.
String
Cosmos DB database account name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
roleDefinitionId
This property is required.
Changes to this property will trigger replacement.
String
The GUID for the Role Definition.
accountName
This property is required.
Changes to this property will trigger replacement.
string
Cosmos DB database account name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
roleDefinitionId
This property is required.
Changes to this property will trigger replacement.
string
The GUID for the Role Definition.
account_name
This property is required.
Changes to this property will trigger replacement.
str
Cosmos DB database account name.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
role_definition_id
This property is required.
Changes to this property will trigger replacement.
str
The GUID for the Role Definition.
accountName
This property is required.
Changes to this property will trigger replacement.
String
Cosmos DB database account name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
roleDefinitionId
This property is required.
Changes to this property will trigger replacement.
String
The GUID for the Role Definition.

getTableResourceTableRoleDefinition Result

The following output properties are available:

Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Name string
The name of the resource
SystemData Pulumi.AzureNative.DocumentDB.Outputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
AssignableScopes List<string>
A set of fully qualified Scopes at or below which Table Role Assignments may be created using this Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Must have at least one element. Scopes higher than Database account are not enforceable as assignable Scopes. Note that resources referenced in assignable Scopes need not exist.
Permissions List<Pulumi.AzureNative.DocumentDB.Outputs.PermissionResponse>
The set of operations allowed through this Role Definition.
RoleName string
A user-friendly name for the Role Definition. Must be unique for the database account.
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Name string
The name of the resource
SystemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
AssignableScopes []string
A set of fully qualified Scopes at or below which Table Role Assignments may be created using this Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Must have at least one element. Scopes higher than Database account are not enforceable as assignable Scopes. Note that resources referenced in assignable Scopes need not exist.
Permissions []PermissionResponse
The set of operations allowed through this Role Definition.
RoleName string
A user-friendly name for the Role Definition. Must be unique for the database account.
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name String
The name of the resource
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
assignableScopes List<String>
A set of fully qualified Scopes at or below which Table Role Assignments may be created using this Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Must have at least one element. Scopes higher than Database account are not enforceable as assignable Scopes. Note that resources referenced in assignable Scopes need not exist.
permissions List<PermissionResponse>
The set of operations allowed through this Role Definition.
roleName String
A user-friendly name for the Role Definition. Must be unique for the database account.
id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name string
The name of the resource
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
assignableScopes string[]
A set of fully qualified Scopes at or below which Table Role Assignments may be created using this Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Must have at least one element. Scopes higher than Database account are not enforceable as assignable Scopes. Note that resources referenced in assignable Scopes need not exist.
permissions PermissionResponse[]
The set of operations allowed through this Role Definition.
roleName string
A user-friendly name for the Role Definition. Must be unique for the database account.
id str
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name str
The name of the resource
system_data SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
assignable_scopes Sequence[str]
A set of fully qualified Scopes at or below which Table Role Assignments may be created using this Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Must have at least one element. Scopes higher than Database account are not enforceable as assignable Scopes. Note that resources referenced in assignable Scopes need not exist.
permissions Sequence[PermissionResponse]
The set of operations allowed through this Role Definition.
role_name str
A user-friendly name for the Role Definition. Must be unique for the database account.
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name String
The name of the resource
systemData Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
assignableScopes List<String>
A set of fully qualified Scopes at or below which Table Role Assignments may be created using this Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Must have at least one element. Scopes higher than Database account are not enforceable as assignable Scopes. Note that resources referenced in assignable Scopes need not exist.
permissions List<Property Map>
The set of operations allowed through this Role Definition.
roleName String
A user-friendly name for the Role Definition. Must be unique for the database account.

Supporting Types

PermissionResponse

DataActions List<string>
An array of data actions that are allowed.
Id string
The id for the permission.
NotDataActions List<string>
An array of data actions that are denied.
DataActions []string
An array of data actions that are allowed.
Id string
The id for the permission.
NotDataActions []string
An array of data actions that are denied.
dataActions List<String>
An array of data actions that are allowed.
id String
The id for the permission.
notDataActions List<String>
An array of data actions that are denied.
dataActions string[]
An array of data actions that are allowed.
id string
The id for the permission.
notDataActions string[]
An array of data actions that are denied.
data_actions Sequence[str]
An array of data actions that are allowed.
id str
The id for the permission.
not_data_actions Sequence[str]
An array of data actions that are denied.
dataActions List<String>
An array of data actions that are allowed.
id String
The id for the permission.
notDataActions List<String>
An array of data actions that are denied.

SystemDataResponse

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native