@datafire/azure_sql_encryptionprotectors v5.0.0

@datafire/azure_sql_encryptionprotectors

Client library for SqlManagementClient

Installation and Usage

npm install --save @datafire/azure_sql_encryptionprotectors

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

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

Description

The Azure SQL Database management API provides a RESTful set of web APIs that interact with Azure SQL Database services to manage your databases. The API enables users to create, retrieve, update, and delete databases, servers, and other entities.

Actions

EncryptionProtectors_ListByServer

Gets a list of server encryption protectors

azure_sql_encryptionprotectors.EncryptionProtectors_ListByServer({
  "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 EncryptionProtectorListResult

EncryptionProtectors_Get

Gets a server encryption protector.

azure_sql_encryptionprotectors.EncryptionProtectors_Get({
  "resourceGroupName": "",
  "serverName": "",
  "encryptionProtectorName": "",
  "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.
  • encryptionProtectorName required string (values: current): The name of the encryption protector 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 EncryptionProtector

EncryptionProtectors_CreateOrUpdate

Updates an existing encryption protector.

azure_sql_encryptionprotectors.EncryptionProtectors_CreateOrUpdate({
  "resourceGroupName": "",
  "serverName": "",
  "encryptionProtectorName": "",
  "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.
  • encryptionProtectorName required string (values: current): The name of the encryption protector to be updated.
  • parameters required EncryptionProtector
  • 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 EncryptionProtector

EncryptionProtectors_Revalidate

Revalidates an existing encryption protector.

azure_sql_encryptionprotectors.EncryptionProtectors_Revalidate({
  "resourceGroupName": "",
  "serverName": "",
  "encryptionProtectorName": "",
  "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.
  • encryptionProtectorName required string (values: current): The name of the encryption protector to be updated.
  • 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

Definitions

EncryptionProtector

• EncryptionProtector object: The server encryption protector.
  • kind string: Kind of encryption protector. This is metadata used for the Azure portal experience.
  • location string: Resource location.
  • properties EncryptionProtectorProperties
  • id string: Resource ID.
  • name string: Resource name.
  • type string: Resource type.

EncryptionProtectorListResult

• EncryptionProtectorListResult object: A list of server encryption protectors.
  • nextLink string: Link to retrieve next page of results.
  • value array: Array of results.
    • items EncryptionProtector

EncryptionProtectorProperties

• EncryptionProtectorProperties object: Properties for an encryption protector execution.
  • serverKeyName string: The name of the server key.
  • serverKeyType required string (values: ServiceManaged, AzureKeyVault): The encryption protector type like 'ServiceManaged', 'AzureKeyVault'.
  • subregion string: Subregion of the encryption protector.
  • thumbprint string: Thumbprint of the server key.
  • uri string: The URI of the server key.