Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Databases APIs to a new PostgreSQL version 2020-11-05-preview #11432

Merged
merged 7 commits into from
Nov 10, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,311 @@
{
"swagger": "2.0",
"info": {
"title": "PostgreSQLServerManagementClient",
"description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model.",
"version": "2020-11-05-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.DBForPostgreSql/flexibleServers/{serverName}/databases/{databaseName}": {
"put": {
"tags": [
"Databases"
],
"operationId": "Databases_Create",
"x-ms-examples": {
"Create a database": {
"$ref": "./examples/DatabaseCreate.json"
}
},
"description": "Creates a new database or updates an existing database.",
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/ServerNameParameter"
},
{
"$ref": "#/parameters/DatabaseNameParameter"
},
{
"name": "parameters",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/Database"
},
"description": "The required parameters for creating or updating a database."
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Database"
}
},
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/Database"
}
},
"202": {
"description": "Accepted"
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
},
"x-ms-long-running-operation": true
},
"delete": {
"tags": [
"Databases"
],
"operationId": "Databases_Delete",
"x-ms-examples": {
"Delete a database": {
"$ref": "./examples/DatabaseDelete.json"
}
},
"description": "Deletes a database.",
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/ServerNameParameter"
},
{
"$ref": "#/parameters/DatabaseNameParameter"
}
],
"responses": {
"200": {
"description": "OK"
},
"202": {
"description": "Accepted"
},
"204": {
"description": "NoContent"
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
},
"x-ms-long-running-operation": true
},
"get": {
"tags": [
"Databases"
],
"operationId": "Databases_Get",
"x-ms-examples": {
"Get a database": {
"$ref": "./examples/DatabaseGet.json"
}
},
"description": "Gets information about a database.",
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/ServerNameParameter"
},
{
"$ref": "#/parameters/DatabaseNameParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Database"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSql/flexibleServers/{serverName}/databases": {
"get": {
"tags": [
"Databases"
],
"operationId": "Databases_ListByServer",
"x-ms-examples": {
"List databases in a server": {
"$ref": "./examples/DatabasesListByServer.json"
}
},
"description": "List all the databases in a given server.",
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/ServerNameParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/DatabaseListResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
}
},
"definitions": {
"DatabaseProperties": {
"properties": {
"charset": {
"type": "string",
"description": "The charset of the database."
},
"collation": {
"type": "string",
"description": "The collation of the database."
}
},
"description": "The properties of a database."
},
"Database": {
"properties": {
"properties": {
"$ref": "#/definitions/DatabaseProperties",
"x-ms-client-flatten": true,
"description": "The properties of a database."
}
},
"allOf": [
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource"
}
],
"description": "Represents a Database."
},
"DatabaseListResult": {
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/definitions/Database"
},
"description": "The list of databases housed in a server"
},
"nextLink": {
"description": "The link used to get the next page of databases.",
"type": "string"
}
},
"description": "A List of databases."
},
"CloudError": {
"x-ms-external": true,
"properties": {
"error": {
"$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse"
}
},
"description": "An error response from the Batch service."
}
},
"parameters": {
"ServerNameParameter": {
"name": "serverName",
"in": "path",
"description": "The name of the server.",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
"DatabaseNameParameter": {
"name": "databaseName",
"in": "path",
"required": true,
"type": "string",
"description": "The name of the database.",
"x-ms-parameter-location": "method"
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
{
"parameters": {
"databaseName": "db1",
"serverName": "testserver",
"resourceGroupName": "TestGroup",
"api-version": "2020-11-05-preview",
"subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff",
"parameters": {
"properties": {
"charset": "utf8",
"collation": "en_US.utf8"
}
}
},
"responses": {
"201": {
"body": {
"id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/databases/db1",
"name": "db1",
"type": "Microsoft.DBforPostgreSQL/flexibleServers/databases",
"properties": {
"charset": "utf8",
"collation": "en_US.utf8"
}
}
},
"200": {
"body": {
"id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/databases/db1",
"name": "db1",
"type": "Microsoft.DBforPostgreSQL/flexibleServers/databases",
"properties": {
"charset": "utf8",
"collation": "en_US.utf8"
}
}
},
"202": {}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"parameters": {
"databaseName": "db1",
"serverName": "testserver",
"resourceGroupName": "TestGroup",
"api-version": "2020-11-05-preview",
"subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff"
},
"responses": {
"200": {},
"202": {},
"204": {}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
{
"parameters": {
"databaseName": "db1",
"serverName": "testserver",
"resourceGroupName": "TestGroup",
"api-version": "2020-11-05-preview",
"subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff"
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/databases/db1",
"name": "db1",
"type": "Microsoft.DBforPostgreSQL/flexibleServers/databases",
"properties": {
"charset": "utf8",
"collation": "en_US.utf8"
}
}
}
}
}
Loading