{ "swagger": "2.0", "info": { "title": "Cosmos DB", "description": "Azure Cosmos DB Database Service Resource Provider REST API", "version": "2019-08-01-preview" }, "host": "management.azure.com", "schemes": [ "https" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "security": [ { "azure_auth": [ "user_impersonation" ] } ], "securityDefinitions": { "azure_auth": { "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", "description": "Azure Active Directory OAuth2 Flow", "scopes": { "user_impersonation": "Impersonate your user account" } } }, "paths": { "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/privateLinkResources": { "get": { "tags": [ "PrivateLinkResources" ], "description": "Gets the private link resources that need to be created for a Cosmos DB account.", "operationId": "PrivateLinkResources_ListByDatabaseAccount", "x-ms-pageable": { "nextLinkName": null }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/accountNameParameter" } ], "responses": { "200": { "description": "Successfully retrieved private link resources.", "schema": { "$ref": "#/definitions/PrivateLinkResourceListResult" } } }, "x-ms-examples": { "Gets private endpoint connection.": { "$ref": "./examples/CosmosDBPrivateLinkResourceListGet.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/privateLinkResources/{groupName}": { "get": { "tags": [ "PrivateLinkResources" ], "description": "Gets the private link resources that need to be created for a Cosmos DB account.", "operationId": "PrivateLinkResources_Get", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/accountNameParameter" }, { "$ref": "#/parameters/GroupNameParameter" } ], "responses": { "200": { "description": "Successfully retrieved a specified private link resource.", "schema": { "$ref": "#/definitions/PrivateLinkResource" } } }, "x-ms-examples": { "Gets private endpoint connection.": { "$ref": "./examples/CosmosDBPrivateLinkResourceGet.json" } } } } }, "definitions": { "PrivateLinkResourceListResult": { "description": "A list of private link resources", "type": "object", "properties": { "value": { "type": "array", "description": "Array of private link resources", "items": { "$ref": "#/definitions/PrivateLinkResource" } } } }, "PrivateLinkResource": { "description": "A private link resource", "type": "object", "properties": { "properties": { "$ref": "#/definitions/PrivateLinkResourceProperties", "description": "Resource properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../stable/2019-08-01/cosmos-db.json#/definitions/ARMProxyResource" } ] }, "PrivateLinkResourceProperties": { "description": "Properties of a private link resource.", "type": "object", "properties": { "groupId": { "description": "The private link resource group id.", "type": "string", "readOnly": true }, "requiredMembers": { "description": "The private link resource required member names.", "type": "array", "items": { "type": "string" }, "readOnly": true }, "requiredZoneNames": { "description": "The private link resource required zone names.", "type": "array", "items": { "type": "string" }, "readOnly": true } } } }, "parameters": { "accountNameParameter": { "name": "accountName", "in": "path", "required": true, "type": "string", "x-ms-parameter-location": "method", "description": "Cosmos DB database account name.", "minLength": 3, "maxLength": 50, "pattern": "^[a-z0-9]+(-[a-z0-9]+)*" }, "GroupNameParameter": { "name": "groupName", "in": "path", "description": "The name of the private link resource.", "required": true, "x-ms-parameter-location": "method", "type": "string" } } }