AIO 2507 preview #33810

nonsocode · 2025-04-08T23:31:09Z

Choose a PR Template

Switch to "Preview" on this description then select one of the choices below.

Click here to open a PR for a Data Plane API.

Click here to open a PR for a Control Plane (ARM) API.

Click here to open a PR for only SDK configuration.

openapi-pipeline-app · 2025-04-08T23:31:13Z

Next Steps to Merge

Next steps that must be taken to merge this PR:

❌ This PR targets either the main branch of the public specs repo or the RPSaaSMaster branch of the private specs repo. These branches are not intended for iterative development. Therefore, you must acknowledge you understand that after this PR is merged, the APIs are considered shipped to Azure customers. Any further attempts at in-place modifications to the APIs will be subject to Azure's versioning and breaking change policies. Additionally, for control plane APIs, you must acknowledge that you are following all the best practices documented by ARM at aka.ms/armapibestpractices. If you do intend to release the APIs to your customers by merging this PR, add the PublishToCustomers label to your PR in acknowledgement of the above. Otherwise, retarget this PR onto a feature branch, i.e. with prefix release- (see aka.ms/azsdk/api-versions#release--branches).
❌ This PR is in purview of the ARM review (label: ARMReview). This PR must get ARMSignedOff label from an ARM reviewer.
This PR has ARMChangesRequested label. Please address or respond to feedback from the ARM API reviewer.
When you are ready to continue the ARM API review, please remove the ARMChangesRequested label.
Automation should then add WaitForARMFeedback label.
❗If you don't have permissions to remove the label, request write access per aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories.
For details of the ARM review, see aka.ms/azsdk/pr-arm-review
❌ The required check named Automated merging requirements met has failed. This is the final check that must pass. Refer to the check in the PR's 'Checks' tab for details on how to fix it and consult the aka.ms/ci-fix guide. In addition, refer to step 4 in the PR workflow diagram

openapi-pipeline-app · 2025-04-08T23:31:13Z

PR validation pipeline restarted successfully. If there is ApiView generated, it will be updated in this comment.

github-actions · 2025-04-08T23:34:22Z

API Change Check

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

Language	API Review for Package
Swagger	Microsoft.IoTOperations
TypeSpec	Microsoft.IoTOperations

TimLovellSmith · 2025-05-14T19:47:26Z

Can you please fix the PR description

TimLovellSmith · 2025-05-14T19:58:25Z

...agement/examples/2025-07-01-preview/AkriConnectorTemplate_CreateOrUpdate_MaximumSet_Gen.json

