1. Packages
  2. Azure Native
  3. API Docs
  4. documentdb
  5. getSqlResourceSqlRoleDefinition
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.41.0 published on Tuesday, May 14, 2024 by Pulumi

azure-native.documentdb.getSqlResourceSqlRoleDefinition

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.41.0 published on Tuesday, May 14, 2024 by Pulumi

    Retrieves the properties of an existing Azure Cosmos DB SQL Role Definition with the given Id. Azure REST API version: 2023-04-15.

    Other available API versions: 2023-09-15, 2023-09-15-preview, 2023-11-15, 2023-11-15-preview, 2024-02-15-preview.

    Using getSqlResourceSqlRoleDefinition

    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 getSqlResourceSqlRoleDefinition(args: GetSqlResourceSqlRoleDefinitionArgs, opts?: InvokeOptions): Promise<GetSqlResourceSqlRoleDefinitionResult>
    function getSqlResourceSqlRoleDefinitionOutput(args: GetSqlResourceSqlRoleDefinitionOutputArgs, opts?: InvokeOptions): Output<GetSqlResourceSqlRoleDefinitionResult>
    def get_sql_resource_sql_role_definition(account_name: Optional[str] = None,
                                             resource_group_name: Optional[str] = None,
                                             role_definition_id: Optional[str] = None,
                                             opts: Optional[InvokeOptions] = None) -> GetSqlResourceSqlRoleDefinitionResult
    def get_sql_resource_sql_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[GetSqlResourceSqlRoleDefinitionResult]
    func LookupSqlResourceSqlRoleDefinition(ctx *Context, args *LookupSqlResourceSqlRoleDefinitionArgs, opts ...InvokeOption) (*LookupSqlResourceSqlRoleDefinitionResult, error)
    func LookupSqlResourceSqlRoleDefinitionOutput(ctx *Context, args *LookupSqlResourceSqlRoleDefinitionOutputArgs, opts ...InvokeOption) LookupSqlResourceSqlRoleDefinitionResultOutput

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

    public static class GetSqlResourceSqlRoleDefinition 
    {
        public static Task<GetSqlResourceSqlRoleDefinitionResult> InvokeAsync(GetSqlResourceSqlRoleDefinitionArgs args, InvokeOptions? opts = null)
        public static Output<GetSqlResourceSqlRoleDefinitionResult> Invoke(GetSqlResourceSqlRoleDefinitionInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetSqlResourceSqlRoleDefinitionResult> getSqlResourceSqlRoleDefinition(GetSqlResourceSqlRoleDefinitionArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:documentdb:getSqlResourceSqlRoleDefinition
      arguments:
        # arguments dictionary

    The following arguments are supported:

    AccountName string
    Cosmos DB database account name.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    RoleDefinitionId string
    The GUID for the Role Definition.
    AccountName string
    Cosmos DB database account name.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    RoleDefinitionId string
    The GUID for the Role Definition.
    accountName String
    Cosmos DB database account name.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    roleDefinitionId String
    The GUID for the Role Definition.
    accountName string
    Cosmos DB database account name.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    roleDefinitionId string
    The GUID for the Role Definition.
    account_name str
    Cosmos DB database account name.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    role_definition_id str
    The GUID for the Role Definition.
    accountName String
    Cosmos DB database account name.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    roleDefinitionId String
    The GUID for the Role Definition.

    getSqlResourceSqlRoleDefinition Result

    The following output properties are available:

    Id string
    The unique resource identifier of the database account.
    Name string
    The name of the database account.
    Type string
    The type of Azure resource.
    AssignableScopes List<string>
    A set of fully qualified Scopes at or below which 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
    The unique resource identifier of the database account.
    Name string
    The name of the database account.
    Type string
    The type of Azure resource.
    AssignableScopes []string
    A set of fully qualified Scopes at or below which 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
    The unique resource identifier of the database account.
    name String
    The name of the database account.
    type String
    The type of Azure resource.
    assignableScopes List<String>
    A set of fully qualified Scopes at or below which 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
    The unique resource identifier of the database account.
    name string
    The name of the database account.
    type string
    The type of Azure resource.
    assignableScopes string[]
    A set of fully qualified Scopes at or below which 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
    The unique resource identifier of the database account.
    name str
    The name of the database account.
    type str
    The type of Azure resource.
    assignable_scopes Sequence[str]
    A set of fully qualified Scopes at or below which 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
    The unique resource identifier of the database account.
    name String
    The name of the database account.
    type String
    The type of Azure resource.
    assignableScopes List<String>
    A set of fully qualified Scopes at or below which 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.
    NotDataActions List<string>
    An array of data actions that are denied.
    DataActions []string
    An array of data actions that are allowed.
    NotDataActions []string
    An array of data actions that are denied.
    dataActions List<String>
    An array of data actions that are allowed.
    notDataActions List<String>
    An array of data actions that are denied.
    dataActions string[]
    An array of data actions that are allowed.
    notDataActions string[]
    An array of data actions that are denied.
    data_actions Sequence[str]
    An array of data actions that are allowed.
    not_data_actions Sequence[str]
    An array of data actions that are denied.
    dataActions List<String>
    An array of data actions that are allowed.
    notDataActions List<String>
    An array of data actions that are denied.

    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.41.0 published on Tuesday, May 14, 2024 by Pulumi