azure-native-v2.documentdb.SqlResourceSqlRoleAssignment
Explore with Pulumi AI
An Azure Cosmos DB Role Assignment Azure REST API version: 2023-04-15. Prior API version in Azure Native 1.x: 2021-03-01-preview.
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.
Create SqlResourceSqlRoleAssignment Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new SqlResourceSqlRoleAssignment(name: string, args: SqlResourceSqlRoleAssignmentArgs, opts?: CustomResourceOptions);
@overload
def SqlResourceSqlRoleAssignment(resource_name: str,
args: SqlResourceSqlRoleAssignmentArgs,
opts: Optional[ResourceOptions] = None)
@overload
def SqlResourceSqlRoleAssignment(resource_name: str,
opts: Optional[ResourceOptions] = None,
account_name: Optional[str] = None,
resource_group_name: Optional[str] = None,
principal_id: Optional[str] = None,
role_assignment_id: Optional[str] = None,
role_definition_id: Optional[str] = None,
scope: Optional[str] = None)
func NewSqlResourceSqlRoleAssignment(ctx *Context, name string, args SqlResourceSqlRoleAssignmentArgs, opts ...ResourceOption) (*SqlResourceSqlRoleAssignment, error)
public SqlResourceSqlRoleAssignment(string name, SqlResourceSqlRoleAssignmentArgs args, CustomResourceOptions? opts = null)
public SqlResourceSqlRoleAssignment(String name, SqlResourceSqlRoleAssignmentArgs args)
public SqlResourceSqlRoleAssignment(String name, SqlResourceSqlRoleAssignmentArgs args, CustomResourceOptions options)
type: azure-native:documentdb:SqlResourceSqlRoleAssignment
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name
This property is required. string - The unique name of the resource.
- args
This property is required. SqlResourceSqlRoleAssignmentArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
This property is required. str - The unique name of the resource.
- args
This property is required. SqlResourceSqlRoleAssignmentArgs - The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. SqlResourceSqlRoleAssignmentArgs - The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. SqlResourceSqlRoleAssignmentArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name
This property is required. String - The unique name of the resource.
- args
This property is required. SqlResourceSqlRoleAssignmentArgs - The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var sqlResourceSqlRoleAssignmentResource = new AzureNative.Documentdb.SqlResourceSqlRoleAssignment("sqlResourceSqlRoleAssignmentResource", new()
{
AccountName = "string",
ResourceGroupName = "string",
PrincipalId = "string",
RoleAssignmentId = "string",
RoleDefinitionId = "string",
Scope = "string",
});
example, err := documentdb.NewSqlResourceSqlRoleAssignment(ctx, "sqlResourceSqlRoleAssignmentResource", &documentdb.SqlResourceSqlRoleAssignmentArgs{
AccountName: "string",
ResourceGroupName: "string",
PrincipalId: "string",
RoleAssignmentId: "string",
RoleDefinitionId: "string",
Scope: "string",
})
var sqlResourceSqlRoleAssignmentResource = new SqlResourceSqlRoleAssignment("sqlResourceSqlRoleAssignmentResource", SqlResourceSqlRoleAssignmentArgs.builder()
.accountName("string")
.resourceGroupName("string")
.principalId("string")
.roleAssignmentId("string")
.roleDefinitionId("string")
.scope("string")
.build());
sql_resource_sql_role_assignment_resource = azure_native.documentdb.SqlResourceSqlRoleAssignment("sqlResourceSqlRoleAssignmentResource",
account_name=string,
resource_group_name=string,
principal_id=string,
role_assignment_id=string,
role_definition_id=string,
scope=string)
const sqlResourceSqlRoleAssignmentResource = new azure_native.documentdb.SqlResourceSqlRoleAssignment("sqlResourceSqlRoleAssignmentResource", {
accountName: "string",
resourceGroupName: "string",
principalId: "string",
roleAssignmentId: "string",
roleDefinitionId: "string",
scope: "string",
});
type: azure-native:documentdb:SqlResourceSqlRoleAssignment
properties:
accountName: string
principalId: string
resourceGroupName: string
roleAssignmentId: string
roleDefinitionId: string
scope: string
SqlResourceSqlRoleAssignment Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The SqlResourceSqlRoleAssignment resource accepts the following input properties:
- Account
Name This property is required. Changes to this property will trigger replacement.
- Cosmos DB database account name.
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- Principal
Id Changes to this property will trigger replacement.
- The unique identifier for the associated AAD principal in the AAD graph to which access is being granted through this Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription.
- Role
Assignment Id Changes to this property will trigger replacement.
- The GUID for the Role Assignment.
- Role
Definition stringId - The unique identifier for the associated Role Definition.
- Scope
Changes to this property will trigger replacement.
- The data plane resource path for which access is being granted through this Role Assignment.
- Account
Name This property is required. Changes to this property will trigger replacement.
- Cosmos DB database account name.
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- Principal
Id Changes to this property will trigger replacement.
- The unique identifier for the associated AAD principal in the AAD graph to which access is being granted through this Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription.
- Role
Assignment Id Changes to this property will trigger replacement.
- The GUID for the Role Assignment.
- Role
Definition stringId - The unique identifier for the associated Role Definition.
- Scope
Changes to this property will trigger replacement.
- The data plane resource path for which access is being granted through this Role Assignment.
- account
Name This property is required. Changes to this property will trigger replacement.
- Cosmos DB database account name.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- principal
Id Changes to this property will trigger replacement.
- The unique identifier for the associated AAD principal in the AAD graph to which access is being granted through this Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription.
- role
Assignment Id Changes to this property will trigger replacement.
- The GUID for the Role Assignment.
- role
Definition StringId - The unique identifier for the associated Role Definition.
- scope
Changes to this property will trigger replacement.
- The data plane resource path for which access is being granted through this Role Assignment.
- account
Name This property is required. Changes to this property will trigger replacement.
- Cosmos DB database account name.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- principal
Id Changes to this property will trigger replacement.
- The unique identifier for the associated AAD principal in the AAD graph to which access is being granted through this Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription.
- role
Assignment Id Changes to this property will trigger replacement.
- The GUID for the Role Assignment.
- role
Definition stringId - The unique identifier for the associated Role Definition.
- scope
Changes to this property will trigger replacement.
- The data plane resource path for which access is being granted through this Role Assignment.
- account_
name This property is required. Changes to this property will trigger replacement.
- Cosmos DB database account name.
- resource_
group_ name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- principal_
id Changes to this property will trigger replacement.
- The unique identifier for the associated AAD principal in the AAD graph to which access is being granted through this Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription.
- role_
assignment_ id Changes to this property will trigger replacement.
- The GUID for the Role Assignment.
- role_
definition_ strid - The unique identifier for the associated Role Definition.
- scope
Changes to this property will trigger replacement.
- The data plane resource path for which access is being granted through this Role Assignment.
- account
Name This property is required. Changes to this property will trigger replacement.
- Cosmos DB database account name.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- principal
Id Changes to this property will trigger replacement.
- The unique identifier for the associated AAD principal in the AAD graph to which access is being granted through this Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription.
- role
Assignment Id Changes to this property will trigger replacement.
- The GUID for the Role Assignment.
- role
Definition StringId - The unique identifier for the associated Role Definition.
- scope
Changes to this property will trigger replacement.
- The data plane resource path for which access is being granted through this Role Assignment.
Outputs
All input properties are implicitly available as output properties. Additionally, the SqlResourceSqlRoleAssignment resource produces the following output properties:
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:documentdb:SqlResourceSqlRoleAssignment myRoleAssignmentId /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlRoleAssignments/{roleAssignmentId}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- azure-native-v2 pulumi/pulumi-azure-native
- License
- Apache-2.0