Skip to content

Adding a new storage property #31537

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

DiaaFathalla
Copy link

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.

Copy link

openapi-pipeline-app bot commented Nov 13, 2024

Next Steps to Merge

Next steps that must be taken to merge this PR:
  • ❌ This is the public specs repo main branch which is not intended for iterative development.
    You must acknowledge that you understand that after this PR is merged, you won't be able to stop your changes from being published to Azure customers.
    If this is what you intend, add PublishToCustomers label to your PR.
    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

Copy link

openapi-pipeline-app bot commented Nov 13, 2024

Generated ApiView

Language Package Name ApiView Link
Go sdk/resourcemanager/storage/armstorage There is no API change compared with the previous version
Java azure-resourcemanager-storage-generated https://apiview.dev/Assemblies/Review/e3b9b65cf4ba4648b875e20c6221602e?revisionId=084785d784ff4b238416012cf1d9afba
JavaScript @azure/arm-storage There is no API change compared with the previous version
.Net Azure.ResourceManager.Storage There is no API change compared with the previous version

@microsoft-github-policy-service microsoft-github-policy-service bot added customer-reported Issues that are reported by GitHub users external to the Azure organization. Storage Storage Service (Queues, Blobs, Files) labels Nov 13, 2024
@AzureRestAPISpecReview AzureRestAPISpecReview added ARMReview resource-manager WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Nov 13, 2024
@azure-sdk
Copy link
Collaborator

API change check

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

Microsoft.Storage

@DiaaFathalla
Copy link
Author

DiaaFathalla commented Nov 13, 2024 via email

@@ -3075,6 +3075,10 @@
"$ref": "#/definitions/ActiveDirectoryProperties",
"description": "Required if directoryServiceOptions are AD, optional if they are AADKERB."
},
"smbOAuthSettings": {
Copy link
Member

@blueww blueww Nov 14, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please:

  1. add swagger example (or update existing one) to cover this change. (Create/update/get)
  2. Is there any region ready to test this new property? Any Feature flag registry needed? Please make sure the server is ready for the feature to be public release.
  3. Is there any limitation on this new property, like does it work with all kind/sku of storage accounts. Does it work with all options of "directoryServiceOptions"? If so, please add it to the description.

Copy link
Member

@blueww blueww left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's another SRP API version "2024-01-01" swagger PR in review:
#31466

Would you like to merge the changes into same PR if they would like to release on same API version.
If not, we should first make the lower API version in, and the higher API version should copy from the latest API version, then add the change.
If this feature is not really ready to be public release, this swagger change should raise to private repo https://github.com/Azure/azure-rest-api-specs-pr to review, instead or public repo here.

@razvanbadea-msft
Copy link
Member

/azp run

Copy link

Azure Pipelines successfully started running 3 pipeline(s).

@razvanbadea-msft
Copy link
Member

    "isSmbOAuthEnabled": {

Replace boolean/switch properties with a more meaningful enum whenever possible.
A boolean will forever have two valid values (true or false). A string enum type is always preferred. Also, properties should always provide better values just than True and False. For example two switches "isTypeA" and "isTypeB" should be replaced with one enum "type": [A, B, DefaultType].


Refers to: specification/storage/resource-manager/Microsoft.Storage/stable/2025-01-01/storage.json:3104 in 5630a6f. [](commit_id = 5630a6f, deletion_comment = False)

@razvanbadea-msft razvanbadea-msft added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Nov 14, 2024
@openapi-pipeline-app openapi-pipeline-app bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Nov 14, 2024
@razvanbadea-msft
Copy link
Member

Choose a PR Template description and add a description to this pr to have the Purpose of PR and due diligence sections added

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review ARMReview customer-reported Issues that are reported by GitHub users external to the Azure organization. new-api-version resource-manager Storage Storage Service (Queues, Blobs, Files)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants