Note:
This documentation is for version2.0.0-alpha06of the library.
Some samples may not work with other versions.
Installation
Install theGoogle.Cloud.OsConfig.V1Alphapackage 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...").
Please ensure you enable pre-release packages (for example, in the
Visual Studio NuGet user interface, check the "Include prerelease"
box). Some of the following samples might only work with the latest
pre-release version (2.0.0-alpha06) ofGoogle.Cloud.OsConfig.V1Alpha.
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. SeeSet up Application Default Credentialsfor more details.
Create a client instance by calling the staticCreateorCreateAsyncmethods. Alternatively,
use the builder class associated with each client class (e.g. OsConfigZonalServiceClientBuilder for OsConfigZonalServiceClient)
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 usinggRPCusing the binaryProtocol Bufferwire 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 aRestGrpcAdapterreference for theGrpcAdapterproperty in the client builder.
Sample code:
var client = new OsConfigZonalServiceClientBuilder
{
GrpcAdapter = RestGrpcAdapter.Default
}.Build();
[[["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\u003e\u003ccode\u003eGoogle.Cloud.OsConfig.V1Alpha\u003c/code\u003e is a .NET client library for the Google Cloud OS Config API, with version \u003ccode\u003e2.0.0-alpha06\u003c/code\u003e being the latest.\u003c/p\u003e\n"],["\u003cp\u003eInstallation of the library is done via NuGet, with pre-release packages enabled to access the most recent versions, like \u003ccode\u003e2.0.0-alpha06\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eAuthentication on Google Cloud is automatic, but other environments require setting up Application Default Credentials.\u003c/p\u003e\n"],["\u003cp\u003eAll operations are conducted through \u003ccode\u003eOsConfigZonalServiceClient\u003c/code\u003e, created via \u003ccode\u003eCreate\u003c/code\u003e or \u003ccode\u003eCreateAsync\u003c/code\u003e, or using the \u003ccode\u003eOsConfigZonalServiceClientBuilder\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eWhile the library defaults to gRPC, HTTP/1.1 and JSON are supported by specifying \u003ccode\u003eRestGrpcAdapter\u003c/code\u003e for the \u003ccode\u003eGrpcAdapter\u003c/code\u003e property in the client builder.\u003c/p\u003e\n"]]],[],null,["Version latestkeyboard_arrow_down\n\n- [2.0.0-alpha06 (latest)](/dotnet/docs/reference/Google.Cloud.OsConfig.V1Alpha/latest)\n- [2.0.0-alpha05](/dotnet/docs/reference/Google.Cloud.OsConfig.V1Alpha/2.0.0-alpha05)\n- [1.0.0-alpha04](/dotnet/docs/reference/Google.Cloud.OsConfig.V1Alpha/1.0.0-alpha04) \n\nGoogle.Cloud.OsConfig.V1Alpha\n=============================\n\n`Google.Cloud.OsConfig.V1Alpha` is a.NET client library for the [Google Cloud OS Config API](https://cloud.google.com/compute/docs/osconfig/rest).\n\nNote:\nThis documentation is for version `2.0.0-alpha06` of the library.\nSome samples may not work with other versions.\n\nInstallation\n------------\n\nInstall the `Google.Cloud.OsConfig.V1Alpha` package from NuGet. Add it to\nyour project in the normal way (for example by right-clicking on the\nproject in Visual Studio and choosing \"Manage NuGet Packages...\").\nPlease ensure you enable pre-release packages (for example, in the\nVisual Studio NuGet user interface, check the \"Include prerelease\"\nbox). Some of the following samples might only work with the latest\npre-release version (`2.0.0-alpha06`) of `Google.Cloud.OsConfig.V1Alpha`.\n\nAuthentication\n--------------\n\nWhen running on Google Cloud, no action needs to be taken to authenticate.\n\nOtherwise, the simplest way of authenticating your API calls is to\nset up Application Default Credentials.\nThe credentials will automatically be used to authenticate. See\n[Set up Application Default Credentials](https://cloud.google.com/docs/authentication/provide-credentials-adc) for more details.\n\nGetting started\n---------------\n\nAll operations are performed through [OsConfigZonalServiceClient](/dotnet/docs/reference/Google.Cloud.OsConfig.V1Alpha/latest/Google.Cloud.OsConfig.V1Alpha.OsConfigZonalServiceClient).\n\nCreate a client instance by calling the static `Create` or `CreateAsync` methods. Alternatively,\nuse the builder class associated with each client class (e.g. OsConfigZonalServiceClientBuilder for OsConfigZonalServiceClient)\nas an easy way of specifying custom credentials, settings, or a custom endpoint. Clients are thread-safe,\nand we recommend using a single instance across your entire application unless you have a particular need\nto configure multiple client objects separately.\n\n### Using the REST (HTTP/1.1) transport\n\nThis library defaults to performing RPCs using [gRPC](https://grpc.io/) using the binary [Protocol Buffer](https://protobuf.dev) wire format.\nHowever, 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\nor other network issue.) To create a client using HTTP/1.1, specify a `RestGrpcAdapter` reference for the `GrpcAdapter` property in the client builder.\nSample code: \n\n var client = new OsConfigZonalServiceClientBuilder\n {\n GrpcAdapter = RestGrpcAdapter.Default\n }.Build();\n\nFor more details, see the [transport selection](https://cloud.google.com/dotnet/docs/reference/help/transports) page."]]