+          {
+            "endpointType": "chkkpymxhp",
+            "version": "chkkpymxhp",
+            "configurationSchemaRefs": {


why call it configurationSchemaRefs instead of just configurationSchemas?

@abhipsaMisra Would it make more sense to call this configurationSchema? all contained properties have ref in their name

TimLovellSmith · 2025-05-14T19:58:52Z

...agement/examples/2025-07-01-preview/AkriConnectorTemplate_CreateOrUpdate_MaximumSet_Gen.json

+    "resource": {
+      "properties": {
+        "aioMetadata": {
+          "aioMinVersion": "tkiz",


more realistic values would make for better docs right

Yes they will be better. I'll update with real examples

TimLovellSmith · 2025-05-14T20:01:45Z

specification/iotoperations/IoTOperations.Management/models/akri/common.tsp

+  registrySettingsType: RegistryEndpointRef;
+
+  /** The name of the registry endpoint. */
+  registryEndpointRef: string;


I wonder why call it a registeryEndpointRef and not just registryEndpoint? Why is it a 'name of'? In what sense is the name going to be dereferenced?

ref is a convention we use when making reference to kubernetes resource names.

TimLovellSmith · 2025-05-14T20:02:22Z

specification/iotoperations/IoTOperations.Management/models/akri/common.tsp

+@added(Versions.`2025-07-01-preview`)
+model AkriConnectorsSecret {
+  /** The key in the secret to be mounted. */
+  secretKey: string;


Wondering: does this need to be annotated as @secret or something? So that its x-ms-secret in the open api spec?

Is this a secret value as I'm imagining?

No, this isn't a secret in that sense. This is a property in a kubernetes secret. It's akin to the name of an azure secret in a keyvault

TimLovellSmith · 2025-05-14T20:04:59Z

specification/iotoperations/IoTOperations.Management/models/broker/authentications.tsp

+
+@doc("X509 Certificate Authentication properties.")
+model X509ManualCertificate {
+  @doc("Kubernetes secret containing an X.509 client certificate. This is a reference to the secret through an identifying name, not the secret itself.")


a secret where?

This is a kubernetes secret name. This is not the secret content.

TimLovellSmith · 2025-05-14T20:09:02Z

specification/iotoperations/cspell.yaml

@@ -19,6 +19,10 @@ words:
  - mqtt
  - otlp
  - populator
+  - azurecr


considered using less abbreviated 'azure container registry' or other stylings azureCR or azure_cr instead?

TimLovellSmith · 2025-05-14T20:10:34Z

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

@@ -54,10 +53,25 @@ model InstanceProperties {
  @doc("The reference to the Schema Registry for this AIO Instance.")
  schemaRegistryRef: SchemaRegistryRef;

+  @doc("The reference to the AIO Secret provider class.")
+  @added(Versions.`2025-07-01-preview`)
+  defaultSecretProviderClassRef?: SecretProviderClassRef;


Putting 'classRef' in the name seems quite confusing to me.
What's easier to understand. "I configure my default secret provider", or "I configure my default secret provider class ref"?
Is the distinction really something that matters to customers?

TimLovellSmith · 2025-05-14T20:11:47Z

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

+
+  @doc("The Azure Device Registry Namespace used by Assets, Discovered Assets and devices")
+  @added(Versions.`2025-07-01-preview`)
+  adrNamespaceRef?: AzureDeviceRegistryNamespaceRef;


more naming comments: why not call it an 'azureDeviceRegistryNamespace'?

[aside: generally these naming comments are optional to address... opinion based feedback, right, ymmv]

TimLovellSmith · 2025-05-14T20:12:32Z

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

+@added(Versions.`2025-07-01-preview`)
+model DataflowGraphDestinationNodeSettings {
+  /** The endpoint reference for the destination. */
+  endpointRef: string;


Could perhaps use a fuller documentation of how it is an 'endpointRef' as opposed to an endpoint (or uri??).

huguesBouvier · 2025-05-16T21:38:25Z

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

@@ -39,6 +39,10 @@ model DataflowProperties {
  @doc("Mode for Dataflow. Optional; defaults to Enabled.")
  mode?: OperationalMode = Enabled;

+  @doc("Disk persistence mode.")
+  @added(Versions.`2025-07-01-preview`)
+  requestDiskPersistence?: OperationalMode;


thank you!!!

azure-sdk mentioned this pull request Apr 8, 2025

[AutoPR sdk/resourcemanager/iotoperations/armiotoperations] AIO 2507 preview azure-sdk/azure-sdk-for-go#13934

Draft

AzureRestAPISpecReview added resource-manager RPaaS TypeSpec Authored with TypeSpec labels Apr 8, 2025

AzureRestAPISpecReview added the BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required label Apr 24, 2025

azure-sdk mentioned this pull request Apr 24, 2025

[AutoPR default] AIO 2507 preview azure-sdk/azure-sdk-for-js#15244

Draft

nonsocode force-pushed the nchukwuogor/aio-2507-preview branch from 1771157 to 3329e48 Compare April 24, 2025 03:24

AzureRestAPISpecReview added SuppressionReviewRequired and removed BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required labels Apr 24, 2025

nonsocode added 15 commits April 27, 2025 22:02

readme

cbfcd17

preview examples

117ed27

examples

f6afd40

mq

2933c1a

almost done with persistence

310ad2b

finish broker changes

f662461

secretProviderClassReff

bb256f7

linted

3b52a2c

skynet

1990b0e

dataflowEndpoint types

18064f5

spaes

a8b6479

adr namespaces

0cf322a

Otel endpoint

075cb8f

diagnostics

3bb0860

namespace

491d26f

nonsocode added 3 commits May 12, 2025 22:50

configmap

90de675

persitence vicbility

4185b10

make it optional

f56e10b

AzureRestAPISpecReview added the BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required label May 13, 2025

nonsocode marked this pull request as ready for review May 14, 2025 16:05

AzureRestAPISpecReview added ARMReview new-api-version NotReadyForARMReview ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test labels May 14, 2025

JeffreyRichter added the BreakingChange-Approved-UserImpact Changes are not backward compatible and may cause customer disruption. label May 14, 2025

fix op mode

8995aa5

AzureRestAPISpecReview added WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required and removed NotReadyForARMReview labels May 14, 2025

TimLovellSmith added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label May 14, 2025

openapi-pipeline-app bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label May 14, 2025

TimLovellSmith reviewed May 14, 2025

View reviewed changes

nonsocode added 4 commits May 14, 2025 23:34

dataflowGraphs polymorphism

2b32233

Fix go client

bf34c6e

dataflow persistence

b65ce7a

description

8c1fe57

huguesBouvier reviewed May 16, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

AIO 2507 preview #33810

AIO 2507 preview #33810

nonsocode commented Apr 8, 2025

openapi-pipeline-app bot commented Apr 8, 2025 •

edited

Loading

openapi-pipeline-app bot commented Apr 8, 2025 •

edited

Loading

github-actions bot commented Apr 8, 2025 •

edited

Loading

TimLovellSmith commented May 14, 2025

TimLovellSmith May 14, 2025

nonsocode May 15, 2025

TimLovellSmith May 14, 2025

nonsocode May 14, 2025 •

edited

Loading

TimLovellSmith May 14, 2025

nonsocode May 15, 2025

TimLovellSmith May 14, 2025 •

edited

Loading

nonsocode May 15, 2025

TimLovellSmith May 14, 2025

nonsocode May 15, 2025

TimLovellSmith May 14, 2025

TimLovellSmith May 14, 2025

TimLovellSmith May 14, 2025

TimLovellSmith May 14, 2025

huguesBouvier May 16, 2025

AIO 2507 preview #33810

Are you sure you want to change the base?

AIO 2507 preview #33810

Conversation

nonsocode commented Apr 8, 2025

Choose a PR Template

openapi-pipeline-app bot commented Apr 8, 2025 • edited Loading

Next Steps to Merge

openapi-pipeline-app bot commented Apr 8, 2025 • edited Loading

github-actions bot commented Apr 8, 2025 • edited Loading

API Change Check

TimLovellSmith commented May 14, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nonsocode May 14, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TimLovellSmith May 14, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

openapi-pipeline-app bot commented Apr 8, 2025 •

edited

Loading

openapi-pipeline-app bot commented Apr 8, 2025 •

edited

Loading

github-actions bot commented Apr 8, 2025 •

edited

Loading

nonsocode May 14, 2025 •

edited

Loading

TimLovellSmith May 14, 2025 •

edited

Loading