azure_postgresql_dataencryptionkeys

@datafire/azure_postgresql_dataencryptionkeys

Client library for PostgreSQLManagementClient

Installation and Usage

npm install --save @datafire/azure_postgresql_dataencryptionkeys

let azure_postgresql_dataencryptionkeys = require('@datafire/azure_postgresql_dataencryptionkeys').create({
  access_token: "",
  refresh_token: "",
  client_id: "",
  client_secret: "",
  redirect_uri: ""
});

.then(data => {
  console.log(data);
});

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, encryption keys, active directory administrator and configurations.

Actions

ServerKeys_ListByInstance

Gets a list of Server keys.

azure_postgresql_dataencryptionkeys.ServerKeys_ListByInstance({
  "resourceGroupName": "",
  "serverName": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

• input object
  • resourceGroupName required string: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serverName required string: The name of the server.
  • subscriptionId required string: The subscription ID that identifies an Azure subscription.
  • api-version required string: The API version to use for the request.

Output

• output ServerKeyListResult

ServerKeys_Delete

Deletes the PostgreSQL Server key with the given name.

azure_postgresql_dataencryptionkeys.ServerKeys_Delete({
  "resourceGroupName": "",
  "serverName": "",
  "keyName": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

• input object
  • resourceGroupName required string: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serverName required string: The name of the server.
  • keyName required string: The name of the PostgreSQL Server key to be deleted.
  • subscriptionId required string: The subscription ID that identifies an Azure subscription.
  • api-version required string: The API version to use for the request.

Output

Output schema unknown

ServerKeys_Get

Gets a PostgreSQL Server key.

azure_postgresql_dataencryptionkeys.ServerKeys_Get({
  "resourceGroupName": "",
  "serverName": "",
  "keyName": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

• input object
  • resourceGroupName required string: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serverName required string: The name of the server.
  • keyName required string: The name of the PostgreSQL Server key to be retrieved.
  • subscriptionId required string: The subscription ID that identifies an Azure subscription.
  • api-version required string: The API version to use for the request.

Output

• output ServerKey

ServerKeys_CreateOrUpdate

Creates or updates a PostgreSQL Server key.

azure_postgresql_dataencryptionkeys.ServerKeys_CreateOrUpdate({
  "resourceGroupName": "",
  "serverName": "",
  "keyName": "",
  "parameters": {},
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

• input object
  • resourceGroupName required string: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serverName required string: The name of the server.
  • keyName required string: The name of the PostgreSQL Server key to be operated on (updated or created).
  • parameters required ServerKey
  • subscriptionId required string: The subscription ID that identifies an Azure subscription.
  • api-version required string: The API version to use for the request.

Output

• output ServerKey

Definitions

CloudError

• CloudError object: An error response from the Batch service.
  • error CloudErrorBody

CloudErrorBody

• CloudErrorBody object: An error response from the Batch service.
  • code string: An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
  • details array: A list of additional details about the error.
    • items CloudErrorBody
  • message string: A message describing the error, intended to be suitable for display in a user interface.
  • target string: The target of the particular error. For example, the name of the property in error.

ProxyResource

• ProxyResource object: Resource properties.
  • id string: Resource ID
  • name string: Resource name.
  • type string: Resource type.

ServerKey

• ServerKey object: A PostgreSQL Server key.
  • kind string: Kind of encryption protector. This is metadata used for the Azure portal experience.
  • properties ServerKeyProperties
  • id string: Resource ID
  • name string: Resource name.
  • type string: Resource type.

ServerKeyListResult

• ServerKeyListResult object: A list of PostgreSQL Server keys.
  • nextLink string: Link to retrieve next page of results.
  • value array: Array of results.
    • items ServerKey

ServerKeyProperties

• ServerKeyProperties object: Properties for a key execution.
  • creationDate string: The key creation date.
  • serverKeyType required string (values: AzureKeyVault): The key type like 'AzureKeyVault'.
  • uri string: The URI of the key.