azure-native.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.
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",
});
});
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
})
}
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());
}
}
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")
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",
});
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
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 string
- The unique name of the resource.
- args SqlResourceSqlRoleAssignmentArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args 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 string
- The unique name of the resource.
- args SqlResourceSqlRoleAssignmentArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args SqlResourceSqlRoleAssignmentArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args 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: pulumi.String("string"),
ResourceGroupName: pulumi.String("string"),
PrincipalId: pulumi.String("string"),
RoleAssignmentId: pulumi.String("string"),
RoleDefinitionId: pulumi.String("string"),
Scope: pulumi.String("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
The SqlResourceSqlRoleAssignment resource accepts the following input properties:
- Account
Name string - Cosmos DB database account name.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Principal
Id 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.
- Role
Assignment stringId - The GUID for the Role Assignment.
- Role
Definition stringId - The unique identifier for the associated Role Definition.
- Scope string
- The data plane resource path for which access is being granted through this Role Assignment.
- Account
Name string - Cosmos DB database account name.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Principal
Id 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.
- Role
Assignment stringId - The GUID for the Role Assignment.
- Role
Definition stringId - The unique identifier for the associated Role Definition.
- Scope string
- The data plane resource path for which access is being granted through this Role Assignment.
- account
Name String - Cosmos DB database account name.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- principal
Id 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.
- role
Assignment StringId - The GUID for the Role Assignment.
- role
Definition StringId - The unique identifier for the associated Role Definition.
- scope String
- The data plane resource path for which access is being granted through this Role Assignment.
- account
Name string - Cosmos DB database account name.
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- principal
Id 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.
- role
Assignment stringId - The GUID for the Role Assignment.
- role
Definition stringId - The unique identifier for the associated Role Definition.
- scope string
- The data plane resource path for which access is being granted through this Role Assignment.
- account_
name str - Cosmos DB database account name.
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- principal_
id 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_ strid - The GUID for the Role Assignment.
- role_
definition_ strid - The unique identifier for the associated Role Definition.
- scope str
- The data plane resource path for which access is being granted through this Role Assignment.
- account
Name String - Cosmos DB database account name.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- principal
Id 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.
- role
Assignment StringId - The GUID for the Role Assignment.
- role
Definition StringId - The unique identifier for the associated Role Definition.
- scope 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:
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 pulumi/pulumi-azure-native
- License
- Apache-2.0