[Form Recognizer] Sovereign clouds support #20522

HarshaNalluru · 2022-02-24T10:44:17Z

Packages impacted by this PR

@azure/ai-form-recognizer

Issues associated with this PR

Fixes #19442

Describe the problem that is addressed by this PR

Adds sovereign cloud support to the form recognizer package

What are the possible designs available to address the problem? If there are more than one possible design, why was the one in this PR chosen?

Adds the audience option in the client options to support the UsGov and China clouds
Based on the prior art and the architecture board discussions(links below), this design was chosen.

Provide a list of related PRs/issues

[Text Analytics]It will return error when use textAnalyticsClient with AAD authentication to run integration tests on UsGov cloud and China cloud #17563
Change Request: Add note on how to use package in other Azure clouds in the readme azure-sdk#3353
Remove AuthenticationScope from ACR ClientOptions azure-sdk#2905
Board Review: Configuration for Azure SDK track-2 clients azure-sdk#3752
Add multi tenant cloud support to Form Recognizer azure-sdk-for-java#25517
.NET - Update cloud configuration API azure-sdk-for-net#23141

JS -

azure-sdk-for-js/sdk/containerregistry/container-registry/src/containerRegistryClient.ts

Lines 36 to 41 in 809f05c

    
             /** 
        
              * Gets or sets the audience to use for authentication with Azure Active Directory. 
        
              * The authentication scope will be set from this audience. 
        
              * See {@link KnownContainerRegistryAudience} for known audience values. 
        
              */ 
        
             audience?: string;

JAVA - https://github.com/samvaity/azure-sdk-for-java/blob/e0d055cbe7f575c5ba004d1b07a9a48487cf6f6e/sdk/formrecognizer/azure-ai-formrecognizer/src/main/java/com/azure/ai/formrecognizer/models/FormRecognizerAudience.java#L11-L19
https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/604/Sovereign-Cloud-Testing

Are there test cases added in this PR? (If not, why?)

No, but the existing test cases are updated to handle the multiple clouds by checking the endpoint.

Checklists

Added impacted package name to the issue description
Added a changelog (if necessary)

HarshaNalluru · 2022-02-24T10:45:08Z

/azp run js - ai-form-recognizer - tests-weekly

azure-pipelines · 2022-02-24T10:45:20Z

Azure Pipelines successfully started running 1 pipeline(s).

ramya-rao-a · 2022-02-24T15:37:35Z

sdk/formrecognizer/ai-form-recognizer/src/options/FormRecognizerClientOptions.ts

+   * The authentication scope will be set from this audience.
+   * See {@link KnownFormRecognizerAudience} for known audience values.
+   */
+  audience?: string;


Is this the accepted approach to set the scope across all the different packages/languages?

Reference:
I went through the notes, issues, references, and the recorded Arch board meeting on this.
And this was the approach followed in other places, which aligns with the discussion from the arch board meeting.

.NET - Update cloud configuration API azure-sdk-for-net#23141

JS -

azure-sdk-for-js/sdk/containerregistry/container-registry/src/containerRegistryClient.ts

Lines 36 to 41 in 809f05c

/**

* Gets or sets the audience to use for authentication with Azure Active Directory.

* The authentication scope will be set from this audience.

* See {@link KnownContainerRegistryAudience} for known audience values.

*/

audience?: string;

JAVA - https://github.com/samvaity/azure-sdk-for-java/blob/e0d055cbe7f575c5ba004d1b07a9a48487cf6f6e/sdk/formrecognizer/azure-ai-formrecognizer/src/main/java/com/azure/ai/formrecognizer/models/FormRecognizerAudience.java#L11-L19

I'll however get it reviewed by architects and others. 🙂

HarshaNalluru · 2022-02-24T19:08:59Z

sdk/formrecognizer/ai-form-recognizer/src/constants.ts

