Skip to content

Commit 48f989c

Browse files
authored
[DocumentIntelligence] Default authentication to Token Credential (Azure#46448)
1 parent 2cbb460 commit 48f989c

32 files changed

+89
-106
lines changed

sdk/documentintelligence/Azure.AI.DocumentIntelligence/MigrationGuide.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -65,8 +65,7 @@ We continue to support API key and AAD authentication methods when creating the
6565
Creating new clients in `Azure.AI.FormRecognizer`:
6666
```C#
6767
string endpoint = "<endpoint>";
68-
string apiKey = "<apiKey>";
69-
var credential = new AzureKeyCredential(apiKey);
68+
var credential = new DefaultAzureCredential();
7069

7170
var documentAnalysisClient = new DocumentAnalysisClient(new Uri(endpoint), credential);
7271
var documentModelAdministrationClient = new DocumentModelAdministrationClient(new Uri(endpoint), credential);
@@ -75,8 +74,7 @@ var documentModelAdministrationClient = new DocumentModelAdministrationClient(ne
7574
Creating new clients in `Azure.AI.DocumentIntelligence`:
7675
```C# Snippet:Migration_CreateBothDocumentIntelligenceClients
7776
string endpoint = "<endpoint>";
78-
string apiKey = "<apiKey>";
79-
var credential = new AzureKeyCredential(apiKey);
77+
var credential = new DefaultAzureCredential();
8078

8179
var documentIntelligenceClient = new DocumentIntelligenceClient(new Uri(endpoint), credential);
8280
var documentIntelligenceAdministrationClient = new DocumentIntelligenceAdministrationClient(new Uri(endpoint), credential);
@@ -352,7 +350,7 @@ Differences between the versions:
352350
Building a document model with `Azure.AI.FormRecognizer`:
353351
```C#
354352
Uri blobContainerUri = new Uri("<blobContainerUri>");
355-
var client = new DocumentModelAdministrationClient(new Uri(endpoint), new AzureKeyCredential(apiKey));
353+
var client = new DocumentModelAdministrationClient(new Uri(endpoint), new DefaultAzureCredential());
356354

357355
BuildDocumentModelOperation operation = await client.BuildDocumentModelAsync(WaitUntil.Completed, blobContainerUri, DocumentBuildMode.Template);
358356
DocumentModelDetails model = operation.Value;

sdk/documentintelligence/Azure.AI.DocumentIntelligence/README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ az cognitiveservices account keys list --name "<resource-name>" --resource-group
9797

9898
Once you have the value for the API key, create an `AzureKeyCredential`. With the endpoint and key credential, you can create the [`DocumentIntelligenceClient`][doc_intelligence_client_class]:
9999

100-
```C# Snippet:CreateDocumentIntelligenceClient
100+
```C# Snippet:CreateDocumentIntelligenceClientApiKey
101101
string endpoint = "<endpoint>";
102102
string apiKey = "<apiKey>";
103103
var client = new DocumentIntelligenceClient(new Uri(endpoint), new AzureKeyCredential(apiKey));
@@ -117,9 +117,10 @@ You will also need to [register a new AAD application][register_aad_app] and [gr
117117

118118
Set the values of the client ID, tenant ID, and client secret of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET.
119119

120-
```C# Snippet:CreateDocumentIntelligenceClientTokenCredential
120+
```C# Snippet:CreateDocumentIntelligenceClient
121121
string endpoint = "<endpoint>";
122-
var client = new DocumentIntelligenceClient(new Uri(endpoint), new DefaultAzureCredential());
122+
var credential = new DefaultAzureCredential();
123+
var client = new DocumentIntelligenceClient(new Uri(endpoint), credential);
123124
```
124125

125126
## Key concepts

sdk/documentintelligence/Azure.AI.DocumentIntelligence/assets.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,5 @@
22
"AssetsRepo": "Azure/azure-sdk-assets",
33
"AssetsRepoPrefixPath": "net",
44
"TagPrefix": "net/documentintelligence/Azure.AI.DocumentIntelligence",
5-
"Tag": "net/documentintelligence/Azure.AI.DocumentIntelligence_76280009cf"
5+
"Tag": "net/documentintelligence/Azure.AI.DocumentIntelligence_ac9b1a968f"
66
}

sdk/documentintelligence/Azure.AI.DocumentIntelligence/samples/Sample_AddOnCapabilities.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ You can set `endpoint` and `apiKey` based on an environment variable, a configur
1414

1515
```C# Snippet:CreateDocumentIntelligenceClient
1616
string endpoint = "<endpoint>";
17-
string apiKey = "<apiKey>";
18-
var client = new DocumentIntelligenceClient(new Uri(endpoint), new AzureKeyCredential(apiKey));
17+
var credential = new DefaultAzureCredential();
18+
var client = new DocumentIntelligenceClient(new Uri(endpoint), credential);
1919
```
2020

2121
## High resolution extraction

