Azure Native v1.102.0, May 2 23
Azure Native v1.102.0, May 2 23
azure-native.documentdb.GraphResourceGraph
Explore with Pulumi AI
An Azure Cosmos DB Graph resource. API Version: 2021-07-01-preview.
Example Usage
CosmosDBGraphCreateUpdate
using System.Collections.Generic;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var graphResourceGraph = new AzureNative.DocumentDB.GraphResourceGraph("graphResourceGraph", new()
{
AccountName = "ddb1",
GraphName = "graphName",
Location = "West US",
Options = null,
Resource = new AzureNative.DocumentDB.Inputs.GraphResourceArgs
{
Id = "graphName",
},
ResourceGroupName = "rg1",
Tags = null,
});
});
package main
import (
documentdb "github.com/pulumi/pulumi-azure-native/sdk/go/azure/documentdb"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := documentdb.NewGraphResourceGraph(ctx, "graphResourceGraph", &documentdb.GraphResourceGraphArgs{
AccountName: pulumi.String("ddb1"),
GraphName: pulumi.String("graphName"),
Location: pulumi.String("West US"),
Options: nil,
Resource: &documentdb.GraphResourceArgs{
Id: pulumi.String("graphName"),
},
ResourceGroupName: pulumi.String("rg1"),
Tags: nil,
})
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.GraphResourceGraph;
import com.pulumi.azurenative.documentdb.GraphResourceGraphArgs;
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 graphResourceGraph = new GraphResourceGraph("graphResourceGraph", GraphResourceGraphArgs.builder()
.accountName("ddb1")
.graphName("graphName")
.location("West US")
.options()
.resource(Map.of("id", "graphName"))
.resourceGroupName("rg1")
.tags()
.build());
}
}
import pulumi
import pulumi_azure_native as azure_native
graph_resource_graph = azure_native.documentdb.GraphResourceGraph("graphResourceGraph",
account_name="ddb1",
graph_name="graphName",
location="West US",
options=azure_native.documentdb.CreateUpdateOptionsArgs(),
resource=azure_native.documentdb.GraphResourceArgs(
id="graphName",
),
resource_group_name="rg1",
tags={})
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const graphResourceGraph = new azure_native.documentdb.GraphResourceGraph("graphResourceGraph", {
accountName: "ddb1",
graphName: "graphName",
location: "West US",
options: {},
resource: {
id: "graphName",
},
resourceGroupName: "rg1",
tags: {},
});
resources:
graphResourceGraph:
type: azure-native:documentdb:GraphResourceGraph
properties:
accountName: ddb1
graphName: graphName
location: West US
options: {}
resource:
id: graphName
resourceGroupName: rg1
tags: {}
Create GraphResourceGraph Resource
new GraphResourceGraph(name: string, args: GraphResourceGraphArgs, opts?: CustomResourceOptions);
@overload
def GraphResourceGraph(resource_name: str,
opts: Optional[ResourceOptions] = None,
account_name: Optional[str] = None,
graph_name: Optional[str] = None,
identity: Optional[ManagedServiceIdentityArgs] = None,
location: Optional[str] = None,
options: Optional[CreateUpdateOptionsArgs] = None,
resource: Optional[GraphResourceArgs] = None,
resource_group_name: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None)
@overload
def GraphResourceGraph(resource_name: str,
args: GraphResourceGraphArgs,
opts: Optional[ResourceOptions] = None)
func NewGraphResourceGraph(ctx *Context, name string, args GraphResourceGraphArgs, opts ...ResourceOption) (*GraphResourceGraph, error)
public GraphResourceGraph(string name, GraphResourceGraphArgs args, CustomResourceOptions? opts = null)
public GraphResourceGraph(String name, GraphResourceGraphArgs args)
public GraphResourceGraph(String name, GraphResourceGraphArgs args, CustomResourceOptions options)
type: azure-native:documentdb:GraphResourceGraph
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args GraphResourceGraphArgs
- 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 GraphResourceGraphArgs
- 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 GraphResourceGraphArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args GraphResourceGraphArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args GraphResourceGraphArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
GraphResourceGraph 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 GraphResourceGraph resource accepts the following input properties:
- Account
Name string Cosmos DB database account name.
- Resource
Pulumi.
Azure Native. Document DB. Inputs. Graph Resource Args The standard JSON format of a Graph resource
- Resource
Group stringName The name of the resource group. The name is case insensitive.
- Graph
Name string Cosmos DB graph resource name.
- Identity
Pulumi.
Azure Native. Document DB. Inputs. Managed Service Identity Args Identity for the resource.
- Location string
The location of the resource group to which the resource belongs.
- Options
Pulumi.
Azure Native. Document DB. Inputs. Create Update Options Args A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
- Dictionary<string, string>
Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".
- Account
Name string Cosmos DB database account name.
- Resource
Graph
Resource Args The standard JSON format of a Graph resource
- Resource
Group stringName The name of the resource group. The name is case insensitive.
- Graph
Name string Cosmos DB graph resource name.
- Identity
Managed
Service Identity Args Identity for the resource.
- Location string
The location of the resource group to which the resource belongs.
- Options
Create
Update Options Args A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
- map[string]string
Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".
- account
Name String Cosmos DB database account name.
- resource
Graph
Resource Args The standard JSON format of a Graph resource
- resource
Group StringName The name of the resource group. The name is case insensitive.
- graph
Name String Cosmos DB graph resource name.
- identity
Managed
Service Identity Args Identity for the resource.
- location String
The location of the resource group to which the resource belongs.
- options
Create
Update Options Args A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
- Map<String,String>
Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".
- account
Name string Cosmos DB database account name.
- resource
Graph
Resource Args The standard JSON format of a Graph resource
- resource
Group stringName The name of the resource group. The name is case insensitive.
- graph
Name string Cosmos DB graph resource name.
- identity
Managed
Service Identity Args Identity for the resource.
- location string
The location of the resource group to which the resource belongs.
- options
Create
Update Options Args A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
- {[key: string]: string}
Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".
- account_
name str Cosmos DB database account name.
- resource
Graph
Resource Args The standard JSON format of a Graph resource
- resource_
group_ strname The name of the resource group. The name is case insensitive.
- graph_
name str Cosmos DB graph resource name.
- identity
Managed
Service Identity Args Identity for the resource.
- location str
The location of the resource group to which the resource belongs.
- options
Create
Update Options Args A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
- Mapping[str, str]
Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".
- account
Name String Cosmos DB database account name.
- resource Property Map
The standard JSON format of a Graph resource
- resource
Group StringName The name of the resource group. The name is case insensitive.
- graph
Name String Cosmos DB graph resource name.
- identity Property Map
Identity for the resource.
- location String
The location of the resource group to which the resource belongs.
- options Property Map
A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
- Map<String>
Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".
Outputs
All input properties are implicitly available as output properties. Additionally, the GraphResourceGraph resource produces the following output properties:
Supporting Types
AutoscaleSettings
- Max
Throughput int Represents maximum throughput, the resource can scale up to.
- Max
Throughput int Represents maximum throughput, the resource can scale up to.
- max
Throughput Integer Represents maximum throughput, the resource can scale up to.
- max
Throughput number Represents maximum throughput, the resource can scale up to.
- max_
throughput int Represents maximum throughput, the resource can scale up to.
- max
Throughput Number Represents maximum throughput, the resource can scale up to.
AutoscaleSettingsResponse
- Max
Throughput int Represents maximum throughput, the resource can scale up to.
- Max
Throughput int Represents maximum throughput, the resource can scale up to.
- max
Throughput Integer Represents maximum throughput, the resource can scale up to.
- max
Throughput number Represents maximum throughput, the resource can scale up to.
- max_
throughput int Represents maximum throughput, the resource can scale up to.
- max
Throughput Number Represents maximum throughput, the resource can scale up to.
CreateUpdateOptions
- Autoscale
Settings Pulumi.Azure Native. Document DB. Inputs. Autoscale Settings Specifies the Autoscale settings.
- Throughput int
Request Units per second. For example, "throughput": 10000.
- Autoscale
Settings AutoscaleSettings Specifies the Autoscale settings.
- Throughput int
Request Units per second. For example, "throughput": 10000.
- autoscale
Settings AutoscaleSettings Specifies the Autoscale settings.
- throughput Integer
Request Units per second. For example, "throughput": 10000.
- autoscale
Settings AutoscaleSettings Specifies the Autoscale settings.
- throughput number
Request Units per second. For example, "throughput": 10000.
- autoscale_
settings AutoscaleSettings Specifies the Autoscale settings.
- throughput int
Request Units per second. For example, "throughput": 10000.
- autoscale
Settings Property Map Specifies the Autoscale settings.
- throughput Number
Request Units per second. For example, "throughput": 10000.
GraphResource
- Id string
Name of the Cosmos DB Graph
- Id string
Name of the Cosmos DB Graph
- id String
Name of the Cosmos DB Graph
- id string
Name of the Cosmos DB Graph
- id str
Name of the Cosmos DB Graph
- id String
Name of the Cosmos DB Graph
GraphResourceGetPropertiesResponseOptions
- Autoscale
Settings Pulumi.Azure Native. Document DB. Inputs. Autoscale Settings Response Specifies the Autoscale settings.
- Throughput int
Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
- Autoscale
Settings AutoscaleSettings Response Specifies the Autoscale settings.
- Throughput int
Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
- autoscale
Settings AutoscaleSettings Response Specifies the Autoscale settings.
- throughput Integer
Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
- autoscale
Settings AutoscaleSettings Response Specifies the Autoscale settings.
- throughput number
Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
- autoscale_
settings AutoscaleSettings Response Specifies the Autoscale settings.
- throughput int
Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
- autoscale
Settings Property Map Specifies the Autoscale settings.
- throughput Number
Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
GraphResourceGetPropertiesResponseResource
- Id string
Name of the Cosmos DB Graph
- Id string
Name of the Cosmos DB Graph
- id String
Name of the Cosmos DB Graph
- id string
Name of the Cosmos DB Graph
- id str
Name of the Cosmos DB Graph
- id String
Name of the Cosmos DB Graph
ManagedServiceIdentity
- Type
Pulumi.
Azure Native. Document DB. Resource Identity Type The type of identity used for the resource. The type 'SystemAssigned,UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.
- User
Assigned Dictionary<string, object>Identities The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
- Type
Resource
Identity Type The type of identity used for the resource. The type 'SystemAssigned,UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.
- User
Assigned map[string]interface{}Identities The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
- type
Resource
Identity Type The type of identity used for the resource. The type 'SystemAssigned,UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.
- user
Assigned Map<String,Object>Identities The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
- type
Resource
Identity Type The type of identity used for the resource. The type 'SystemAssigned,UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.
- user
Assigned {[key: string]: any}Identities The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
- type
Resource
Identity Type The type of identity used for the resource. The type 'SystemAssigned,UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.
- user_
assigned_ Mapping[str, Any]identities The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
- type
"System
Assigned" | "User Assigned" | "System Assigned,User Assigned" | "None" The type of identity used for the resource. The type 'SystemAssigned,UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.
- user
Assigned Map<Any>Identities The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
ManagedServiceIdentityResponse
- Principal
Id string The principal id of the system assigned identity. This property will only be provided for a system assigned identity.
- Tenant
Id string The tenant id of the system assigned identity. This property will only be provided for a system assigned identity.
- Type string
The type of identity used for the resource. The type 'SystemAssigned,UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.
- User
Assigned Dictionary<string, Pulumi.Identities Azure Native. Document DB. Inputs. Managed Service Identity Response User Assigned Identities> The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
- Principal
Id string The principal id of the system assigned identity. This property will only be provided for a system assigned identity.
- Tenant
Id string The tenant id of the system assigned identity. This property will only be provided for a system assigned identity.
- Type string
The type of identity used for the resource. The type 'SystemAssigned,UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.
- User
Assigned map[string]ManagedIdentities Service Identity Response User Assigned Identities The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
- principal
Id String The principal id of the system assigned identity. This property will only be provided for a system assigned identity.
- tenant
Id String The tenant id of the system assigned identity. This property will only be provided for a system assigned identity.
- type String
The type of identity used for the resource. The type 'SystemAssigned,UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.
- user
Assigned Map<String,ManagedIdentities Service Identity Response User Assigned Identities> The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
- principal
Id string The principal id of the system assigned identity. This property will only be provided for a system assigned identity.
- tenant
Id string The tenant id of the system assigned identity. This property will only be provided for a system assigned identity.
- type string
The type of identity used for the resource. The type 'SystemAssigned,UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.
- user
Assigned {[key: string]: ManagedIdentities Service Identity Response User Assigned Identities} The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
- principal_
id str The principal id of the system assigned identity. This property will only be provided for a system assigned identity.
- tenant_
id str The tenant id of the system assigned identity. This property will only be provided for a system assigned identity.
- type str
The type of identity used for the resource. The type 'SystemAssigned,UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.
- user_
assigned_ Mapping[str, Managedidentities Service Identity Response User Assigned Identities] The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
- principal
Id String The principal id of the system assigned identity. This property will only be provided for a system assigned identity.
- tenant
Id String The tenant id of the system assigned identity. This property will only be provided for a system assigned identity.
- type String
The type of identity used for the resource. The type 'SystemAssigned,UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.
- user
Assigned Map<Property Map>Identities The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
ManagedServiceIdentityResponseUserAssignedIdentities
- Client
Id string The client id of user assigned identity.
- Principal
Id string The principal id of user assigned identity.
- Client
Id string The client id of user assigned identity.
- Principal
Id string The principal id of user assigned identity.
- client
Id String The client id of user assigned identity.
- principal
Id String The principal id of user assigned identity.
- client
Id string The client id of user assigned identity.
- principal
Id string The principal id of user assigned identity.
- client_
id str The client id of user assigned identity.
- principal_
id str The principal id of user assigned identity.
- client
Id String The client id of user assigned identity.
- principal
Id String The principal id of user assigned identity.
ResourceIdentityType
- System
Assigned - SystemAssigned
- User
Assigned - UserAssigned
- System
Assigned_User Assigned - SystemAssigned,UserAssigned
- None
- None
- Resource
Identity Type System Assigned - SystemAssigned
- Resource
Identity Type User Assigned - UserAssigned
- Resource
Identity Type_System Assigned_User Assigned - SystemAssigned,UserAssigned
- Resource
Identity Type None - None
- System
Assigned - SystemAssigned
- User
Assigned - UserAssigned
- System
Assigned_User Assigned - SystemAssigned,UserAssigned
- None
- None
- System
Assigned - SystemAssigned
- User
Assigned - UserAssigned
- System
Assigned_User Assigned - SystemAssigned,UserAssigned
- None
- None
- SYSTEM_ASSIGNED
- SystemAssigned
- USER_ASSIGNED
- UserAssigned
- SYSTEM_ASSIGNED_USER_ASSIGNED
- SystemAssigned,UserAssigned
- NONE
- None
- "System
Assigned" - SystemAssigned
- "User
Assigned" - UserAssigned
- "System
Assigned,User Assigned" - SystemAssigned,UserAssigned
- "None"
- None
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:documentdb:GraphResourceGraph graphName /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/graphs/graphName
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0