azure-native.documentdb.getSqlResourceSqlRoleDefinition
Explore with Pulumi AI
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, 2024-05-15, 2024-05-15-preview, 2024-08-15, 2024-09-01-preview, 2024-11-15, 2024-12-01-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:
- Account
Name string - Cosmos DB database account name.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Role
Definition stringId - The GUID for the Role Definition.
- Account
Name string - Cosmos DB database account name.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Role
Definition stringId - The GUID for the Role Definition.
- account
Name String - Cosmos DB database account name.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- role
Definition StringId - The GUID for the Role Definition.
- account
Name string - Cosmos DB database account name.
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- role
Definition stringId - The GUID for the Role Definition.
- account_
name str - Cosmos DB database account name.
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- role_
definition_ strid - The GUID for the Role Definition.
- account
Name String - Cosmos DB database account name.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- role
Definition StringId - 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.
- Assignable
Scopes 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.
Azure Native. Document DB. Outputs. Permission Response> - The set of operations allowed through this Role Definition.
- Role
Name 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.
- Assignable
Scopes []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
[]Permission
Response - The set of operations allowed through this Role Definition.
- Role
Name 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.
- assignable
Scopes 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<Permission
Response> - The set of operations allowed through this Role Definition.
- role
Name 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.
- assignable
Scopes 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
Permission
Response[] - The set of operations allowed through this Role Definition.
- role
Name 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[Permission
Response] - 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.
- assignable
Scopes 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.
- role
Name String - A user-friendly name for the Role Definition. Must be unique for the database account.
Supporting Types
PermissionResponse
- Data
Actions List<string> - An array of data actions that are allowed.
- Id string
- The id for the permission.
- Not
Data List<string>Actions - An array of data actions that are denied.
- Data
Actions []string - An array of data actions that are allowed.
- Id string
- The id for the permission.
- Not
Data []stringActions - An array of data actions that are denied.
- data
Actions List<String> - An array of data actions that are allowed.
- id String
- The id for the permission.
- not
Data List<String>Actions - An array of data actions that are denied.
- data
Actions string[] - An array of data actions that are allowed.
- id string
- The id for the permission.
- not
Data string[]Actions - 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_ Sequence[str]actions - An array of data actions that are denied.
- data
Actions List<String> - An array of data actions that are allowed.
- id String
- The id for the permission.
- not
Data List<String>Actions - An array of data actions that are denied.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0