sdk/documentintelligence/Azure.AI.DocumentIntelligence/samples/Sample_AnalyzeWithPrebuiltModel.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ You can set `endpoint` and `apiKey` based on an environment variable, a configur
1212

1313
```C# Snippet:CreateDocumentIntelligenceClient
1414
string endpoint = "<endpoint>";
15-
string apiKey = "<apiKey>";
16-
var client = new DocumentIntelligenceClient(new Uri(endpoint), new AzureKeyCredential(apiKey));
15+
var credential = new DefaultAzureCredential();
16+
var client = new DocumentIntelligenceClient(new Uri(endpoint), credential);
1717
```
1818

1919
## Use a prebuilt model to analyze a document from a URI

sdk/documentintelligence/Azure.AI.DocumentIntelligence/samples/Sample_BuildCustomModel.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ You can set `endpoint` and `apiKey` based on an environment variable, a configur
1414

1515
```C# Snippet:CreateDocumentIntelligenceAdministrationClient
1616
string endpoint = "<endpoint>";
17-
string apiKey = "<apiKey>";
18-
var client = new DocumentIntelligenceAdministrationClient(new Uri(endpoint), new AzureKeyCredential(apiKey));
17+
var credential = new DefaultAzureCredential();
18+
var client = new DocumentIntelligenceAdministrationClient(new Uri(endpoint), credential);
1919
```
2020

2121
## Build a custom model

sdk/documentintelligence/Azure.AI.DocumentIntelligence/samples/Sample_BuildDocumentClassifier.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ You can set `endpoint` and `apiKey` based on an environment variable, a configur
1414

1515
```C# Snippet:CreateDocumentIntelligenceAdministrationClient
1616
string endpoint = "<endpoint>";
17-
string apiKey = "<apiKey>";
18-
var client = new DocumentIntelligenceAdministrationClient(new Uri(endpoint), new AzureKeyCredential(apiKey));
17+
var credential = new DefaultAzureCredential();
18+
var client = new DocumentIntelligenceAdministrationClient(new Uri(endpoint), credential);
1919
```
2020

2121
## Build a document classifier

sdk/documentintelligence/Azure.AI.DocumentIntelligence/samples/Sample_ClassifyDocument.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ You can set `endpoint` and `apiKey` based on an environment variable, a configur
1212

1313
```C# Snippet:CreateDocumentIntelligenceClient
1414
string endpoint = "<endpoint>";
15-
string apiKey = "<apiKey>";
16-
var client = new DocumentIntelligenceClient(new Uri(endpoint), new AzureKeyCredential(apiKey));
15+
var credential = new DefaultAzureCredential();
16+
var client = new DocumentIntelligenceClient(new Uri(endpoint), credential);
1717
```
1818

1919
## Classify a document from a URI

sdk/documentintelligence/Azure.AI.DocumentIntelligence/samples/Sample_CopyCustomModel.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ The source client that contains the custom model to copy.
2626

2727
```C# Snippet:DocumentIntelligenceSampleCreateCopySourceClient
2828
string sourceEndpoint = "<sourceEndpoint>";
29-
string sourceApiKey = "<sourceApiKey>";
30-
var sourceClient = new DocumentIntelligenceAdministrationClient(new Uri(sourceEndpoint), new AzureKeyCredential(sourceApiKey));
29+
var sourceResourceCredential = new DefaultAzureCredential();
30+
var sourceClient = new DocumentIntelligenceAdministrationClient(new Uri(sourceEndpoint), sourceResourceCredential);
3131
```
3232

3333
### Target client
@@ -36,8 +36,8 @@ The target client to copy the custom model to.
3636

3737
```C# Snippet:DocumentIntelligenceSampleCreateCopyTargetClient
3838
string targetEndpoint = "<targetEndpoint>";
39-
string targetApiKey = "<targetApiKey>";
40-
var targetClient = new DocumentIntelligenceAdministrationClient(new Uri(targetEndpoint), new AzureKeyCredential(targetApiKey));
39+
var targetResourceCredential = new DefaultAzureCredential();
40+
var targetClient = new DocumentIntelligenceAdministrationClient(new Uri(targetEndpoint), targetResourceCredential);
4141
```
4242

4343
### Authorize the copy

sdk/documentintelligence/Azure.AI.DocumentIntelligence/samples/Sample_ExtractLayout.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ You can set `endpoint` and `apiKey` based on an environment variable, a configur
1212

1313
```C# Snippet:CreateDocumentIntelligenceClient
1414
string endpoint = "<endpoint>";
15-
string apiKey = "<apiKey>";
16-
var client = new DocumentIntelligenceClient(new Uri(endpoint), new AzureKeyCredential(apiKey));
15+
var credential = new DefaultAzureCredential();
16+
var client = new DocumentIntelligenceClient(new Uri(endpoint), credential);
1717
```
1818

1919
## Extract the layout of a document from a URI

0 commit comments

Comments
 (0)