Note:
This documentation is for version 2.5.0 of the library.
Some samples may not work with other versions.
Installation
Install the Google.Cloud.OsConfig.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, no action needs to be taken to authenticate.
Otherwise, the simplest way of authenticating your API calls is to
set up Application Default Credentials.
The credentials will automatically be used to authenticate. See
Set up Application Default Credentials 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. OsConfigServiceClientBuilder for OsConfigServiceClient)
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.
Using the REST (HTTP/1.1) transport
This library defaults to performing RPCs using gRPC using the binary Protocol Buffer wire format.
However, it also supports HTTP/1.1 and JSON, for situations where gRPC doesn't work as desired. (This is typically due to an incompatible proxy
or other network issue.) To create a client using HTTP/1.1, specify a RestGrpcAdapter reference for the GrpcAdapter property in the client builder.
Sample code:
var client = new OsConfigServiceClientBuilder
{
GrpcAdapter = RestGrpcAdapter.Default
}.Build();
[[["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-12 UTC."],[[["\u003cp\u003eThis webpage provides documentation for the \u003ccode\u003eGoogle.Cloud.OsConfig.V1\u003c/code\u003e .NET client library, which is used to interact with the Google Cloud OS Config API.\u003c/p\u003e\n"],["\u003cp\u003eThe latest version of the library is 2.4.0, and the documentation and samples are written to reflect this version, however, previous version information is also listed.\u003c/p\u003e\n"],["\u003cp\u003eAuthentication is automatically handled on Google Cloud, or it can be set up via Application Default Credentials.\u003c/p\u003e\n"],["\u003cp\u003eThe library uses gRPC by default, but it also supports HTTP/1.1 with JSON by using the \u003ccode\u003eRestGrpcAdapter\u003c/code\u003e with the client builder.\u003c/p\u003e\n"],["\u003cp\u003eClient operations are performed using \u003ccode\u003eOsConfigServiceClient\u003c/code\u003e and \u003ccode\u003eOsConfigZonalServiceClient\u003c/code\u003e classes, which can be created by using the static create methods, or by utilizing the associated builder classes.\u003c/p\u003e\n"]]],[],null,[]]
