Note:
This documentation is for version 2.4.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.
Create a client instance by calling the static Create or CreateAsync methods. 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-03-21 UTC."],[[["This documentation pertains to version 2.4.0 of the `Google.Cloud.Kms.V1` .NET client library, which is designed for interacting with the Google Cloud Key Management Service API."],["The latest version of the library is 3.16.0, and you can access documentation for other previous versions, from 3.15.0 to 2.2.0, on this page."],["Authentication for this library on Google Cloud Platform is automatic, but otherwise, you'll need to set the `GOOGLE_APPLICATION_CREDENTIALS` environment variable to point to a service account JSON file."],["All API operations are conducted through the `KeyManagementServiceClient`, and creating a client instance is done using the static `Create` or `CreateAsync` methods or the `KeyManagementServiceClientBuilder`."],["The client is thread-safe, and we suggest using one client instance across the application unless multiple configurations are required, and this page includes an example of listing all key rings in the \"global\" location for a specific project."]]],[]]
