Add Managed Identity Support to Azure Communication Services #24022

jorge-beauregard · 2023-05-16T23:10:05Z

ARM API Information (Control Plane)

Changelog

Add a changelog entry for this PR by answering the following questions:

What's the purpose of the update?
- new service onboarding
- new API version
- update existing version for new feature
- update existing version to fix swagger quality issue in s360
- Other, please clarify
When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.

Contribution checklist (MS Employees Only):

I commit to follow the Breaking Change Policy of "no breaking changes"
I have reviewed the documentation for the workflow.
Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Applicability: ⚠️

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

Change to data plane APIs

Adding new properties

All removals

Otherwise your PR may be subject to ARM review requirements. Complete the following:

Check this box if any of the following apply to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
- Adding a new service
- Adding new API(s)
- Adding a new API version
  -[x] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki. Note that this doesn't apply if you are trying to merge a PR that was previously in the private repository.
Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.

Breaking Change Review Checklist

If you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.

NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)

Please follow the link to find more details on PR review process.

fix #24032

openapi-workflow-bot · 2023-05-16T23:10:08Z

Hi, @jorge-beauregard Thanks for your PR. I am workflow bot for review process. Here are some small tips.

Please ensure to do self-check against checklists in first PR comment.

PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.

For specs comparison cross API versions, Use API Specs Comparison Report Generator

If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com

openapi-workflow-bot · 2023-05-16T23:10:10Z

Hi, @jorge-beauregard your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com).

openapi-pipeline-app · 2023-05-16T23:10:11Z

Swagger pipeline started successfully, please wait for status update in this comment.

openapi-pipeline-app · 2023-05-23T20:04:38Z

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]

There are no breaking changes.

️⚠️Breaking Change(Cross-Version): 8 Warnings warning [Detail]

compared swaggers (via Oad v0.10.4)]	new version	base version
CommunicationServices.json	2023-04-01-preview(fb882d3)	2023-03-31(main)
CommunicationServices.json	2023-04-01-preview(fb882d3)	2023-03-01-preview(main)
Domains.json	2023-04-01-preview(fb882d3)	2023-03-31(main)
Domains.json	2023-04-01-preview(fb882d3)	2023-03-01-preview(main)
EmailServices.json	2023-04-01-preview(fb882d3)	2023-03-31(main)
EmailServices.json	2023-04-01-preview(fb882d3)	2023-03-01-preview(main)
SenderUsernames.json	2023-04-01-preview(fb882d3)	2023-03-31(main)
SenderUsernames.json	2023-04-01-preview(fb882d3)	2023-03-01-preview(main)

The following breaking changes are detected by comparison with the latest preview version:

Rule	Message
⚠️ 1036 - ConstraintChanged	The new version has a different 'pattern' value than the previous one. New: Microsoft.Communication/preview/2023-04-01-preview/CommunicationServices.json#L133:9 Old: Microsoft.Communication/preview/2023-03-01-preview/CommunicationServices.json#L133:9
⚠️ 1036 - ConstraintChanged	The new version has a different 'pattern' value than the previous one. New: Microsoft.Communication/preview/2023-04-01-preview/CommunicationServices.json#L279:9 Old: Microsoft.Communication/preview/2023-03-01-preview/CommunicationServices.json#L279:9
⚠️ 1036 - ConstraintChanged	The new version has a different 'pattern' value than the previous one. New: Microsoft.Communication/preview/2023-04-01-preview/CommunicationServices.json#L344:9 Old: Microsoft.Communication/preview/2023-03-01-preview/CommunicationServices.json#L332:9
⚠️ 1036 - ConstraintChanged	The new version has a different 'pattern' value than the previous one. New: Microsoft.Communication/preview/2023-04-01-preview/CommunicationServices.json#L388:9 Old: Microsoft.Communication/preview/2023-03-01-preview/CommunicationServices.json#L376:9
⚠️ 1036 - ConstraintChanged	The new version has a different 'pattern' value than the previous one. New: Microsoft.Communication/preview/2023-04-01-preview/CommunicationServices.json#L463:9 Old: Microsoft.Communication/preview/2023-03-01-preview/CommunicationServices.json#L448:9
⚠️ 1036 - ConstraintChanged	The new version has a different 'pattern' value than the previous one. New: Microsoft.Communication/preview/2023-04-01-preview/CommunicationServices.json#L519:9 Old: Microsoft.Communication/preview/2023-03-01-preview/CommunicationServices.json#L504:9
⚠️ 1036 - ConstraintChanged	The new version has a different 'pattern' value than the previous one. New: Microsoft.Communication/preview/2023-04-01-preview/CommunicationServices.json#L565:9 Old: Microsoft.Communication/preview/2023-03-01-preview/CommunicationServices.json#L550:9
⚠️ 1036 - ConstraintChanged	The new version has a different 'pattern' value than the previous one. New: Microsoft.Communication/preview/2023-04-01-preview/CommunicationServices.json#L849:5 Old: Microsoft.Communication/preview/2023-03-01-preview/CommunicationServices.json#L828:5

