Note:
This documentation is for version 3.1.0 of the library.
Some samples may not work with other versions.
Installation
Install the Google.Cloud.Kms.V1 package from NuGet. Add it to
your project in the normal way (for example by right-clicking on the
project in Visual Studio and choosing "Manage NuGet Packages...").
Authentication
When running on Google Cloud Platform, no action needs to be taken to authenticate.
Otherwise, the simplest way of authenticating your API calls is to
download a service account JSON file then set the GOOGLE_APPLICATION_CREDENTIALS environment variable to refer to it.
The credentials will automatically be used to authenticate. See the Getting Started With
Authentication guide for more details.
Getting started
All operations are performed through the following client classes:
Create a client instance by calling the static Create or CreateAsync methods. Alternatively,
use the builder class associated with each client class (e.g. EkmServiceClientBuilder for EkmServiceClient)
as an easy way of specifying custom credentials, settings, or a custom endpoint. Clients are thread-safe,
and we recommend using a single instance across your entire application unless you have a particular need
to configure multiple client objects separately.
Sample code
This example lists all the key rings in the "global" location for a specific project.
KeyManagementServiceClient client = KeyManagementServiceClient.Create();
LocationName globalLocation = new LocationName(projectId, "global");
foreach (KeyRing keyRing in client.ListKeyRings(globalLocation))
{
Console.WriteLine(keyRing.Name);
}
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[[["\u003cp\u003eThis webpage documents version 3.1.0 of the \u003ccode\u003eGoogle.Cloud.Kms.V1\u003c/code\u003e .NET client library, which is used to interact with the Google Cloud Key Management Service API.\u003c/p\u003e\n"],["\u003cp\u003eThe latest version of this library is 3.16.0, and the page provides links to older version documentations, down to version 2.2.0.\u003c/p\u003e\n"],["\u003cp\u003eInstallation of the library is done by obtaining the \u003ccode\u003eGoogle.Cloud.Kms.V1\u003c/code\u003e package from NuGet, and it can be installed normally.\u003c/p\u003e\n"],["\u003cp\u003eThe library utilizes the \u003ccode\u003eEkmServiceClient\u003c/code\u003e and \u003ccode\u003eKeyManagementServiceClient\u003c/code\u003e classes for all operations, and clients are thread-safe, with recommendations for a single instance use.\u003c/p\u003e\n"],["\u003cp\u003eAuthentication can be achieved when running on Google Cloud Platform, otherwise by downloading a service account JSON file and setting the relevant environment variable.\u003c/p\u003e\n"]]],[],null,[]]