+ */
+export enum KnownFormRecognizerAudience {
+  /** Azure China */
+  AzureResourceManagerChina = "https://cognitiveservices.azure.cn/.default",


There is nothing special about these links relating to FormRecognizer, should it be KnownCognitiveServicesAudience instead and declared at some common place?

That would make sense if we had a common package for cognitive services which we don't...

We can duplicate the code and use better name for now.

sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md

…u/azure-sdk-for-js into harshan/issue/19442

HarshaNalluru · 2022-02-28T19:09:39Z

/azp run js - ai-form-recognizer - tests-weekly

azure-pipelines · 2022-02-28T19:09:53Z

Azure Pipelines successfully started running 1 pipeline(s).

HarshaNalluru · 2022-02-28T19:10:58Z

/azp run js - ai-form-recognizer - tests-weekly

azure-pipelines · 2022-02-28T19:11:12Z

Azure Pipelines successfully started running 1 pipeline(s).

HarshaNalluru · 2022-02-28T19:19:34Z

/azp run js - ai-form-recognizer - tests-weekly

azure-pipelines · 2022-02-28T19:19:47Z

Azure Pipelines successfully started running 1 pipeline(s).

benbp · 2022-02-28T20:16:27Z

sdk/formrecognizer/ai-form-recognizer/tests.yml

 trigger: none

 stages:
  - template: /eng/pipelines/templates/stages/archetype-sdk-tests.yml
    parameters:
      PackageName: "@azure/ai-form-recognizer"
      ServiceDirectory: formrecognizer
-      Location: "${{ parameters.Location }}"
+      SupportedClouds: 'Public,UsGov,China'
      EnvVars:
        AZURE_CLIENT_ID: $(aad-azure-sdk-test-client-id)


These will need to be changed to not be hardcoded to the public cloud values, but rather the env vars dynamically set by the test infra, e.g.

AZURE_CLIENT_ID: $(FORMRECOGNIZER_CLIENT_ID)

But app-config has the same thing, why does it work over there?

@HarshaNalluru it's possible app configuration reads the APPCONFIGURATION_CLIENT_ID, etc. variables and doesn't even use those old ones anymore.

HarshaNalluru · 2022-02-28T20:25:28Z

/azp run js - ai-form-recognizer - tests-weekly

azure-pipelines · 2022-02-28T20:25:50Z

Azure Pipelines successfully started running 1 pipeline(s).

HarshaNalluru · 2022-02-28T20:59:34Z

/azp run js - ai-form-recognizer - tests-weekly

azure-pipelines · 2022-02-28T20:59:48Z

Azure Pipelines successfully started running 1 pipeline(s).

HarshaNalluru · 2022-02-28T21:08:13Z

/azp run js - ai-form-recognizer - tests-weekly

azure-pipelines · 2022-02-28T21:08:27Z

Azure Pipelines successfully started running 1 pipeline(s).

HarshaNalluru · 2022-02-28T22:48:15Z

/azp run js - ai-form-recognizer - tests-weekly

ghost · 2022-10-21T10:03:29Z

Hi @HarshaNalluru. Thank you for your interest in helping to improve the Azure SDK experience and for your contribution. We've noticed that there hasn't been recent engagement on this pull request. If this is still an active work stream, please let us know by pushing some changes or leaving a comment. Otherwise, we'll close this out in 7 days.

ghost · 2022-12-23T10:03:45Z

Hi @HarshaNalluru. Thank you for your interest in helping to improve the Azure SDK experience and for your contribution. We've noticed that there hasn't been recent engagement on this pull request. If this is still an active work stream, please let us know by pushing some changes or leaving a comment. Otherwise, we'll close this out in 7 days.

…u/azure-sdk-for-js into harshan/issue/19442

… harshan/issue/19442

azure-sdk · 2023-02-02T02:47:25Z

API change check

APIView has identified API level changes in this PR and created following API reviews.

azure-ai-form-recognizer
azure-ai-form-recognizer

… harshan/issue/19442

HarshaNalluru · 2023-02-03T02:18:12Z

/azp run js - ai-form-recognizer - tests-weekly

azure-pipelines · 2023-02-03T02:18:25Z

Azure Pipelines successfully started running 1 pipeline(s).

…shaNalluru/azure-sdk-for-js into harshan/issue/19442

ghost · 2023-04-07T10:03:21Z

Hi @HarshaNalluru. Thank you for your interest in helping to improve the Azure SDK experience and for your contribution. We've noticed that there hasn't been recent engagement on this pull request. If this is still an active work stream, please let us know by pushing some changes or leaving a comment. Otherwise, we'll close this out in 7 days.

github-actions · 2023-06-16T05:03:27Z

Hi @HarshaNalluru. Thank you for your interest in helping to improve the Azure SDK experience and for your contribution. We've noticed that there hasn't been recent engagement on this pull request. If this is still an active work stream, please let us know by pushing some changes or leaving a comment. Otherwise, we'll close this out in 7 days.

github-actions · 2023-06-23T08:36:17Z

Hi @HarshaNalluru. Thank you for your contribution. Since there hasn't been recent engagement, we're going to close this out. Feel free to respond with a comment containing /reopen if you'd like to continue working on these changes. Please be sure to use the command to reopen or remove the no-recent-activity label; otherwise, this is likely to be closed again with the next cleanup pass.

Sovereign cloulds support

c01f303

ghost added the Cognitive - Form Recognizer label Feb 24, 2022

HarshaNalluru changed the title ~~Sovereign cloulds support~~ Sovereign clouds support Feb 24, 2022

ramya-rao-a reviewed Feb 24, 2022

View reviewed changes

HarshaNalluru commented Feb 24, 2022

View reviewed changes

sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md Outdated Show resolved Hide resolved

HarshaNalluru added 3 commits February 24, 2022 12:09

Update sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md

1e224f2

SupportedClouds: 'Public,UsGov,China'

6fb733c

Merge branch 'harshan/issue/19442' of https://github.com/HarshaNallur…

4b60789

…u/azure-sdk-for-js into harshan/issue/19442

remove location

1396d04

benbp reviewed Feb 28, 2022

View reviewed changes

subscription().subscriptionId

e5bfacc

HarshaNalluru changed the title ~~Sovereign clouds support~~ [Form Recognizer] Sovereign clouds support Feb 28, 2022

function getAudience(): KnownFormRecognizerAudience

31d73e0

tests.yml update

0a2fd3f

HarshaNalluru removed the no-recent-activity There has been no recent activity on this issue. label Oct 21, 2022

ghost added the no-recent-activity There has been no recent activity on this issue. label Dec 23, 2022

HarshaNalluru removed the no-recent-activity There has been no recent activity on this issue. label Dec 25, 2022

HarshaNalluru added 2 commits February 1, 2023 03:15

chnages

51efcf7

Merge branch 'harshan/issue/19442' of https://github.com/HarshaNallur…

d22872a

…u/azure-sdk-for-js into harshan/issue/19442

HarshaNalluru requested review from mikeharder and ckairen as code owners February 1, 2023 03:16

HarshaNalluru added 3 commits February 1, 2023 03:43

merge main

4929132

Merge branch 'main' of https://github.com/Azure/azure-sdk-for-js into…

764c398

… harshan/issue/19442

fix build

014da41

Merge branch 'main' of https://github.com/Azure/azure-sdk-for-js into…

acf524d

… harshan/issue/19442

HarshaNalluru added 5 commits February 3, 2023 03:41

custom forms test

cde7237

pdf file stream

89f473b

recordings

143ae75

w2-single.png

5326004

Merge branch 'harshan/fix-FR-test-failures' of https://github.com/Har…

baee1b6

…shaNalluru/azure-sdk-for-js into harshan/issue/19442

ghost added the no-recent-activity There has been no recent activity on this issue. label Apr 7, 2023

HarshaNalluru removed the no-recent-activity There has been no recent activity on this issue. label Apr 13, 2023

github-actions bot added the no-recent-activity There has been no recent activity on this issue. label Jun 16, 2023

github-actions bot closed this Jun 23, 2023

This was referenced May 6, 2024

[Form Recognizer]It will return error when use documentAnalysisClient with AAD authentication to run integration tests on UsGov cloud and China cloud #29480

Open

[Document Intelligence] Sovereign cloud support #29593

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Form Recognizer] Sovereign clouds support #20522

