bring auth into props by hmmorales · Pull Request #30121 · Azure/azure-rest-api-specs

hmmorales · 2024-08-08T15:25:31Z

ARM (Control Plane) API Specification Update Pull Request

Tip

Overwhelmed by all this guidance? See the Getting help section at the bottom of this PR description.

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

Purpose of this PR

What's the purpose of this PR? Check the specific option that applies. This is mandatory!

New resource provider.
New API version for an existing resource provider. (If API spec is not defined in TypeSpec, the PR should have been created in adherence to OpenAPI specs PR creation guidance).
Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
Update existing version to fix OpenAPI spec quality issues in S360.
Convert existing OpenAPI spec to TypeSpec spec (do not combine this with implementing changes for a new API version).
Other, please clarify:
- edit this with your clarification

Due diligence checklist

To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:

I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
I have reviewed following Resource Provider guidelines, including
ARM resource provider contract and
REST guidelines (estimated time: 4 hours).
I understand this is required before I can proceed to the diagram Step 2, "ARM API changes review", for this PR.

Additional information

Viewing API changes

For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.

Suppressing failures

If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
suppressions guide to get approval.

Getting help

First, please carefully read through this PR description, from top to bottom. Please fill out the Purpose of this PR and Due diligence checklist.
If you don't have permissions to remove or add labels to the PR, request write access per aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories
To understand what you must do next to merge this PR, see the Next Steps to Merge comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.
For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure
and https://aka.ms/ci-fix.
For help with ARM review (PR workflow diagram Step 2), see https://aka.ms/azsdk/pr-arm-review.
If the PR CI checks appear to be stuck in queued state, please add a comment with contents /azp run.
This should result in a new comment denoting a PR validation pipeline has started and the checks should be updated after few minutes.
If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.

…es to each setting

openapi-pipeline-app · 2024-08-08T15:25:35Z

Next Steps to Merge

Next steps that must be taken to merge this PR:

❌ This PR is in purview of the ARM review (label: ARMReview). This PR must get ARMSignedOff label from an ARM reviewer.
This PR is awaiting ARM reviewer feedback (label: WaitForARMFeedback).
To learn when this PR will get reviewed, see ARM review queue at aka.ms/azsdk/pr-arm-review
For details of the ARM review, see aka.ms/azsdk/pr-arm-review

openapi-pipeline-app · 2024-08-08T15:25:36Z

Generated ApiView

Language	Package Name	ApiView Link
Swagger	Microsoft.IoTOperations	https://apiview.dev/Assemblies/Review/28a23a5dee3d4a07b5d4b256deb383d5?revisionId=2ca81173cdc4424295d0ecb6f129bae5
TypeSpec	IoTOperations.Management	https://apiview.dev/Assemblies/Review/0453fd959bbc4dbb9ee5a6266fb1ce29?revisionId=69378a88f1ab41cf9acb928e5b46ee20

specification/iotoperations/IoTOperations.Management/models/dataflows/dataflowEndpoints.tsp

specification/iotoperations/IoTOperations.Management/models/auth.tsp

specification/iotoperations/IoTOperations.Management/models/dataflows/dataflowEndpoints.tsp

…nsetting from onelake

openapi-pipeline-app · 2024-08-08T22:29:39Z

PR validation pipeline can not start as the pull request is not merged or mergeable - most likely it has merge conflicts.

…o-props

jlian · 2024-08-08T23:39:41Z