️️✔️CredScan succeeded [Detail] [Expand]

There is no credential detected.

️⚠️LintDiff: 0 Warnings warning [Detail]

compared tags (via openapi-validator v2.1.2)	new version	base version
package-preview-2023-04	package-preview-2023-04(fb882d3)	default(main)

The following errors/warnings exist before current PR submission:

Rule	Message
⚠️ AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Communication/preview/2023-04-01-preview/Domains.json#L588
⚠️ AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Communication/preview/2023-04-01-preview/Domains.json#L610

️️✔️Avocado succeeded [Detail] [Expand]

Validation passes for Avocado.

️️✔️ApiReadinessCheck succeeded [Detail] [Expand]

️❌~[Staging] ServiceAPIReadinessTest: 0 Errors, 0 Warnings failed [Detail]

Tag package-preview-2023-04; Prod region: Not deployed; Canary region: Not deployed

️️✔️SwaggerAPIView succeeded [Detail] [Expand]

️️✔️CadlAPIView succeeded [Detail] [Expand]

️️✔️TypeSpecAPIView succeeded [Detail] [Expand]

️️✔️ModelValidation succeeded [Detail] [Expand]

Validation passes for ModelValidation.

️️✔️SemanticValidation succeeded [Detail] [Expand]

Validation passes for SemanticValidation.

️️✔️PoliCheck succeeded [Detail] [Expand]

Validation passed for PoliCheck.

️️✔️PrettierCheck succeeded [Detail] [Expand]

Validation passes for PrettierCheck.

️️✔️SpellCheck succeeded [Detail] [Expand]

Validation passes for SpellCheck.

️️✔️Lint(RPaaS) succeeded [Detail] [Expand]

Validation passes for Lint(RPaaS).

️️✔️CadlValidation succeeded [Detail] [Expand]

Validation passes for CadlValidation.

️️✔️TypeSpec Validation succeeded [Detail] [Expand]

Validation passes for TypeSpec Validation.

️️✔️PR Summary succeeded [Detail] [Expand]

Validation passes for Summary.

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2023-05-23T20:04:38Z

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]

 Please click here to preview with your @microsoft account.

️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

Breaking Changes Tracking

️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from e79a5aa. SDK Automation 14.0.0

command	pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json
command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json

️✔️Azure.ResourceManager.Communication [View full logs] [Release SDK Changes]
- Azure.ResourceManager.Communication.1.2.0-alpha.20230531.1.nupkg
```
info	[Changelog]
```

️⚠️ azure-sdk-for-python-track2 warning [Detail]

⚠️Warning [Logs]Release - Generate from e79a5aa. SDK Automation 14.0.0