[Form Recognizer] Sovereign clouds support #20522

HarshaNalluru commented Feb 24, 2022 •

edited

Loading

HarshaNalluru commented Feb 24, 2022

azure-pipelines bot commented Feb 24, 2022

ramya-rao-a Feb 24, 2022

HarshaNalluru Feb 24, 2022 •

edited

Loading

HarshaNalluru Feb 24, 2022 •

edited

Loading

ramya-rao-a Feb 24, 2022

HarshaNalluru Feb 24, 2022

jeremymeng Feb 28, 2022

HarshaNalluru commented Feb 28, 2022

azure-pipelines bot commented Feb 28, 2022

HarshaNalluru commented Feb 28, 2022

azure-pipelines bot commented Feb 28, 2022

HarshaNalluru commented Feb 28, 2022

azure-pipelines bot commented Feb 28, 2022

benbp Feb 28, 2022

HarshaNalluru Feb 28, 2022

benbp Mar 3, 2022

HarshaNalluru commented Feb 28, 2022 •

edited

Loading

azure-pipelines bot commented Feb 28, 2022

HarshaNalluru commented Feb 28, 2022

azure-pipelines bot commented Feb 28, 2022

HarshaNalluru commented Feb 28, 2022

azure-pipelines bot commented Feb 28, 2022

