Note:
This documentation is for version2.3.0of the library.
Some samples may not work with other versions.
Installation
Install theGoogle.Cloud.Kms.V1package 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 theGOOGLE_APPLICATION_CREDENTIALSenvironment variable to refer to it.
The credentials will automatically be used to authenticate. See theGetting Started With
Authenticationguide for more details.
Create a client instance by calling the staticCreateorCreateAsyncmethods. Alternatively,
use the builder class associated with each client class (e.g. KeyManagementServiceClientBuilder for KeyManagementServiceClient)
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"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[[["\u003cp\u003eThis page documents version 2.3.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 there are multiple older versions of this client library available to be used, ranging down to 2.2.0.\u003c/p\u003e\n"],["\u003cp\u003eInstallation of the library is done using the \u003ccode\u003eGoogle.Cloud.Kms.V1\u003c/code\u003e NuGet package.\u003c/p\u003e\n"],["\u003cp\u003eAuthentication when using this library is automatic when running on Google Cloud Platform, otherwise a service account JSON file must be used.\u003c/p\u003e\n"],["\u003cp\u003eAll operations with the Google Cloud Key Management Service API are performed through the \u003ccode\u003eKeyManagementServiceClient\u003c/code\u003e, which can be created via the \u003ccode\u003eCreate\u003c/code\u003e or \u003ccode\u003eCreateAsync\u003c/code\u003e methods.\u003c/p\u003e\n"]]],[],null,[]]