command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
cmderr	[automation_generate.sh]
cmderr	[automation_generate.sh] npm notice New minor version of npm available! 9.5.1 -> 9.6.7
cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.6.7>
cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@9.6.7` to update!
cmderr	[automation_generate.sh] npm notice

️✔️track2_azure-mgmt-communication [View full logs] [Release SDK Changes]
- azure-mgmt-communication-1.0.0.zip
- azure_mgmt_communication-1.0.0-py3-none-any.whl
```
info	[Changelog]
```

️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from e79a5aa. SDK Automation 14.0.0

command	sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
command	generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json

️✔️sdk/resourcemanager/communication/armcommunication [View full logs] [Release SDK Changes]

info	[Changelog] ### Other Changes
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 0 additive change(s).

️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from e79a5aa. SDK Automation 14.0.0

command	sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json
warn	File azure-sdk-for-js_tmp/initOutput.json not found to read
command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json
cmderr	[automation_generate.sh] [ERROR] Cannot generate changelog because the codes of local and npm may be the same.

️✔️@azure/arm-communication [View full logs] [Release SDK Changes]
- azure-arm-communication-4.0.1.tgz
```
info	[Changelog]
error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.
```

️⚠️ azure-sdk-for-java warning [Detail]

⚠️Warning [Logs]Release - Generate from e79a5aa. SDK Automation 14.0.0

command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.1.2
cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.1.2
cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json

️✔️azure-resourcemanager-communication [View full logs] [Release SDK Changes]

️❌ azure-powershell failed [Detail]

❌Pipeline Framework Failed [Logs]Release - Generate from e79a5aa. SDK Automation 14.0.0

command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
command	pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json
SSL error: syscall failure: Broken pipe
Error: SSL error: syscall failure: Broken pipe

️✔️Az.communication.DefaultTag [View full logs]

Az.CommunicationService.0.1.0.nupkg

error	Fatal error: SSL error: syscall failure: Broken pipe
error	The following packages are still pending:
error		Az.communication.DefaultTag

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2023-05-23T20:04:40Z

Generated ApiView

Language	Package Name	ApiView Link
Go	sdk/resourcemanager/communication/armcommunication	https://apiview.dev/Assemblies/Review/018cc4399d15461cac69e89d103a9219
.Net	Azure.ResourceManager.Communication	There is no API change compared with the previous version
Java	azure-resourcemanager-communication	There is no API change compared with the previous version
JavaScript	@azure/arm-communication	https://apiview.dev/Assemblies/Review/e1751e698c4f4238afe5d0b0d4097f33

openapi-workflow-bot · 2023-05-23T20:10:58Z

Hi @jorge-beauregard, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.

Task	How to fix	Priority
Avocado	Fix-Avocado	High
Semantic validation	Fix-SemanticValidation-Error	High
Model validation	Fix-ModelValidation-Error	High
LintDiff	Fix-LintDiff	high

If you need further help, please feedback via swagger feedback.

openapi-workflow-bot · 2023-05-23T20:10:58Z

Hi, @jorge-beauregard, For review efficiency consideration, when creating a new api version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki. Or you could onboard API spec pipeline

...on/preview/2023-04-01-preview/examples/communicationServices/updateRemoveSystemIdentity.json

jorge-beauregard added 2 commits May 16, 2023 15:53

Adding base version

f243562

Adding managed identity support

8001d0e

openapi-workflow-bot bot added ARMReview WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels May 16, 2023

openapi-assignment-bot bot assigned Wzb123456789 May 16, 2023

azure-sdk mentioned this pull request May 17, 2023

[IC3 ACS Resource Provider - Azure Communication Services] API Review #24032

Closed

raosuhas added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label May 18, 2023

openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label May 18, 2023

azure-sdk mentioned this pull request May 23, 2023

[AutoPR sdk/resourcemanager/communication/armcommunication] Add Managed Identity Support to Azure Communication Services azure-sdk/azure-sdk-for-go#5839

Closed

AzureRestAPISpecReview added CI-FixRequiredOnFailure CI-MissingBaseCommit new-api-version resource-manager RPaaS labels May 23, 2023

Joeleniqs reviewed May 23, 2023

View reviewed changes

...on/preview/2023-04-01-preview/examples/communicationServices/updateRemoveSystemIdentity.json Show resolved Hide resolved

jorge-beauregard force-pushed the jbeauregardb/communicationServicesManagedIdentitySupport branch 3 times, most recently from 829b20c to 6ed3910 Compare May 23, 2023 21:56

AzureRestAPISpecReview added ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test and removed CI-FixRequiredOnFailure labels May 23, 2023

jorge-beauregard force-pushed the jbeauregardb/communicationServicesManagedIdentitySupport branch from 6ed3910 to 50bb983 Compare May 26, 2023 18:25

Add more examples

fb882d3

jorge-beauregard force-pushed the jbeauregardb/communicationServicesManagedIdentitySupport branch from 50bb983 to fb882d3 Compare May 30, 2023 23:45

Wzb123456789 added the Approved-OkToMerge <valid label in PR review process>add this label when assignee approve to merge the updates label May 31, 2023

chunyu3 approved these changes May 31, 2023

View reviewed changes

chunyu3 merged commit e79a5aa into main May 31, 2023

chunyu3 deleted the jbeauregardb/communicationServicesManagedIdentitySupport branch May 31, 2023 02:39

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Managed Identity Support to Azure Communication Services #24022

Add Managed Identity Support to Azure Communication Services #24022

jorge-beauregard commented May 16, 2023 •

edited by azure-sdk

Loading

openapi-workflow-bot bot commented May 16, 2023

openapi-workflow-bot bot commented May 16, 2023

openapi-pipeline-app bot commented May 16, 2023

openapi-pipeline-app bot commented May 23, 2023 •

edited

Loading

openapi-pipeline-app bot commented May 23, 2023 •

edited

Loading

Breaking Changes Tracking

openapi-pipeline-app bot commented May 23, 2023 •

edited

Loading

openapi-workflow-bot bot commented May 23, 2023

openapi-workflow-bot bot commented May 23, 2023

Add Managed Identity Support to Azure Communication Services #24022

Add Managed Identity Support to Azure Communication Services #24022

Conversation

jorge-beauregard commented May 16, 2023 • edited by azure-sdk Loading

ARM API Information (Control Plane)

Changelog

Contribution checklist (MS Employees Only):

ARM API Review Checklist

Breaking Change Review Checklist

openapi-workflow-bot bot commented May 16, 2023

openapi-workflow-bot bot commented May 16, 2023

openapi-pipeline-app bot commented May 16, 2023

openapi-pipeline-app bot commented May 23, 2023 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented May 23, 2023 • edited Loading

Swagger Generation Artifacts

Breaking Changes Tracking

openapi-pipeline-app bot commented May 23, 2023 • edited Loading

Generated ApiView

openapi-workflow-bot bot commented May 23, 2023

openapi-workflow-bot bot commented May 23, 2023

jorge-beauregard commented May 16, 2023 •

edited by azure-sdk

Loading

openapi-pipeline-app bot commented May 23, 2023 •

edited

Loading

openapi-pipeline-app bot commented May 23, 2023 •

edited

Loading

openapi-pipeline-app bot commented May 23, 2023 •

edited

Loading