Document sovereign cloud support in LogsIngestionClient

Azure · Oct 12, 2023 · 4019bf6 · 4019bf6
1 parent 55d9835
commit 4019bf6
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 0 deletions.
diff --git a/sdk/monitor/Azure.Monitor.Ingestion/README.md b/sdk/monitor/Azure.Monitor.Ingestion/README.md
@@ -41,6 +41,20 @@ var credential = new DefaultAzureCredential();
 var client = new LogsIngestionClient(endpoint, credential);
 ```
 
+#### Configure client for Azure sovereign cloud
+
+By default, `LogsIngestionClient` is configured to connect to the Azure public cloud. To connect to a sovereign cloud instead, set the `LogsIngestionClientOptions.Audience` property. For example:
+
+```C# Snippet:CreateLogsIngestionClientWithOptions
+var endpoint = new Uri("<data_collection_endpoint_uri>");
+var credential = new DefaultAzureCredential();
+var clientOptions = new LogsIngestionClientOptions
+{
+    Audience = LogsIngestionAudience.AzureChina
+};
+var client = new LogsIngestionClient(endpoint, credential, clientOptions);
+```
+
 ### Upload the logs
 
 For examples of logs ingestion, see the [Examples](#examples) section.

diff --git a/sdk/monitor/Azure.Monitor.Ingestion/tests/Samples/LogDataAndQuery.cs b/sdk/monitor/Azure.Monitor.Ingestion/tests/Samples/LogDataAndQuery.cs
@@ -23,6 +23,19 @@ public void SetUpClient()
             #endregion
         }
 
+        public void SetUpClientWithOptions()
+        {
+            #region Snippet:CreateLogsIngestionClientWithOptions
+            var endpoint = new Uri("<data_collection_endpoint_uri>");
+            var credential = new DefaultAzureCredential();
+            var clientOptions = new LogsIngestionClientOptions
+            {
+                Audience = LogsIngestionAudience.AzureChina
+            };
+            var client = new LogsIngestionClient(endpoint, credential, clientOptions);
+            #endregion
+        }
+
         public void LogData()
         {
             #region Snippet:UploadCustomLogs