Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. documentdb
  5. SqlResourceSqlRoleAssignment
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.SqlResourceSqlRoleAssignment

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

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.

Example Usage

CosmosDBSqlRoleAssignmentCreateUpdate

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var sqlResourceSqlRoleAssignment = new AzureNative.DocumentDB.SqlResourceSqlRoleAssignment("sqlResourceSqlRoleAssignment", new()
    {
        AccountName = "myAccountName",
        PrincipalId = "myPrincipalId",
        ResourceGroupName = "myResourceGroupName",
        RoleAssignmentId = "myRoleAssignmentId",
        RoleDefinitionId = "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/sqlRoleDefinitions/myRoleDefinitionId",
        Scope = "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/dbs/purchases/colls/redmond-purchases",
    });

});
Copy
package main

import (
	documentdb "github.com/pulumi/pulumi-azure-native-sdk/documentdb/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := documentdb.NewSqlResourceSqlRoleAssignment(ctx, "sqlResourceSqlRoleAssignment", &documentdb.SqlResourceSqlRoleAssignmentArgs{
			AccountName:       pulumi.String("myAccountName"),
			PrincipalId:       pulumi.String("myPrincipalId"),
			ResourceGroupName: pulumi.String("myResourceGroupName"),
			RoleAssignmentId:  pulumi.String("myRoleAssignmentId"),
			RoleDefinitionId:  pulumi.String("/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/sqlRoleDefinitions/myRoleDefinitionId"),
			Scope:             pulumi.String("/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/dbs/purchases/colls/redmond-purchases"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.documentdb.SqlResourceSqlRoleAssignment;
import com.pulumi.azurenative.documentdb.SqlResourceSqlRoleAssignmentArgs;
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) {
        var sqlResourceSqlRoleAssignment = new SqlResourceSqlRoleAssignment("sqlResourceSqlRoleAssignment", SqlResourceSqlRoleAssignmentArgs.builder()
            .accountName("myAccountName")
            .principalId("myPrincipalId")
            .resourceGroupName("myResourceGroupName")
            .roleAssignmentId("myRoleAssignmentId")
            .roleDefinitionId("/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/sqlRoleDefinitions/myRoleDefinitionId")
            .scope("/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/dbs/purchases/colls/redmond-purchases")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const sqlResourceSqlRoleAssignment = new azure_native.documentdb.SqlResourceSqlRoleAssignment("sqlResourceSqlRoleAssignment", {
    accountName: "myAccountName",
    principalId: "myPrincipalId",
    resourceGroupName: "myResourceGroupName",
    roleAssignmentId: "myRoleAssignmentId",
    roleDefinitionId: "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/sqlRoleDefinitions/myRoleDefinitionId",
    scope: "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/dbs/purchases/colls/redmond-purchases",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

sql_resource_sql_role_assignment = azure_native.documentdb.SqlResourceSqlRoleAssignment("sqlResourceSqlRoleAssignment",
    account_name="myAccountName",
    principal_id="myPrincipalId",
    resource_group_name="myResourceGroupName",
    role_assignment_id="myRoleAssignmentId",
    role_definition_id="/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/sqlRoleDefinitions/myRoleDefinitionId",
    scope="/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/dbs/purchases/colls/redmond-purchases")
Copy
resources:
  sqlResourceSqlRoleAssignment:
    type: azure-native:documentdb:SqlResourceSqlRoleAssignment
    properties:
      accountName: myAccountName
      principalId: myPrincipalId
      resourceGroupName: myResourceGroupName
      roleAssignmentId: myRoleAssignmentId
      roleDefinitionId: /subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/sqlRoleDefinitions/myRoleDefinitionId
      scope: /subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/dbs/purchases/colls/redmond-purchases
Copy

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",
});
Copy
example, err := documentdb.NewSqlResourceSqlRoleAssignment(ctx, "sqlResourceSqlRoleAssignmentResource", &documentdb.SqlResourceSqlRoleAssignmentArgs{
	AccountName:       "string",
	ResourceGroupName: "string",
	PrincipalId:       "string",
	RoleAssignmentId:  "string",
	RoleDefinitionId:  "string",
	Scope:             "string",
})
Copy
var sqlResourceSqlRoleAssignmentResource = new SqlResourceSqlRoleAssignment("sqlResourceSqlRoleAssignmentResource", SqlResourceSqlRoleAssignmentArgs.builder()
    .accountName("string")
    .resourceGroupName("string")
    .principalId("string")
    .roleAssignmentId("string")
    .roleDefinitionId("string")
    .scope("string")
    .build());
Copy
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)
Copy
const sqlResourceSqlRoleAssignmentResource = new azure_native.documentdb.SqlResourceSqlRoleAssignment("sqlResourceSqlRoleAssignmentResource", {
    accountName: "string",
    resourceGroupName: "string",
    principalId: "string",
    roleAssignmentId: "string",
    roleDefinitionId: "string",
    scope: "string",
});
Copy
type: azure-native:documentdb:SqlResourceSqlRoleAssignment
properties:
    accountName: string
    principalId: string
    resourceGroupName: string
    roleAssignmentId: string
    roleDefinitionId: string
    scope: string
Copy

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:

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.
PrincipalId Changes to this property will trigger replacement. string
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.
RoleAssignmentId Changes to this property will trigger replacement. string
The GUID for the Role Assignment.
RoleDefinitionId string
The unique identifier for the associated Role Definition.
Scope Changes to this property will trigger replacement. string
The data plane resource path for which access is being granted through this Role Assignment.
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.
PrincipalId Changes to this property will trigger replacement. string
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.
RoleAssignmentId Changes to this property will trigger replacement. string
The GUID for the Role Assignment.
RoleDefinitionId string
The unique identifier for the associated Role Definition.
Scope Changes to this property will trigger replacement. string
The data plane resource path for which access is being granted through this Role Assignment.
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.
principalId Changes to this property will trigger replacement. String
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.
roleAssignmentId Changes to this property will trigger replacement. String
The GUID for the Role Assignment.
roleDefinitionId String
The unique identifier for the associated Role Definition.
scope Changes to this property will trigger replacement. String
The data plane resource path for which access is being granted through this Role Assignment.
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.
principalId Changes to this property will trigger replacement. string
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.
roleAssignmentId Changes to this property will trigger replacement. string
The GUID for the Role Assignment.
roleDefinitionId string
The unique identifier for the associated Role Definition.
scope Changes to this property will trigger replacement. string
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.
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.
principal_id Changes to this property will trigger replacement. str
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. str
The GUID for the Role Assignment.
role_definition_id str
The unique identifier for the associated Role Definition.
scope Changes to this property will trigger replacement. str
The data plane resource path for which access is being granted through this Role Assignment.
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.
principalId Changes to this property will trigger replacement. String
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.
roleAssignmentId Changes to this property will trigger replacement. String
The GUID for the Role Assignment.
roleDefinitionId String
The unique identifier for the associated Role Definition.
scope Changes to this property will trigger replacement. String
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:

Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the database account.
Type string
The type of Azure resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the database account.
Type string
The type of Azure resource.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the database account.
type String
The type of Azure resource.
id string
The provider-assigned unique ID for this managed resource.
name string
The name of the database account.
type string
The type of Azure resource.
id str
The provider-assigned unique ID for this managed resource.
name str
The name of the database account.
type str
The type of Azure resource.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the database account.
type String
The type of Azure resource.

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}
Copy

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
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