[azingest] add sovereign support (Azure#21689)

* add sovereign support

* readme

* configure utils_test.go

* fix env var

* update doc comment

* update docs

Author: gracewilcox

sdk/monitor/azingest/CHANGELOG.md

@@ -1,12 +1,9 @@
 # Release History
 
-## 0.1.1 (Unreleased)
-
-### Features Added
-
-### Breaking Changes
+## 0.1.1 (2023-10-11)
 
 ### Bugs Fixed
+* Added sovereign cloud support
 
 ### Other Changes
 * Added troubleshooting guide.

sdk/monitor/azingest/README.md

@@ -31,6 +31,8 @@ The [azidentity][azure_identity] module is used for Azure Active Directory authe
 
 An authenticated client object is required to upload logs. The examples demonstrate using [azidentity.NewDefaultAzureCredential][default_cred_ref] to authenticate; however, the client accepts any [azidentity][azure_identity] credential. See the [azidentity][azure_identity] documentation for more information about other credential types.
 
+The clients defaults to the Azure public cloud. For other cloud configurations, see the [cloud][cloud_documentation] package documentation.
+
 #### Create a client
 
 [Example client][azingest_pkg_go_example_client]
@@ -92,6 +94,7 @@ This project has adopted the [Microsoft Open Source Code of Conduct][code_of_con
 [azure_monitor_overview]: https://learn.microsoft.com/azure/azure-monitor/
 [azure_monitor_query]: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/monitor/azquery
 [azure_subscription]: https://azure.microsoft.com/free/
+[cloud_documentation]: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azcore/cloud
 [data_collection_endpoint]: https://learn.microsoft.com/azure/azure-monitor/essentials/data-collection-endpoint-overview
 [data_collection_rule]: https://learn.microsoft.com/azure/azure-monitor/essentials/data-collection-rule-overview
 [data_collection_rule_structure]: https://learn.microsoft.com/azure/azure-monitor/essentials/data-collection-rule-structure

sdk/monitor/azingest/cloud_config.go

@@ -0,0 +1,26 @@
+//go:build go1.18
+// +build go1.18
+
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License. See License.txt in the project root for license information.
+
+package azingest
+
+import "github.com/Azure/azure-sdk-for-go/sdk/azcore/cloud"
+
+// Cloud Service Names for Monitor Ingestion, used to identify the respective cloud.ServiceConfiguration
+const (
+	ServiceNameIngestion cloud.ServiceName = "azingest"
+)
+
+func init() {
+	cloud.AzureChina.Services[ServiceNameIngestion] = cloud.ServiceConfiguration{
+		Audience: "https://monitor.azure.cn/",
+	}
+	cloud.AzureGovernment.Services[ServiceNameIngestion] = cloud.ServiceConfiguration{
+		Audience: "https://monitor.azure.us/",
+	}
+	cloud.AzurePublic.Services[ServiceNameIngestion] = cloud.ServiceConfiguration{
+		Audience: "https://monitor.azure.com/",
+	}
+}

sdk/monitor/azingest/custom_client.go

@@ -9,7 +9,11 @@ package azingest
 // this file contains handwritten additions to the generated code
 
 import (
+	"errors"
+	"reflect"
+
 	"github.com/Azure/azure-sdk-for-go/sdk/azcore"
+	"github.com/Azure/azure-sdk-for-go/sdk/azcore/cloud"
 	"github.com/Azure/azure-sdk-for-go/sdk/azcore/policy"
 	"github.com/Azure/azure-sdk-for-go/sdk/azcore/runtime"
 )
@@ -24,8 +28,15 @@ func NewClient(endpoint string, credential azcore.TokenCredential, options *Clie
 	if options == nil {
 		options = &ClientOptions{}
 	}
+	if reflect.ValueOf(options.Cloud).IsZero() {
+		options.Cloud = cloud.AzurePublic
+	}
+	c, ok := options.Cloud.Services[ServiceNameIngestion]
+	if !ok || c.Audience == "" {
+		return nil, errors.New("provided Cloud field is missing Azure Monitor Ingestion configuration")
+	}
 
-	authPolicy := runtime.NewBearerTokenPolicy(credential, []string{"https://monitor.azure.com/" + "/.default"}, nil)
+	authPolicy := runtime.NewBearerTokenPolicy(credential, []string{c.Audience + "/.default"}, nil)
 	azcoreClient, err := azcore.NewClient("azingest.Client", version, runtime.PipelineOptions{PerRetry: []policy.Policy{authPolicy}}, &options.ClientOptions)
 	if err != nil {
 		return nil, err

sdk/monitor/azingest/utils_test.go

@@ -10,10 +10,12 @@ import (
 	"context"
 	"fmt"
 	"os"
+	"strings"
 	"testing"
 	"time"
 
 	"github.com/Azure/azure-sdk-for-go/sdk/azcore"
+	"github.com/Azure/azure-sdk-for-go/sdk/azcore/cloud"
 	"github.com/Azure/azure-sdk-for-go/sdk/azcore/policy"
 	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
 	"github.com/Azure/azure-sdk-for-go/sdk/internal/recording"
@@ -26,10 +28,11 @@ const fakeRuleID = "Custom-TestTable_CL"
 const fakeStreamName = "dcr-testing"
 
 var (
-	credential azcore.TokenCredential
-	endpoint   string
-	ruleID     string
-	streamName string
+	credential  azcore.TokenCredential
+	endpoint    string
+	ruleID      string
+	streamName  string
+	clientCloud cloud.Configuration
 )
 
 func TestMain(m *testing.M) {
@@ -47,6 +50,14 @@ func TestMain(m *testing.M) {
 		if err != nil {
 			panic(err)
 		}
+		if cloudEnv, ok := os.LookupEnv("AZINGEST_ENVIRONMENT"); ok {
+			if strings.EqualFold(cloudEnv, "AzureUSGovernment") {
+				clientCloud = cloud.AzureGovernment
+			}
+			if strings.EqualFold(cloudEnv, "AzureChinaCloud") {
+				clientCloud = cloud.AzureChina
+			}
+		}
 	}
 	endpoint = getEnvVar("AZURE_MONITOR_DCE", fakeEndpoint)
 	ruleID = getEnvVar("AZURE_MONITOR_DCR_ID", fakeRuleID)
@@ -69,7 +80,7 @@ func startTest(t *testing.T) *azingest.Client {
 	startRecording(t)
 	transport, err := recording.NewRecordingHTTPClient(t, nil)
 	require.NoError(t, err)
-	opts := &azingest.ClientOptions{ClientOptions: azcore.ClientOptions{Transport: transport}}
+	opts := &azingest.ClientOptions{ClientOptions: azcore.ClientOptions{Transport: transport, Cloud: clientCloud}}
 
 	client, err := azingest.NewClient(endpoint, credential, opts)
 	if err != nil {