Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. cosmosdb
  5. getGraphResourceGraph
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.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.cosmosdb.getGraphResourceGraph

Explore with Pulumi AI

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.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets the Graph resource under an existing Azure Cosmos DB database account with the provided name.

Uses Azure REST API version 2024-12-01-preview.

Other available API versions: 2021-07-01-preview, 2021-10-15-preview, 2021-11-15-preview, 2022-02-15-preview, 2022-05-15-preview, 2022-08-15-preview, 2022-11-15-preview, 2023-03-01-preview, 2023-03-15-preview, 2023-09-15-preview, 2023-11-15-preview, 2024-02-15-preview, 2024-05-15-preview, 2024-09-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native cosmosdb [ApiVersion]. See the version guide for details.

Using getGraphResourceGraph

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getGraphResourceGraph(args: GetGraphResourceGraphArgs, opts?: InvokeOptions): Promise<GetGraphResourceGraphResult>
function getGraphResourceGraphOutput(args: GetGraphResourceGraphOutputArgs, opts?: InvokeOptions): Output<GetGraphResourceGraphResult>
Copy
def get_graph_resource_graph(account_name: Optional[str] = None,
                             graph_name: Optional[str] = None,
                             resource_group_name: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetGraphResourceGraphResult
def get_graph_resource_graph_output(account_name: Optional[pulumi.Input[str]] = None,
                             graph_name: Optional[pulumi.Input[str]] = None,
                             resource_group_name: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetGraphResourceGraphResult]
Copy
func LookupGraphResourceGraph(ctx *Context, args *LookupGraphResourceGraphArgs, opts ...InvokeOption) (*LookupGraphResourceGraphResult, error)
func LookupGraphResourceGraphOutput(ctx *Context, args *LookupGraphResourceGraphOutputArgs, opts ...InvokeOption) LookupGraphResourceGraphResultOutput
Copy

> Note: This function is named LookupGraphResourceGraph in the Go SDK.

public static class GetGraphResourceGraph 
{
    public static Task<GetGraphResourceGraphResult> InvokeAsync(GetGraphResourceGraphArgs args, InvokeOptions? opts = null)
    public static Output<GetGraphResourceGraphResult> Invoke(GetGraphResourceGraphInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetGraphResourceGraphResult> getGraphResourceGraph(GetGraphResourceGraphArgs args, InvokeOptions options)
public static Output<GetGraphResourceGraphResult> getGraphResourceGraph(GetGraphResourceGraphArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:cosmosdb:getGraphResourceGraph
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

AccountName
This property is required.
Changes to this property will trigger replacement.
string
Cosmos DB database account name.
GraphName
This property is required.
Changes to this property will trigger replacement.
string
Cosmos DB graph resource 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.
AccountName
This property is required.
Changes to this property will trigger replacement.
string
Cosmos DB database account name.
GraphName
This property is required.
Changes to this property will trigger replacement.
string
Cosmos DB graph resource 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.
accountName
This property is required.
Changes to this property will trigger replacement.
String
Cosmos DB database account name.
graphName
This property is required.
Changes to this property will trigger replacement.
String
Cosmos DB graph resource 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.
accountName
This property is required.
Changes to this property will trigger replacement.
string
Cosmos DB database account name.
graphName
This property is required.
Changes to this property will trigger replacement.
string
Cosmos DB graph resource 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.
account_name
This property is required.
Changes to this property will trigger replacement.
str
Cosmos DB database account name.
graph_name
This property is required.
Changes to this property will trigger replacement.
str
Cosmos DB graph resource 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.
accountName
This property is required.
Changes to this property will trigger replacement.
String
Cosmos DB database account name.
graphName
This property is required.
Changes to this property will trigger replacement.
String
Cosmos DB graph resource 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.

getGraphResourceGraph Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Id string
The unique resource identifier of the ARM resource.
Name string
The name of the ARM resource.
Type string
The type of Azure resource.
Identity Pulumi.AzureNative.CosmosDB.Outputs.ManagedServiceIdentityResponse
Identity for the resource.
Location string
The location of the resource group to which the resource belongs.
Options Pulumi.AzureNative.CosmosDB.Outputs.GraphResourceGetPropertiesResponseOptions
Resource Pulumi.AzureNative.CosmosDB.Outputs.GraphResourceGetPropertiesResponseResource
Tags 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".
AzureApiVersion string
The Azure API version of the resource.
Id string
The unique resource identifier of the ARM resource.
Name string
The name of the ARM resource.
Type string
The type of Azure resource.
Identity ManagedServiceIdentityResponse
Identity for the resource.
Location string
The location of the resource group to which the resource belongs.
Options GraphResourceGetPropertiesResponseOptions
Resource GraphResourceGetPropertiesResponseResource
Tags 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".
azureApiVersion String
The Azure API version of the resource.
id String
The unique resource identifier of the ARM resource.
name String
The name of the ARM resource.
type String
The type of Azure resource.
identity ManagedServiceIdentityResponse
Identity for the resource.
location String
The location of the resource group to which the resource belongs.
options GraphResourceGetPropertiesResponseOptions
resource GraphResourceGetPropertiesResponseResource
tags 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".
azureApiVersion string
The Azure API version of the resource.
id string
The unique resource identifier of the ARM resource.
name string
The name of the ARM resource.
type string
The type of Azure resource.
identity ManagedServiceIdentityResponse
Identity for the resource.
location string
The location of the resource group to which the resource belongs.
options GraphResourceGetPropertiesResponseOptions
resource GraphResourceGetPropertiesResponseResource
tags {[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".
azure_api_version str
The Azure API version of the resource.
id str
The unique resource identifier of the ARM resource.
name str
The name of the ARM resource.
type str
The type of Azure resource.
identity ManagedServiceIdentityResponse
Identity for the resource.
location str
The location of the resource group to which the resource belongs.
options GraphResourceGetPropertiesResponseOptions
resource GraphResourceGetPropertiesResponseResource
tags 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".
azureApiVersion String
The Azure API version of the resource.
id String
The unique resource identifier of the ARM resource.
name String
The name of the ARM resource.
type String
The type of Azure resource.
identity Property Map
Identity for the resource.
location String
The location of the resource group to which the resource belongs.
options Property Map
resource Property Map
tags 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".

Supporting Types

AutoscaleSettingsResponse

MaxThroughput int
Represents maximum throughput, the resource can scale up to.
MaxThroughput int
Represents maximum throughput, the resource can scale up to.
maxThroughput Integer
Represents maximum throughput, the resource can scale up to.
maxThroughput number
Represents maximum throughput, the resource can scale up to.
max_throughput int
Represents maximum throughput, the resource can scale up to.
maxThroughput Number
Represents maximum throughput, the resource can scale up to.

GraphResourceGetPropertiesResponseOptions

AutoscaleSettings Pulumi.AzureNative.CosmosDB.Inputs.AutoscaleSettingsResponse
Specifies the Autoscale settings.
Throughput int
Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
AutoscaleSettings AutoscaleSettingsResponse
Specifies the Autoscale settings.
Throughput int
Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
autoscaleSettings AutoscaleSettingsResponse
Specifies the Autoscale settings.
throughput Integer
Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
autoscaleSettings AutoscaleSettingsResponse
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 AutoscaleSettingsResponse
Specifies the Autoscale settings.
throughput int
Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
autoscaleSettings 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 This property is required. string
Name of the Cosmos DB Graph
Id This property is required. string
Name of the Cosmos DB Graph
id This property is required. String
Name of the Cosmos DB Graph
id This property is required. string
Name of the Cosmos DB Graph
id This property is required. str
Name of the Cosmos DB Graph
id This property is required. String
Name of the Cosmos DB Graph

ManagedServiceIdentityResponse

PrincipalId This property is required. string
The principal id of the system assigned identity. This property will only be provided for a system assigned identity.
TenantId This property is required. 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.
UserAssignedIdentities Dictionary<string, Pulumi.AzureNative.CosmosDB.Inputs.ManagedServiceIdentityResponseUserAssignedIdentities>
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}'.
PrincipalId This property is required. string
The principal id of the system assigned identity. This property will only be provided for a system assigned identity.
TenantId This property is required. 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.
UserAssignedIdentities map[string]ManagedServiceIdentityResponseUserAssignedIdentities
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}'.
principalId This property is required. String
The principal id of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId This property is required. 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.
userAssignedIdentities Map<String,ManagedServiceIdentityResponseUserAssignedIdentities>
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}'.
principalId This property is required. string
The principal id of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId This property is required. 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.
userAssignedIdentities {[key: string]: ManagedServiceIdentityResponseUserAssignedIdentities}
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 This property is required. str
The principal id of the system assigned identity. This property will only be provided for a system assigned identity.
tenant_id This property is required. 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_identities Mapping[str, ManagedServiceIdentityResponseUserAssignedIdentities]
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}'.
principalId This property is required. String
The principal id of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId This property is required. 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.
userAssignedIdentities Map<Property Map>
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

ClientId This property is required. string
The client id of user assigned identity.
PrincipalId This property is required. string
The principal id of user assigned identity.
ClientId This property is required. string
The client id of user assigned identity.
PrincipalId This property is required. string
The principal id of user assigned identity.
clientId This property is required. String
The client id of user assigned identity.
principalId This property is required. String
The principal id of user assigned identity.
clientId This property is required. string
The client id of user assigned identity.
principalId This property is required. string
The principal id of user assigned identity.
client_id This property is required. str
The client id of user assigned identity.
principal_id This property is required. str
The principal id of user assigned identity.
clientId This property is required. String
The client id of user assigned identity.
principalId This property is required. String
The principal id of user assigned identity.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
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.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native