1. Packages
  2. Azure Native
  3. API Docs
  4. cosmosdb
  5. GremlinResourceGremlinRoleAssignment
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.4.0 published on Wednesday, May 7, 2025 by Pulumi

azure-native.cosmosdb.GremlinResourceGremlinRoleAssignment

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.4.0 published on Wednesday, May 7, 2025 by Pulumi

    Parameters to create and update an Azure Cosmos DB Gremlin Role Assignment.

    Uses Azure REST API version 2025-05-01-preview.

    Example Usage

    CosmosDBGremlinRoleAssignmentCreateUpdate

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var gremlinResourceGremlinRoleAssignment = new AzureNative.CosmosDB.GremlinResourceGremlinRoleAssignment("gremlinResourceGremlinRoleAssignment", new()
        {
            AccountName = "myAccountName",
            PrincipalId = "myPrincipalId",
            ResourceGroupName = "myResourceGroupName",
            RoleAssignmentId = "myRoleAssignmentId",
            RoleDefinitionId = "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/gremlinRoleDefinitions/myRoleDefinitionId",
            Scope = "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/dbs/purchases/colls/redmond-purchases",
        });
    
    });
    
    package main
    
    import (
    	cosmosdb "github.com/pulumi/pulumi-azure-native-sdk/cosmosdb/v3"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := cosmosdb.NewGremlinResourceGremlinRoleAssignment(ctx, "gremlinResourceGremlinRoleAssignment", &cosmosdb.GremlinResourceGremlinRoleAssignmentArgs{
    			AccountName:       pulumi.String("myAccountName"),
    			PrincipalId:       pulumi.String("myPrincipalId"),
    			ResourceGroupName: pulumi.String("myResourceGroupName"),
    			RoleAssignmentId:  pulumi.String("myRoleAssignmentId"),
    			RoleDefinitionId:  pulumi.String("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/gremlinRoleDefinitions/myRoleDefinitionId"),
    			Scope:             pulumi.String("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/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.cosmosdb.GremlinResourceGremlinRoleAssignment;
    import com.pulumi.azurenative.cosmosdb.GremlinResourceGremlinRoleAssignmentArgs;
    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 gremlinResourceGremlinRoleAssignment = new GremlinResourceGremlinRoleAssignment("gremlinResourceGremlinRoleAssignment", GremlinResourceGremlinRoleAssignmentArgs.builder()
                .accountName("myAccountName")
                .principalId("myPrincipalId")
                .resourceGroupName("myResourceGroupName")
                .roleAssignmentId("myRoleAssignmentId")
                .roleDefinitionId("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/gremlinRoleDefinitions/myRoleDefinitionId")
                .scope("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/dbs/purchases/colls/redmond-purchases")
                .build());
    
        }
    }
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const gremlinResourceGremlinRoleAssignment = new azure_native.cosmosdb.GremlinResourceGremlinRoleAssignment("gremlinResourceGremlinRoleAssignment", {
        accountName: "myAccountName",
        principalId: "myPrincipalId",
        resourceGroupName: "myResourceGroupName",
        roleAssignmentId: "myRoleAssignmentId",
        roleDefinitionId: "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/gremlinRoleDefinitions/myRoleDefinitionId",
        scope: "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/dbs/purchases/colls/redmond-purchases",
    });
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    gremlin_resource_gremlin_role_assignment = azure_native.cosmosdb.GremlinResourceGremlinRoleAssignment("gremlinResourceGremlinRoleAssignment",
        account_name="myAccountName",
        principal_id="myPrincipalId",
        resource_group_name="myResourceGroupName",
        role_assignment_id="myRoleAssignmentId",
        role_definition_id="/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/gremlinRoleDefinitions/myRoleDefinitionId",
        scope="/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/dbs/purchases/colls/redmond-purchases")
    
    resources:
      gremlinResourceGremlinRoleAssignment:
        type: azure-native:cosmosdb:GremlinResourceGremlinRoleAssignment
        properties:
          accountName: myAccountName
          principalId: myPrincipalId
          resourceGroupName: myResourceGroupName
          roleAssignmentId: myRoleAssignmentId
          roleDefinitionId: /subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/gremlinRoleDefinitions/myRoleDefinitionId
          scope: /subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/dbs/purchases/colls/redmond-purchases
    

    Create GremlinResourceGremlinRoleAssignment Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new GremlinResourceGremlinRoleAssignment(name: string, args: GremlinResourceGremlinRoleAssignmentArgs, opts?: CustomResourceOptions);
    @overload
    def GremlinResourceGremlinRoleAssignment(resource_name: str,
                                             args: GremlinResourceGremlinRoleAssignmentArgs,
                                             opts: Optional[ResourceOptions] = None)
    
    @overload
    def GremlinResourceGremlinRoleAssignment(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 NewGremlinResourceGremlinRoleAssignment(ctx *Context, name string, args GremlinResourceGremlinRoleAssignmentArgs, opts ...ResourceOption) (*GremlinResourceGremlinRoleAssignment, error)
    public GremlinResourceGremlinRoleAssignment(string name, GremlinResourceGremlinRoleAssignmentArgs args, CustomResourceOptions? opts = null)
    public GremlinResourceGremlinRoleAssignment(String name, GremlinResourceGremlinRoleAssignmentArgs args)
    public GremlinResourceGremlinRoleAssignment(String name, GremlinResourceGremlinRoleAssignmentArgs args, CustomResourceOptions options)
    
    type: azure-native:cosmosdb:GremlinResourceGremlinRoleAssignment
    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 GremlinResourceGremlinRoleAssignmentArgs
    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 GremlinResourceGremlinRoleAssignmentArgs
    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 GremlinResourceGremlinRoleAssignmentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GremlinResourceGremlinRoleAssignmentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GremlinResourceGremlinRoleAssignmentArgs
    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 gremlinResourceGremlinRoleAssignmentResource = new AzureNative.CosmosDB.GremlinResourceGremlinRoleAssignment("gremlinResourceGremlinRoleAssignmentResource", new()
    {
        AccountName = "string",
        ResourceGroupName = "string",
        PrincipalId = "string",
        RoleAssignmentId = "string",
        RoleDefinitionId = "string",
        Scope = "string",
    });
    
    example, err := cosmosdb.NewGremlinResourceGremlinRoleAssignment(ctx, "gremlinResourceGremlinRoleAssignmentResource", &cosmosdb.GremlinResourceGremlinRoleAssignmentArgs{
    	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 gremlinResourceGremlinRoleAssignmentResource = new GremlinResourceGremlinRoleAssignment("gremlinResourceGremlinRoleAssignmentResource", GremlinResourceGremlinRoleAssignmentArgs.builder()
        .accountName("string")
        .resourceGroupName("string")
        .principalId("string")
        .roleAssignmentId("string")
        .roleDefinitionId("string")
        .scope("string")
        .build());
    
    gremlin_resource_gremlin_role_assignment_resource = azure_native.cosmosdb.GremlinResourceGremlinRoleAssignment("gremlinResourceGremlinRoleAssignmentResource",
        account_name="string",
        resource_group_name="string",
        principal_id="string",
        role_assignment_id="string",
        role_definition_id="string",
        scope="string")
    
    const gremlinResourceGremlinRoleAssignmentResource = new azure_native.cosmosdb.GremlinResourceGremlinRoleAssignment("gremlinResourceGremlinRoleAssignmentResource", {
        accountName: "string",
        resourceGroupName: "string",
        principalId: "string",
        roleAssignmentId: "string",
        roleDefinitionId: "string",
        scope: "string",
    });
    
    type: azure-native:cosmosdb:GremlinResourceGremlinRoleAssignment
    properties:
        accountName: string
        principalId: string
        resourceGroupName: string
        roleAssignmentId: string
        roleDefinitionId: string
        scope: string
    

    GremlinResourceGremlinRoleAssignment 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 GremlinResourceGremlinRoleAssignment resource accepts the following input properties:

    AccountName string
    Cosmos DB database account name.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    PrincipalId string
    The unique identifier for the associated AAD principal in the AAD graph to which access is being granted through this Gremlin Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription.
    RoleAssignmentId string
    The GUID for the Role Assignment.
    RoleDefinitionId string
    The unique identifier for the associated Role Definition.
    Scope string
    The data plane resource path for which access is being granted through this Gremlin Role Assignment.
    AccountName string
    Cosmos DB database account name.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    PrincipalId string
    The unique identifier for the associated AAD principal in the AAD graph to which access is being granted through this Gremlin Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription.
    RoleAssignmentId string
    The GUID for the Role Assignment.
    RoleDefinitionId string
    The unique identifier for the associated Role Definition.
    Scope string
    The data plane resource path for which access is being granted through this Gremlin Role Assignment.
    accountName String
    Cosmos DB database account name.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    principalId String
    The unique identifier for the associated AAD principal in the AAD graph to which access is being granted through this Gremlin Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription.
    roleAssignmentId String
    The GUID for the Role Assignment.
    roleDefinitionId String
    The unique identifier for the associated Role Definition.
    scope String
    The data plane resource path for which access is being granted through this Gremlin Role Assignment.
    accountName string
    Cosmos DB database account name.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    principalId string
    The unique identifier for the associated AAD principal in the AAD graph to which access is being granted through this Gremlin Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription.
    roleAssignmentId string
    The GUID for the Role Assignment.
    roleDefinitionId string
    The unique identifier for the associated Role Definition.
    scope string
    The data plane resource path for which access is being granted through this Gremlin Role Assignment.
    account_name str
    Cosmos DB database account name.
    resource_group_name str
    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 Gremlin Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription.
    role_assignment_id str
    The GUID for the Role Assignment.
    role_definition_id str
    The unique identifier for the associated Role Definition.
    scope str
    The data plane resource path for which access is being granted through this Gremlin Role Assignment.
    accountName String
    Cosmos DB database account name.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    principalId String
    The unique identifier for the associated AAD principal in the AAD graph to which access is being granted through this Gremlin Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription.
    roleAssignmentId String
    The GUID for the Role Assignment.
    roleDefinitionId String
    The unique identifier for the associated Role Definition.
    scope String
    The data plane resource path for which access is being granted through this Gremlin Role Assignment.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the GremlinResourceGremlinRoleAssignment resource produces the following output properties:

    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    ProvisioningState string
    Provisioning state of the resource.
    SystemData Pulumi.AzureNative.CosmosDB.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    ProvisioningState string
    Provisioning state of the resource.
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    azureApiVersion String
    The Azure API version of the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    provisioningState String
    Provisioning state of the resource.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    azureApiVersion string
    The Azure API version of the resource.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The name of the resource
    provisioningState string
    Provisioning state of the resource.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    azure_api_version str
    The Azure API version of the resource.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The name of the resource
    provisioning_state str
    Provisioning state of the resource.
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    azureApiVersion String
    The Azure API version of the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    provisioningState String
    Provisioning state of the resource.
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    Supporting Types

    SystemDataResponse, SystemDataResponseArgs

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:cosmosdb:GremlinResourceGremlinRoleAssignment myRoleAssignmentId /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinRoleAssignments/{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
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
    Azure Native v3.4.0 published on Wednesday, May 7, 2025 by Pulumi