Azure / azure-rest-api-specs

The source for REST API specifications for Microsoft Azure.
MIT License
2.68k stars 5.11k forks source link

noahdavis Microsoft.AzureDataTransfer add new API spec 2024-09-27 for FMV #30756

Closed noahdavis-msft closed 1 month ago

noahdavis-msft commented 1 month ago

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.

spec_pr_review_workflow_diagram

Purpose of this PR

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

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:

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](https://aka.ms/azsdk/pr-suppressions) to get approval.

Getting help

openapi-pipeline-app[bot] commented 1 month ago

Next Steps to Merge

✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge.
openapi-pipeline-app[bot] commented 1 month ago

Generated ApiView

Language Package Name ApiView Link
Go sdk/resourcemanager/azuredatatransfer/armazuredatatransfer https://apiview.dev/Assemblies/Review/f0af8a39e91a4e0bae753b1f193ebeba?revisionId=073a3f0550a04d268fbb8b89924d5bfb
JavaScript @azure/arm-azuredatatransfer https://apiview.dev/Assemblies/Review/3bda0c569a4b426698e685e51c964728?revisionId=0c76b61b9fad44c0aa17d745bd503e9b
Java azure-resourcemanager-azuredatatransfer https://apiview.dev/Assemblies/Review/ecacad7845014c9081d89e8b2c9ec77d?revisionId=d3684473aab74dc79da910121898fe31
Swagger Microsoft.AzureDataTransfer https://apiview.dev/Assemblies/Review/28cada1a3c144c83b5a5e51d82207629?revisionId=28d7b46929054fd6b615660cb76b9c13
noahdavis-msft commented 1 month ago

@microsoft-github-policy-service agree company="Microsoft"

noahdavis-msft commented 1 month ago

@microsoft-github-policy-service agree company="Microsoft"

ms-bogdan-rotaru commented 1 month ago

Please be aware that Breaking Change(Cross-Version) check is failing. Also, please check the errors reported by the other required checks.

noahdavis-msft commented 1 month ago

-Hello, I'm not sure what the LintDiff or azure-sdk-for-go are alerting on. Please advise. Thank you.-

noahdavis-msft commented 1 month ago

/azp run

azure-pipelines[bot] commented 1 month ago
Azure Pipelines successfully started running 3 pipeline(s).
rkmanda commented 1 month ago
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}/setPassphrase": {

why are these not being modelled as a patch on the flow object instead?


Refers to: specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/azuredatatransfer.json:505 in 7bb4271. [](commit_id = 7bb4271f362c9e7ae75728630f24664a50ad9766, deletion_comment = False)

noahdavis-msft commented 1 month ago
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}/setPassphrase": {

why are these not being modelled as a patch on the flow object instead?

Refers to: specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/azuredatatransfer.json:505 in 7bb4271. [](commit_id = 7bb4271, deletion_comment = False)

Most of these values are customer-provided non-Azure endpoints, addresses, ports, and secrets. Think in a datacenter or office building. Our organization considers these as secrets, and therefor does not store them in the Flow object, but we do store them in KeyVaults behind the scenes.

While the set methods can be replaced with patch operations, the gets cannot. For uniformity and clarity to our partner teams we opt'd to create getter/setter methods for both.

noahdavis-msft commented 1 month ago

/azp run

azure-pipelines[bot] commented 1 month ago
Azure Pipelines successfully started running 3 pipeline(s).