@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 4.21 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as enums from "../types/enums";
/**
* A server key.
*
* Uses Azure REST API version 2023-08-01. In version 2.x of the Azure Native provider, it used API version 2021-11-01.
*
* Other available API versions: 2015-05-01-preview, 2020-02-02-preview, 2020-08-01-preview, 2020-11-01-preview, 2021-02-01-preview, 2021-05-01-preview, 2021-08-01-preview, 2021-11-01, 2021-11-01-preview, 2022-02-01-preview, 2022-05-01-preview, 2022-08-01-preview, 2022-11-01-preview, 2023-02-01-preview, 2023-05-01-preview, 2023-08-01-preview, 2024-05-01-preview, 2024-11-01-preview. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native sql [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare class ServerKey extends pulumi.CustomResource {
/**
* Get an existing ServerKey resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): ServerKey;
/**
* Returns true if the given object is an instance of ServerKey. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is ServerKey;
/**
* Key auto rotation opt-in flag. Either true or false.
*/
readonly autoRotationEnabled: pulumi.Output<boolean>;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* The server key creation date.
*/
readonly creationDate: pulumi.Output<string>;
/**
* Kind of encryption protector. This is metadata used for the Azure portal experience.
*/
readonly kind: pulumi.Output<string>;
/**
* Resource location.
*/
readonly location: pulumi.Output<string>;
/**
* Resource name.
*/
readonly name: pulumi.Output<string>;
/**
* Subregion of the server key.
*/
readonly subregion: pulumi.Output<string>;
/**
* Thumbprint of the server key.
*/
readonly thumbprint: pulumi.Output<string>;
/**
* Resource type.
*/
readonly type: pulumi.Output<string>;
/**
* Create a ServerKey resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: ServerKeyArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a ServerKey resource.
*/
export interface ServerKeyArgs {
/**
* The name of the server key to be operated on (updated or created). The key name is required to be in the format of 'vault_key_version'. For example, if the keyId is https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion, then the server key name should be formatted as: YourVaultName_YourKeyName_YourKeyVersion
*/
keyName?: pulumi.Input<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.
*/
resourceGroupName: pulumi.Input<string>;
/**
* The server key type like 'ServiceManaged', 'AzureKeyVault'.
*/
serverKeyType: pulumi.Input<string | enums.sql.ServerKeyType>;
/**
* The name of the server.
*/
serverName: pulumi.Input<string>;
/**
* The URI of the server key. If the ServerKeyType is AzureKeyVault, then the URI is required. The AKV URI is required to be in this format: 'https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion'
*/
uri?: pulumi.Input<string>;
}