@kengachu-pulumi/azure-native-documentdb
Version:
Pulumi Azure Native package for documentdb
99 lines (98 loc) • 4.71 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as types from "./types";
/**
* An Azure Cosmos DB Graph resource.
*
* Uses Azure REST API version 2023-03-15-preview. In version 1.x of the Azure Native provider, it used API version 2021-07-01-preview.
*
* Other available API versions: 2023-09-15-preview, 2023-11-15-preview, 2024-02-15-preview, 2024-05-15-preview, 2024-09-01-preview, 2024-12-01-preview.
*/
export declare class GraphResourceGraph extends pulumi.CustomResource {
/**
* Get an existing GraphResourceGraph resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): GraphResourceGraph;
/** @internal */
static readonly __pulumiType = "azure-native:documentdb:GraphResourceGraph";
/**
* Returns true if the given object is an instance of GraphResourceGraph. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is GraphResourceGraph;
/**
* Identity for the resource.
*/
readonly identity: pulumi.Output<types.outputs.ManagedServiceIdentityResponse | undefined>;
/**
* The location of the resource group to which the resource belongs.
*/
readonly location: pulumi.Output<string | undefined>;
/**
* The name of the ARM resource.
*/
readonly name: pulumi.Output<string>;
readonly options: pulumi.Output<types.outputs.GraphResourceGetPropertiesResponseOptions | undefined>;
readonly resource: pulumi.Output<types.outputs.GraphResourceGetPropertiesResponseResource | undefined>;
/**
* 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".
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* The type of Azure resource.
*/
readonly type: pulumi.Output<string>;
/**
* Create a GraphResourceGraph resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: GraphResourceGraphArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a GraphResourceGraph resource.
*/
export interface GraphResourceGraphArgs {
/**
* Cosmos DB database account name.
*/
accountName: pulumi.Input<string>;
/**
* Cosmos DB graph resource name.
*/
graphName?: pulumi.Input<string>;
/**
* Identity for the resource.
*/
identity?: pulumi.Input<types.inputs.ManagedServiceIdentityArgs>;
/**
* The location of the resource group to which the resource belongs.
*/
location?: pulumi.Input<string>;
/**
* A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
*/
options?: pulumi.Input<types.inputs.CreateUpdateOptionsArgs>;
/**
* The standard JSON format of a Graph resource
*/
resource: pulumi.Input<types.inputs.GraphResourceArgs>;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<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".
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}