{ "swagger": "2.0", "info": { "version": "2020-01-01-privatepreview", "title": "MariaDBManagementClient", "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure MariaDB resources including servers, databases, firewall rules, VNET rules, security alert policies, log files, encryption keys, active directory administrator and configurations." }, "host": "management.azure.com", "schemes": [ "https" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "paths": { "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/keys": { "get": { "tags": [ "ServerKeys" ], "description": "Gets a list of Server keys.", "operationId": "ServerKeys_ListByInstance", "parameters": [ { "$ref": "#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Successfully retrieved the list of MariaDB Server keys.", "schema": { "$ref": "#/definitions/ServerKeyListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, "x-ms-examples": { "List the keys for a MariaDB Server.": { "$ref": "./examples/ServerKeyList.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/keys/{keyName}": { "get": { "tags": [ "ServerKeys" ], "description": "Gets a MariaDB Server key.", "operationId": "ServerKeys_Get", "parameters": [ { "$ref": "#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" }, { "name": "keyName", "in": "path", "description": "The name of the MariaDB Server key to be retrieved.", "required": true, "type": "string" }, { "$ref": "#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Successfully retrieved the specified MariaDB Server key.", "schema": { "$ref": "#/definitions/ServerKey" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "Get the MariaDB Server key": { "$ref": "./examples/ServerKeyGet.json" } } }, "put": { "tags": [ "ServerKeys" ], "description": "Creates or updates a MariaDB Server key.", "operationId": "ServerKeys_CreateOrUpdate", "parameters": [ { "$ref": "#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" }, { "name": "keyName", "in": "path", "description": "The name of the MariaDB Server key to be operated on (updated or created).", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "The requested MariaDB Server key resource state.", "required": true, "schema": { "$ref": "#/definitions/ServerKey" } }, { "$ref": "#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Successfully updated the MariaDB Server key.", "schema": { "$ref": "#/definitions/ServerKey" } }, "202": { "description": "Accepted" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-long-running-operation": true, "x-ms-examples": { "Creates or updates a MariaDB Server key": { "$ref": "./examples/ServerKeyCreateOrUpdate.json" } } }, "delete": { "tags": [ "ServerKeys" ], "description": "Deletes the MariaDB Server key with the given name.", "operationId": "ServerKeys_Delete", "parameters": [ { "$ref": "#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" }, { "name": "keyName", "in": "path", "description": "The name of the MariaDB Server key to be deleted.", "required": true, "type": "string" }, { "$ref": "#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Successfully deleted the MariaDB Server key." }, "202": { "description": "Accepted" }, "204": { "description": "The specified MariaDB Server key does not exist." }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-long-running-operation": true, "x-ms-examples": { "Delete the MariaDB Server key": { "$ref": "./examples/ServerKeyDelete.json" } } } } }, "definitions": { "ServerKeyListResult": { "description": "A list of MariaDB Server keys.", "type": "object", "properties": { "value": { "description": "Array of results.", "type": "array", "items": { "$ref": "#/definitions/ServerKey" }, "readOnly": true }, "nextLink": { "description": "Link to retrieve next page of results.", "type": "string", "readOnly": true } } }, "ServerKeyProperties": { "description": "Properties for a key execution.", "required": [ "serverKeyType" ], "type": "object", "properties": { "serverKeyType": { "description": "The key type like 'AzureKeyVault'.", "enum": [ "AzureKeyVault" ], "type": "string", "x-ms-enum": { "name": "ServerKeyType", "modelAsString": true } }, "uri": { "description": "The URI of the key.", "type": "string" }, "creationDate": { "format": "date-time", "description": "The key creation date.", "type": "string", "readOnly": true } } }, "ServerKey": { "description": "A MariaDB Server key.", "type": "object", "allOf": [ { "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" } ], "properties": { "kind": { "description": "Kind of encryption protector. This is metadata used for the Azure portal experience.", "type": "string", "readOnly": true }, "properties": { "$ref": "#/definitions/ServerKeyProperties", "description": "Resource properties.", "x-ms-client-flatten": true } } }, "CloudError": { "x-ms-external": true, "properties": { "error": { "$ref": "#/definitions/CloudErrorBody" } }, "description": "An error response from the Batch service." }, "CloudErrorBody": { "x-ms-external": true, "properties": { "code": { "type": "string", "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." }, "message": { "type": "string", "description": "A message describing the error, intended to be suitable for display in a user interface." }, "target": { "type": "string", "description": "The target of the particular error. For example, the name of the property in error." }, "details": { "type": "array", "items": { "$ref": "#/definitions/CloudErrorBody" }, "description": "A list of additional details about the error." } }, "description": "An error response from the Batch service." } }, "parameters": { "SubscriptionIdParameter": { "name": "subscriptionId", "in": "path", "required": true, "type": "string", "description": "The subscription ID that identifies an Azure subscription." }, "ApiVersionParameter": { "name": "api-version", "in": "query", "required": true, "type": "string", "description": "The API version to use for the request." }, "ResourceGroupParameter": { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.", "x-ms-parameter-location": "method" }, "ServerNameParameter": { "name": "serverName", "in": "path", "required": true, "type": "string", "description": "The name of the server.", "x-ms-parameter-location": "method" } }, "securityDefinitions": { "azure_auth": { "type": "oauth2", "description": "Azure Active Directory OAuth2 Flow", "flow": "implicit", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "scopes": { "user_impersonation": "impersonate your user account" } } } }