forked from Azure/azure-rest-api-specs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Cosmos DB Private Link Resources Swagger (Azure#7249)
* PrivateLinkResources swagger spec * Added missing files * Moved PrivateLinkResources to preview * Removed generated
- Loading branch information
Showing
5 changed files
with
261 additions
and
0 deletions.
There are no files selected for viewing
25 changes: 25 additions & 0 deletions
25
...rosoft.DocumentDB/preview/2019-08-01-preview/examples/CosmosDBPrivateLinkResourceGet.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
{ | ||
"parameters": { | ||
"subscriptionId": "00000000-1111-2222-3333-444444444444", | ||
"resourceGroupName": "rg1", | ||
"accountName": "ddb1", | ||
"api-version": "2015-04-08", | ||
"groupName": "sql" | ||
}, | ||
"responses": { | ||
"200": { | ||
"body": { | ||
"id": "subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.DocumentDb/databaseAccounts/ddb1/privateLinkResources/sql", | ||
"name": "sql", | ||
"type": "Microsoft.DocumentDB/databaseAccounts/privateLinkResources", | ||
"properties": { | ||
"groupId": "sql", | ||
"requiredMembers": [ | ||
"ddb1", | ||
"ddb1-westus" | ||
] | ||
} | ||
} | ||
} | ||
} | ||
} |
28 changes: 28 additions & 0 deletions
28
...ft.DocumentDB/preview/2019-08-01-preview/examples/CosmosDBPrivateLinkResourceListGet.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
{ | ||
"parameters": { | ||
"subscriptionId": "00000000-1111-2222-3333-444444444444", | ||
"resourceGroupName": "rg1", | ||
"accountName": "ddb1", | ||
"api-version": "2015-04-08" | ||
}, | ||
"responses": { | ||
"200": { | ||
"body": { | ||
"value": [ | ||
{ | ||
"id": "subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.DocumentDb/databaseAccounts/ddb1/privateLinkResources/sql", | ||
"name": "sql", | ||
"type": "Microsoft.DocumentDB/databaseAccounts/privateLinkResources", | ||
"properties": { | ||
"groupId": "sql", | ||
"requiredMembers": [ | ||
"ddb1", | ||
"ddb1-westus" | ||
] | ||
} | ||
} | ||
] | ||
} | ||
} | ||
} | ||
} |
176 changes: 176 additions & 0 deletions
176
...esource-manager/Microsoft.DocumentDB/preview/2019-08-01-preview/privateLinkResources.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,176 @@ | ||
{ | ||
"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": "../../stable/2019-08-01/cosmos-db.json#/parameters/subscriptionIdParameter" | ||
}, | ||
{ | ||
"$ref": "../../stable/2019-08-01/cosmos-db.json#/parameters/resourceGroupNameParameter" | ||
}, | ||
{ | ||
"$ref": "../../stable/2019-08-01/cosmos-db.json#/parameters/apiVersionParameter" | ||
}, | ||
{ | ||
"$ref": "../../stable/2019-08-01/cosmos-db.json#/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": "../../stable/2019-08-01/cosmos-db.json#/parameters/subscriptionIdParameter" | ||
}, | ||
{ | ||
"$ref": "../../stable/2019-08-01/cosmos-db.json#/parameters/resourceGroupNameParameter" | ||
}, | ||
{ | ||
"$ref": "../../stable/2019-08-01/cosmos-db.json#/parameters/apiVersionParameter" | ||
}, | ||
{ | ||
"$ref": "../../stable/2019-08-01/cosmos-db.json#/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 | ||
} | ||
} | ||
} | ||
}, | ||
"parameters": { | ||
"GroupNameParameter": { | ||
"name": "groupName", | ||
"in": "path", | ||
"description": "The name of the private link resource.", | ||
"required": true, | ||
"x-ms-parameter-location": "method", | ||
"type": "string" | ||
} | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters