{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/azure-cosmos-db/json-schema/azure-cosmos-db-mongo-dbcollection-get-results-schema.json",
  "title": "MongoDBCollectionGetResults",
  "description": "An Azure Cosmos DB MongoDB collection.",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/azure-cosmos-db-resource-provider-openapi.yml#/components/schemas/MongoDBCollectionGetResults",
  "type": "object",
  "properties": {
    "properties": {
      "$ref": "#/$defs/MongoDBCollectionGetProperties"
    },
    "location": {
      "type": "string",
      "description": "The location of the resource group to which the resource belongs.",
      "x-ms-mutability": [
        "read",
        "update",
        "create"
      ]
    },
    "tags": {
      "type": "object",
      "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\\\".",
      "additionalProperties": {
        "type": "string"
      }
    },
    "identity": {
      "$ref": "#/$defs/ManagedServiceIdentity"
    }
  },
  "allOf": [
    {
      "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource"
    }
  ],
  "$defs": {
    "AutoscaleSettings": {
      "type": "object",
      "properties": {
        "maxThroughput": {
          "type": "integer",
          "format": "int32",
          "description": "Represents maximum throughput, the resource can scale up to."
        }
      }
    },
    "ManagedServiceIdentity": {
      "type": "object",
      "description": "Identity for the resource.",
      "properties": {
        "principalId": {
          "type": "string",
          "description": "The principal id of the system assigned identity. This property will only be provided for a system assigned identity.",
          "readOnly": true
        },
        "tenantId": {
          "type": "string",
          "description": "The tenant id of the system assigned identity. This property will only be provided for a system assigned identity.",
          "readOnly": true
        },
        "type": {
          "$ref": "#/$defs/ResourceIdentityType"
        },
        "userAssignedIdentities": {
          "type": "object",
          "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}'.",
          "additionalProperties": {
            "$ref": "#/$defs/ManagedServiceIdentityUserAssignedIdentities"
          }
        }
      }
    },
    "ManagedServiceIdentityUserAssignedIdentities": {
      "type": "object",
      "properties": {
        "principalId": {
          "type": "string",
          "description": "The principal id of user assigned identity.",
          "readOnly": true
        },
        "clientId": {
          "type": "string",
          "description": "The client id of user assigned identity.",
          "readOnly": true
        }
      }
    },
    "MongoDBCollectionGetProperties": {
      "type": "object",
      "description": "The properties of an Azure Cosmos DB MongoDB collection",
      "properties": {
        "resource": {
          "$ref": "#/$defs/MongoDBCollectionGetPropertiesResource"
        },
        "options": {
          "$ref": "#/$defs/MongoDBCollectionGetPropertiesOptions"
        }
      }
    },
    "MongoDBCollectionGetPropertiesOptions": {
      "type": "object",
      "allOf": [
        {
          "$ref": "#/$defs/OptionsResource"
        }
      ]
    },
    "MongoDBCollectionGetPropertiesResource": {
      "type": "object",
      "properties": {
        "_rid": {
          "type": "string",
          "description": "A system generated property. A unique identifier.",
          "readOnly": true
        },
        "_ts": {
          "type": "number",
          "format": "float",
          "description": "A system generated property that denotes the last updated timestamp of the resource.",
          "readOnly": true
        },
        "_etag": {
          "type": "string",
          "description": "A system generated property representing the resource etag required for optimistic concurrency control.",
          "readOnly": true
        }
      },
      "allOf": [
        {
          "$ref": "#/$defs/MongoDBCollectionResource"
        }
      ]
    },
    "MongoDBCollectionResource": {
      "type": "object",
      "description": "Cosmos DB MongoDB collection resource object",
      "properties": {
        "id": {
          "type": "string",
          "description": "Name of the Cosmos DB MongoDB collection"
        },
        "shardKey": {
          "type": "object",
          "description": "A key-value pair of shard keys to be applied for the request.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "indexes": {
          "type": "array",
          "description": "List of index keys",
          "items": {
            "$ref": "#/$defs/MongoIndex"
          },
          "x-ms-identifiers": []
        },
        "analyticalStorageTtl": {
          "type": "integer",
          "format": "int32",
          "description": "Analytical TTL."
        },
        "restoreParameters": {
          "$ref": "#/$defs/ResourceRestoreParameters"
        },
        "createMode": {
          "type": "string",
          "description": "Enum to indicate the mode of resource creation.",
          "default": "Default",
          "enum": [
            "Default",
            "Restore"
          ],
          "x-ms-enum": {
            "name": "CreateMode",
            "modelAsString": true,
            "values": [
              {
                "name": "Default",
                "value": "Default"
              },
              {
                "name": "Restore",
                "value": "Restore"
              }
            ]
          }
        }
      },
      "required": [
        "id"
      ]
    },
    "MongoIndex": {
      "type": "object",
      "description": "Cosmos DB MongoDB collection index key",
      "properties": {
        "key": {
          "$ref": "#/$defs/MongoIndexKeys"
        },
        "options": {
          "$ref": "#/$defs/MongoIndexOptions"
        }
      }
    },
    "MongoIndexKeys": {
      "type": "object",
      "description": "Cosmos DB MongoDB collection resource object",
      "properties": {
        "keys": {
          "type": "array",
          "description": "List of keys for each MongoDB collection in the Azure Cosmos DB service",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "MongoIndexOptions": {
      "type": "object",
      "description": "Cosmos DB MongoDB collection index options",
      "properties": {
        "expireAfterSeconds": {
          "type": "integer",
          "format": "int32",
          "description": "Expire after seconds"
        },
        "unique": {
          "type": "boolean",
          "description": "Is unique or not"
        }
      }
    },
    "OptionsResource": {
      "type": "object",
      "description": "Cosmos DB options resource object",
      "properties": {
        "throughput": {
          "type": "integer",
          "format": "int32",
          "description": "Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details."
        },
        "autoscaleSettings": {
          "$ref": "#/$defs/AutoscaleSettings"
        }
      }
    },
    "ResourceIdentityType": {
      "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,
        "values": [
          {
            "name": "SystemAssigned",
            "value": "SystemAssigned"
          },
          {
            "name": "UserAssigned",
            "value": "UserAssigned"
          },
          {
            "name": "SystemAssignedUserAssigned",
            "value": "SystemAssigned,UserAssigned"
          },
          {
            "name": "None",
            "value": "None"
          }
        ]
      }
    },
    "ResourceRestoreParameters": {
      "type": "object",
      "description": "Parameters to indicate the information about the restore.",
      "allOf": [
        {
          "$ref": "#/$defs/RestoreParametersBase"
        }
      ]
    },
    "RestoreParametersBase": {
      "type": "object",
      "description": "Parameters to indicate the information about the restore.",
      "properties": {
        "restoreSource": {
          "type": "string",
          "description": "The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}"
        },
        "restoreTimestampInUtc": {
          "type": "string",
          "format": "date-time",
          "description": "Time to which the account has to be restored (ISO-8601 format)."
        },
        "restoreWithTtlDisabled": {
          "type": "boolean",
          "description": "Specifies whether the restored account will have Time-To-Live disabled upon the successful restore."
        }
      }
    }
  }
}