specification/iotoperations/IoTOperations.Management/models/dataflows/dataflowEndpoints.tsp

 @doc("Broker endpoint properties")
 model DataflowEndpointMqtt {
+  @doc("authentication properties. DEFAULT: kubernetes.audience=aio-mq-internal. NOTE - Enum field only property is allowed")
+  authentication?: DataflowEndpointMqttAuthentication = #{


Sorry, I think with this https://msazure.visualstudio.com/One/_workitems/edit/28622511 it means that authentication should always be required. Or, in the case for local storage, not present

jlian · 2024-08-08T23:40:09Z

specification/iotoperations/IoTOperations.Management/models/dataflows/dataflowEndpoints.tsp

+  serviceAccountTokenSettings?: DataflowEndpointAuthenticationServiceAccountToken;
+
+  @doc("X.509 certificate authentication.")
+  x509Settings?: DataflowEndpointAuthenticationX509;


I believe we agreed this should be x509CertificateSettings

https://msazure.visualstudio.com/One/_workitems/edit/28771593

* init PR * remove placeholder * Revert "remove placeholder" This reverts commit 8a31865. * init 2024-08-15-preview * enforce only latest version gets changed * remove placeholder * Release/0.7.0 preview (#30109) * Some changes * DataFlow -> Dataflow * More updates * Ran Henry's Build Tool * revert old examples * remaining files * Updating secret ref (#30113) * Release/0.7.0 preview (#30114) * Update schema registry ref based on review * More updates... * Schema Registry Regex * Update examples * identity update * Update examples * Update examples * Update examples * feat: Add support for Identity and service accounts in instance (#30127) * add readonly service account fields * sap * generate examples * bring auth into props (#30121) * changes to dataflowendpoint and auth to bring authentication properties to each setting * ran script * endpointType and revert for secretRef * clean up description, make authentication required, remove accesstokensetting from onelake * add auth to each method * scope down each auth method * scope down unions * remove general auth object * organization * ran tool * sasl to sat * ran examples * examples * service account x-ms-identifiers * examples * tsv * Add clientId (#30130) * Add clientId * ... * Rm @disciminator (#30131) * Bring back examples (#30132) * add example file back (#30134) * Make auth required (#30136) * make auth required in mqtt and kafka methods * rename certificatesettings * examples * feat: add flags for aio services (#30135) * commit flags * commit examples * Merge upstream * examples * examples (#30139) * spell check * spellcheck * feat: Add identity support to patch operation (#30145) * support_identity * lint * patch MI * should work * lint * Patch Fix & Update ClientId Doc (#30140) * fix * fix * patch fix and clientid fix * examples * tsv * x509CertificateSettings in BrokerAuth (#30146) * fix: revert brokerauth x509 changes (#30149) * Add examples for Broker (#30152) * Add Broker examples * Fix typo * Better listener example * fix up examples and remove example gen (#30171) * Remove reference to orchestrator * chore: Feedback from 8/9 (#30187) * Audience, SecretRef, TLS * CloudEventAttributeType * x509 * update schema * PR feedback * schema update * key as well * remove MQ disable/enable * bring back broker * generate schema * format * make props read-only * remove mq * schema update * make togles read write * schema update * use mode flags * new line * switch to state * state * Add dataflow examples (#30192) * fix examples (#30195) * fix examples * fix * typo * instance examples * another typo * fix: Remove service accounts from instance (#30198) * remove Service accounts * update instance defintion * sync changes * fix: re-add Instance examples to (#30199) * remove Service accounts * update instance defintion * sync changes * examples * examples * update second example * Instance schema and example update * chore: Fix typos in Aio types (#30205) * fix: Rename secretName to secretRef (#30208) * suppression (#30209) * fix secretName (#30211) * fix: update examples (#30212) * update examples * push other examples * typo (#30213) * fix: Adressed half of the issues (#30216) * Adressed half * gen * model validation pass * model validation (#30218) * 201 (#30219) * fix * Model validation pass 4 (#30220) * update batching * example gen * Model validation pass 5 (#30221) * Revert "Model validation pass 4 (#30220)" This reverts commit d73c5c8. * ... * fix: lower case d (#30236) * fix: Lowercase d in dataflow * uncomment supression * supress path * schema * drill down * stop at identity * run gen --------- Co-authored-by: chgennar <56695749+chgennar@users.noreply.github.com> Co-authored-by: Chinonso Chukwuogor <nonsochukwuogor@gmail.com> Co-authored-by: John Lian <jlian@users.noreply.github.com>

hmmorales added 2 commits August 8, 2024 08:21

changes to dataflowendpoint and auth to bring authentication properti…

1afc824

…es to each setting

ran script

472c91a

chgennar reviewed Aug 8, 2024

View reviewed changes

specification/iotoperations/IoTOperations.Management/models/dataflows/dataflowEndpoints.tsp Show resolved Hide resolved

chgennar reviewed Aug 8, 2024

View reviewed changes

specification/iotoperations/IoTOperations.Management/models/auth.tsp Show resolved Hide resolved

AzureRestAPISpecReview added ARMReview resource-manager RPaaS TypeSpec Authored with TypeSpec WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Aug 8, 2024

endpointType and revert for secretRef

edf001a

jlian reviewed Aug 8, 2024

View reviewed changes

hmmorales added 9 commits August 8, 2024 10:04

clean up description, make authentication required, remove accesstoke…

5a569f3

…nsetting from onelake

add auth to each method

f27a7b5

scope down each auth method

3389e12

scope down unions

3f98fa6

remove general auth object

25e0e16

organization

53fe49b

ran tool

a2f032c

sasl to sat

93de7e0

ran examples

2e8afef

hmmorales added 5 commits August 8, 2024 15:32

Merge branch 'release/0.7.0-preview' into henrymorales/bring-auth-int…

726b1a8

…o-props

examples

f28290b

service account x-ms-identifiers

0f0635d

examples

f3b6bf5

tsv

e568fa7

hmmorales changed the title ~~Henrymorales/bring auth into props~~ bring auth into props Aug 8, 2024

hmmorales merged commit 13e30a7 into release/0.7.0-preview Aug 8, 2024

hmmorales deleted the henrymorales/bring-auth-into-props branch August 8, 2024 22:41

jlian reviewed Aug 8, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

bring auth into props#30121

bring auth into props#30121
hmmorales merged 17 commits intorelease/0.7.0-previewfrom
henrymorales/bring-auth-into-props

hmmorales commented Aug 8, 2024

Uh oh!

openapi-pipeline-app bot commented Aug 8, 2024 •

edited

Loading

Uh oh!

openapi-pipeline-app bot commented Aug 8, 2024 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

openapi-pipeline-app bot commented Aug 8, 2024

Uh oh!

jlian Aug 8, 2024

Uh oh!

jlian Aug 8, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

hmmorales commented Aug 8, 2024

ARM (Control Plane) API Specification Update Pull Request

PR review workflow diagram

Purpose of this PR

Due diligence checklist

Additional information

Getting help

Uh oh!

openapi-pipeline-app bot commented Aug 8, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Next Steps to Merge

Uh oh!

openapi-pipeline-app bot commented Aug 8, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Generated ApiView

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

openapi-pipeline-app bot commented Aug 8, 2024

Uh oh!

jlian Aug 8, 2024

Choose a reason for hiding this comment

Uh oh!

jlian Aug 8, 2024

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

openapi-pipeline-app bot commented Aug 8, 2024 •

edited

Loading

openapi-pipeline-app bot commented Aug 8, 2024 •

edited

Loading