Azure Native

Pulumi Official
Package maintained by Pulumi
v1.64.1 published on Wednesday, May 18, 2022 by Pulumi

getGraphResourceGraph

An Azure Cosmos DB Graph resource. API Version: 2021-07-01-preview.

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>
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]
func LookupGraphResourceGraph(ctx *Context, args *LookupGraphResourceGraphArgs, opts ...InvokeOption) (*LookupGraphResourceGraphResult, error)
func LookupGraphResourceGraphOutput(ctx *Context, args *LookupGraphResourceGraphOutputArgs, opts ...InvokeOption) LookupGraphResourceGraphResultOutput

> 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)
}
public static CompletableFuture<GetGraphResourceGraphResult> getGraphResourceGraph(GetGraphResourceGraphArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: azure-native:documentdb:getGraphResourceGraph
  Arguments:
    # Arguments dictionary

The following arguments are supported:

AccountName string

Cosmos DB database account name.

GraphName string

Cosmos DB graph resource name.

ResourceGroupName string

The name of the resource group. The name is case insensitive.

AccountName string

Cosmos DB database account name.

GraphName string

Cosmos DB graph resource name.

ResourceGroupName string

The name of the resource group. The name is case insensitive.

accountName String

Cosmos DB database account name.

graphName String

Cosmos DB graph resource name.

resourceGroupName String

The name of the resource group. The name is case insensitive.

accountName string

Cosmos DB database account name.

graphName string

Cosmos DB graph resource name.

resourceGroupName string

The name of the resource group. The name is case insensitive.

account_name str

Cosmos DB database account name.

graph_name str

Cosmos DB graph resource name.

resource_group_name str

The name of the resource group. The name is case insensitive.

accountName String

Cosmos DB database account name.

graphName String

Cosmos DB graph resource name.

resourceGroupName String

The name of the resource group. The name is case insensitive.

getGraphResourceGraph Result

The following output properties are available:

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.DocumentDB.Outputs.ManagedServiceIdentityResponse

Identity for the resource.

Location string

The location of the resource group to which the resource belongs.

Options Pulumi.AzureNative.DocumentDB.Outputs.GraphResourceGetPropertiesResponseOptions
Resource Pulumi.AzureNative.DocumentDB.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".

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

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

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

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

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

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

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

ManagedServiceIdentityResponse

PrincipalId string

The principal id of the system assigned identity. This property will only be provided for a system assigned identity.

TenantId 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.DocumentDB.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 string

The principal id of the system assigned identity. This property will only be provided for a system assigned identity.

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

The principal id of the system assigned identity. This property will only be provided for a system assigned identity.

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

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 string

The principal id of the system assigned identity. This property will only be provided for a system assigned identity.

tenantId 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 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_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 String

The principal id of the system assigned identity. This property will only be provided for a system assigned identity.

tenantId 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

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 string

The client id of user assigned identity.

PrincipalId string

The principal id of user assigned identity.

ClientId string

The client id of user assigned identity.

PrincipalId string

The principal id of user assigned identity.

clientId String

The client id of user assigned identity.

principalId String

The principal id of user assigned identity.

clientId string

The client id of user assigned identity.

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

clientId String

The client id of user assigned identity.

principalId String

The principal id of user assigned identity.

Package Details

Repository
https://github.com/pulumi/pulumi-azure-native
License
Apache-2.0