GraphResourceGraph

Provides a GraphResourceGraph from the DocumentDB group

Examples

CosmosDBGraphCreateUpdate

exports.createResources = () => [
  {
    type: "GraphResourceGraph",
    group: "DocumentDB",
    name: "myGraphResourceGraph",
    properties: () => ({
      location: "West US",
      tags: {},
      properties: { resource: { id: "graphName" }, options: {} },
    }),
    dependencies: ({}) => ({
      resourceGroup: "myResourceGroup",
      account: "myDatabaseAccount",
    }),
  },
];

Dependencies

• ResourceGroup
• DatabaseAccount

Swagger Schema

{
  description: 'Parameters to create and update Cosmos DB Graph resource.',
  type: 'object',
  properties: {
    properties: {
      'x-ms-client-flatten': true,
      description: 'Properties to create and update Azure Cosmos DB Graph resource.',
      type: 'object',
      properties: {
        resource: {
          description: 'The standard JSON format of a Graph resource',
          type: 'object',
          properties: {
            id: {
              type: 'string',
              description: 'Name of the Cosmos DB Graph'
            }
          },
          required: [ 'id' ]
        },
        options: {
          description: 'A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.',
          type: 'object',
          properties: {
            throughput: {
              type: 'integer',
              description: 'Request Units per second. For example, "throughput": 10000.'
            },
            autoscaleSettings: {
              description: 'Specifies the Autoscale settings.',
              type: 'object',
              properties: {
                maxThroughput: {
                  type: 'integer',
                  description: 'Represents maximum throughput, the resource can scale up to.'
                }
              }
            }
          }
        }
      },
      required: [ 'resource' ]
    }
  },
  allOf: [
    {
      type: 'object',
      description: 'The core properties of ARM resources.',
      properties: {
        id: {
          readOnly: true,
          type: 'string',
          description: 'The unique resource identifier of the ARM resource.'
        },
        name: {
          readOnly: true,
          type: 'string',
          description: 'The name of the ARM resource.'
        },
        type: {
          readOnly: true,
          type: 'string',
          description: 'The type of Azure resource.'
        },
        location: {
          type: 'string',
          description: 'The location of the resource group to which the resource belongs.'
        },
        tags: {
          type: 'object',
          additionalProperties: { type: 'string' },
          description: '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".'
        },
        identity: {
          properties: {
            principalId: {
              readOnly: true,
              type: 'string',
              description: 'The principal id of the system assigned identity. This property will only be provided for a system assigned identity.'
            },
            tenantId: {
              readOnly: true,
              type: 'string',
              description: 'The tenant id of the system assigned identity. This property will only be provided for a system assigned identity.'
            },
            type: {
              type: 'string',
              description: "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.",
              enum: [
                'SystemAssigned',
                'UserAssigned',
                'SystemAssigned,UserAssigned',
                'None'
              ],
              'x-ms-enum': { name: 'ResourceIdentityType', modelAsString: false }
            },
            userAssignedIdentities: {
              type: 'object',
              additionalProperties: {
                type: 'object',
                properties: {
                  principalId: {
                    readOnly: true,
                    type: 'string',
                    description: 'The principal id of user assigned identity.'
                  },
                  clientId: {
                    readOnly: true,
                    type: 'string',
                    description: 'The client id of user assigned identity.'
                  }
                }
              },
              description: "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}'."
            }
          },
          description: 'Identity for the resource.'
        }
      },
      'x-ms-azure-resource': true
    }
  ],
  required: [ 'properties' ]
}

Misc

The resource version is 2022-05-15-preview.

The Swagger schema used to generate this documentation can be found here.