openapi-directory/api/azure.com/mysql-DataEncryptionKeys.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"description":"The Microsoft Azure management API provides create, read, update, and delete functionality for Azure MySQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files, encryption keys, active directory administrator and configurations.","title":"MySQLManagementClient","version":"2020-01-01-privatepreview","x-apisguru-categories":["cloud"],"x-logo":{"url":"https://assets.onestore.ms/cdnfiles/onestorerolling-1606-01000/shell/v3/images/logo/microsoft.png"},"x-origin":[{"format":"swagger","url":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-01-01-privatepreview/DataEncryptionKeys.json","version":"2.0"}],"x-providerName":"azure.com","x-serviceName":"mysql-DataEncryptionKeys","x-tags":["Azure","Microsoft"]},"paths":{"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/keys":{"get":{"description":"Gets a list of  Server keys.","operationId":"ServerKeys_ListByInstance","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"$ref":"#/components/parameters/ServerNameParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved the list of MySQL Server keys.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerKeyListResult"},"examples":{"List the keys for a MySQL Server.":{"$ref":"#/components/examples/List_the_keys_for_a_MySQL_Server."}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"tags":["ServerKeys"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/keys/{keyName}":{"delete":{"description":"Deletes the MySQL Server key with the given name.","operationId":"ServerKeys_Delete","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"$ref":"#/components/parameters/ServerNameParameter"},{"description":"The name of the MySQL Server key to be deleted.","in":"path","name":"keyName","required":true,"schema":{"type":"string"},"examples":{"Delete the MySQL Server key":{"value":"someVault_someKey_01234567890123456789012345678901"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully deleted the MySQL Server key."},"202":{"description":"Accepted"},"204":{"description":"The specified MySQL Server key does not exist."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"tags":["ServerKeys"],"x-ms-long-running-operation":true},"get":{"description":"Gets a MySQL Server key.","operationId":"ServerKeys_Get","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"$ref":"#/components/parameters/ServerNameParameter"},{"description":"The name of the MySQL Server key to be retrieved.","in":"path","name":"keyName","required":true,"schema":{"type":"string"},"examples":{"Get the MySQL Server key":{"value":"someVault_someKey_01234567890123456789012345678901"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved the specified MySQL Server key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerKey"},"examples":{"Get the MySQL Server key":{"$ref":"#/components/examples/Get_the_MySQL_Server_key"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"tags":["ServerKeys"]},"put":{"description":"Creates or updates a MySQL Server key.","operationId":"ServerKeys_CreateOrUpdate","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"$ref":"#/components/parameters/ServerNameParameter"},{"description":"The name of the MySQL Server key to be operated on (updated or created).","in":"path","name":"keyName","required":true,"schema":{"type":"string"},"examples":{"Creates or updates a MySQL Server key":{"value":"someVault_someKey_01234567890123456789012345678901"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerKey"}}},"description":"The requested MySQL Server key resource state.","required":true},"responses":{"200":{"description":"Successfully updated the MySQL Server key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerKey"},"examples":{"Creates or updates a MySQL Server key":{"$ref":"#/components/examples/Creates_or_updates_a_MySQL_Server_key"}}}}},"202":{"description":"Accepted"},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"tags":["ServerKeys"],"x-ms-long-running-operation":true}}},"servers":[{"url":"https://management.azure.com"}],"components":{"examples":{"List_the_keys_for_a_MySQL_Server.":{"value":{"value":[{"id":"/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/servers/testserver/keys/someVault_someKey_01234567890123456789012345678901","kind":"azurekeyvault","name":"someVault_someKey_01234567890123456789012345678901","properties":{"creationDate":"2019-12-01T00:00:00.0Z","serverKeyType":"AzureKeyVault","uri":"https://someVault.vault.azure.net/keys/someKey/01234567890123456789012345678901"},"type":"Microsoft.DBforMySQL/servers/keys"}]}},"Get_the_MySQL_Server_key":{"value":{"id":"/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/servers/testserver/keys/someVault_someKey_01234567890123456789012345678901","kind":"azurekeyvault","name":"someVault_someKey_01234567890123456789012345678901","properties":{"creationDate":"2019-12-01T00:00:00.0Z","serverKeyType":"AzureKeyVault","uri":"https://someVault.vault.azure.net/keys/someKey/01234567890123456789012345678901"},"type":"Microsoft.DBforMySQL/servers/keys"}},"Creates_or_updates_a_MySQL_Server_key":{"value":{"id":"/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/servers/testserver/keys/someVault_someKey_01234567890123456789012345678901","kind":"azurekeyvault","name":"omeVault_someKey_01234567890123456789012345678901","properties":{"creationDate":"2017-05-01T00:00:00.0Z","serverKeyType":"AzureKeyVault","uri":"https://someVault.vault.azure.net/keys/someKey/01234567890123456789012345678901"},"type":"Microsoft.DBforMySQL/servers/keys"}}},"parameters":{"ApiVersionParameter":{"description":"The API version to use for the request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"List the keys for a MySQL Server.":{"value":"2020-01-01-privatepreview"},"Delete the MySQL Server key":{"value":"2020-01-01-privatepreview"},"Get the MySQL Server key":{"value":"2020-01-01-privatepreview"},"Creates or updates a MySQL Server key":{"value":"2020-01-01-privatepreview"}}},"ResourceGroupParameter":{"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.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"List the keys for a MySQL Server.":{"value":"testrg"},"Delete the MySQL Server key":{"value":"testrg"},"Get the MySQL Server key":{"value":"testrg"},"Creates or updates a MySQL Server key":{"value":"testrg"}}},"ServerNameParameter":{"description":"The name of the server.","in":"path","name":"serverName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"List the keys for a MySQL Server.":{"value":"testserver"},"Delete the MySQL Server key":{"value":"testserver"},"Get the MySQL Server key":{"value":"testserver"},"Creates or updates a MySQL Server key":{"value":"testserver"}}},"SubscriptionIdParameter":{"description":"The subscription ID that identifies an Azure subscription.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"List the keys for a MySQL Server.":{"value":"ffffffff-ffff-ffff-ffff-ffffffffffff"},"Delete the MySQL Server key":{"value":"ffffffff-ffff-ffff-ffff-ffffffffffff"},"Get the MySQL Server key":{"value":"ffffffff-ffff-ffff-ffff-ffffffffffff"},"Creates or updates a MySQL Server key":{"value":"ffffffff-ffff-ffff-ffff-ffffffffffff"}}}},"securitySchemes":{"azure_auth":{"description":"Azure Active Directory OAuth2 Flow","type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://login.microsoftonline.com/common/oauth2/authorize","scopes":{"user_impersonation":"impersonate your user account"}}}}},"schemas":{"CloudError":{"description":"An error response from the Batch service.","properties":{"error":{"$ref":"#/components/schemas/CloudErrorBody"}},"x-ms-external":true},"CloudErrorBody":{"description":"An error response from the Batch service.","properties":{"code":{"description":"An identifier for the error. Codes are invariant and are intended to be consumed programmatically.","type":"string"},"details":{"description":"A list of additional details about the error.","items":{"$ref":"#/components/schemas/CloudErrorBody"},"type":"array"},"message":{"description":"A message describing the error, intended to be suitable for display in a user interface.","type":"string"},"target":{"description":"The target of the particular error. For example, the name of the property in error.","type":"string"}},"x-ms-external":true},"ProxyResource":{"description":"Resource properties.","properties":{"id":{"description":"Resource ID","readOnly":true,"type":"string"},"name":{"description":"Resource name.","readOnly":true,"type":"string"},"type":{"description":"Resource type.","readOnly":true,"type":"string"}},"x-ms-azure-resource":true},"ServerKey":{"allOf":[{"$ref":"#/components/schemas/ProxyResource"}],"description":"A MySQL Server key.","properties":{"kind":{"description":"Kind of encryption protector. This is metadata used for the Azure portal experience.","readOnly":true,"type":"string"},"properties":{"$ref":"#/components/schemas/ServerKeyProperties"}},"type":"object"},"ServerKeyListResult":{"description":"A list of MySQL Server keys.","properties":{"nextLink":{"description":"Link to retrieve next page of results.","readOnly":true,"type":"string"},"value":{"description":"Array of results.","items":{"$ref":"#/components/schemas/ServerKey"},"readOnly":true,"type":"array"}},"type":"object"},"ServerKeyProperties":{"description":"Properties for a key execution.","properties":{"creationDate":{"description":"The key creation date.","format":"date-time","readOnly":true,"type":"string"},"serverKeyType":{"description":"The key type like 'AzureKeyVault'.","enum":["AzureKeyVault"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"ServerKeyType"}},"uri":{"description":"The URI of the key.","type":"string"}},"required":["serverKeyType"],"type":"object"}}}}