HarshaNalluru commented Feb 28, 2022

ghost commented Oct 21, 2022

ghost commented Dec 23, 2022

azure-sdk commented Feb 2, 2023

HarshaNalluru commented Feb 3, 2023

azure-pipelines bot commented Feb 3, 2023

ghost commented Apr 7, 2023

github-actions bot commented Jun 16, 2023

github-actions bot commented Jun 23, 2023

	/**
	* Gets or sets the audience to use for authentication with Azure Active Directory.
	* The authentication scope will be set from this audience.
	* See {@link KnownContainerRegistryAudience} for known audience values.
	*/
	audience?: string;

[Form Recognizer] Sovereign clouds support #20522

[Form Recognizer] Sovereign clouds support #20522

Conversation

HarshaNalluru commented Feb 24, 2022 • edited Loading

Packages impacted by this PR

Issues associated with this PR

Describe the problem that is addressed by this PR

What are the possible designs available to address the problem? If there are more than one possible design, why was the one in this PR chosen?

Provide a list of related PRs/issues

Are there test cases added in this PR? (If not, why?)

Checklists

HarshaNalluru commented Feb 24, 2022

azure-pipelines bot commented Feb 24, 2022

ramya-rao-a Feb 24, 2022

Choose a reason for hiding this comment

HarshaNalluru Feb 24, 2022 • edited Loading

Choose a reason for hiding this comment

HarshaNalluru Feb 24, 2022 • edited Loading

Choose a reason for hiding this comment

ramya-rao-a Feb 24, 2022

Choose a reason for hiding this comment

HarshaNalluru Feb 24, 2022

Choose a reason for hiding this comment

jeremymeng Feb 28, 2022

Choose a reason for hiding this comment

HarshaNalluru commented Feb 28, 2022

azure-pipelines bot commented Feb 28, 2022

HarshaNalluru commented Feb 28, 2022

azure-pipelines bot commented Feb 28, 2022

HarshaNalluru commented Feb 28, 2022

azure-pipelines bot commented Feb 28, 2022

benbp Feb 28, 2022

Choose a reason for hiding this comment

HarshaNalluru Feb 28, 2022

Choose a reason for hiding this comment

benbp Mar 3, 2022

Choose a reason for hiding this comment

HarshaNalluru commented Feb 28, 2022 • edited Loading

azure-pipelines bot commented Feb 28, 2022

HarshaNalluru commented Feb 28, 2022

azure-pipelines bot commented Feb 28, 2022

HarshaNalluru commented Feb 28, 2022

azure-pipelines bot commented Feb 28, 2022

HarshaNalluru commented Feb 28, 2022

ghost commented Oct 21, 2022

ghost commented Dec 23, 2022

azure-sdk commented Feb 2, 2023

HarshaNalluru commented Feb 3, 2023

azure-pipelines bot commented Feb 3, 2023

ghost commented Apr 7, 2023

github-actions bot commented Jun 16, 2023

github-actions bot commented Jun 23, 2023

HarshaNalluru commented Feb 24, 2022 •

edited

Loading

HarshaNalluru Feb 24, 2022 •

edited

Loading

HarshaNalluru Feb 24, 2022 •

edited

Loading

HarshaNalluru commented Feb 28, 2022 •

edited

Loading