Skip to content
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

Service Bus : Added Missing publicNetworkAccess property #19059

Merged
merged 1 commit into from
May 17, 2022

Conversation

v-Ajnava
Copy link
Member

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Changelog

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

  1. 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
      -added missing publicNetworkAccess property
  2. 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.
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
  4. If updating an existing version, please select the specific language SDKs and CLIs that must be refreshed after the swagger is published.
    • SDK of .NET (need service team to ensure code readiness)
    • SDK of Python
    • SDK of Java
    • SDK of Js
    • SDK of Go
    • PowerShell
    • CLI
    • Terraform
    • No refresh required for updates in this PR

Contribution checklist:

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 appy 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
      -[ ] To review changes efficiently, ensure you are using OpenAPIHub to initialize the PR for adding a new version. More details, refer to the wiki.
  • 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 any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.

  • Removing API(s) in a stable version
  • Removing properties in a stable version
  • Removing API version(s) in a stable version
  • Updating API in a stable or public preview version with Breaking Change Validation errors
  • Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

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

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

@openapi-workflow-bot
Copy link

Hi, @v-Ajnava 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-pipeline-app
    Copy link

    openapi-pipeline-app bot commented May 13, 2022

    Swagger Validation Report

    ️❌BreakingChange: 2 Errors, 0 Warnings failed [Detail]
    Rule Message
    1041 - AddedPropertyInResponse The new version has a new property 'publicNetworkAccess' in response that was not found in the old version.
    New: Microsoft.ServiceBus/preview/2022-01-01-preview/namespace-preview.json#L688:7
    Old: Microsoft.ServiceBus/preview/2022-01-01-preview/namespace-preview.json#L688:7
    1045 - AddedOptionalProperty The new version has a new optional property 'publicNetworkAccess' that was not found in the old version.
    New: Microsoft.ServiceBus/preview/2022-01-01-preview/namespace-preview.json#L688:7
    Old: Microsoft.ServiceBus/preview/2022-01-01-preview/namespace-preview.json#L688:7
    ️⚠️LintDiff: 0 Warnings warning [Detail]
    The following errors/warnings exist before current PR submission:
    Rule Message
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.ServiceBus/preview/2022-01-01-preview/namespace-preview.json#L935
    ⚠️ R1003 - ListInOperationName Since operation 'PrivateLinkResources_Get' response has model definition 'array', it should be of the form '_list'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.ServiceBus/preview/2022-01-01-preview/namespace-preview.json#L552
    ⚠️ R2007 - LongRunningOperationsWithLongRunningExtension The operation 'Namespaces_Update' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation.
    Location: Microsoft.ServiceBus/preview/2022-01-01-preview/namespace-preview.json#L281
    ⚠️ R2029 - PageableOperation Based on the response model schema, operation 'PrivateLinkResources_Get' might be pageable. Consider adding the x-ms-pageable extension.
    Location: Microsoft.ServiceBus/preview/2022-01-01-preview/namespace-preview.json#L548
    ⚠️ R3010 - TrackedResourceListByImmediateParent The child tracked resource, 'privateEndpointConnections' with immediate parent 'SBNamespace', must have a list by immediate parent operation.
    Location: Microsoft.ServiceBus/preview/2022-01-01-preview/namespace-preview.json#L983
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: zoneRedundant
    Location: Microsoft.ServiceBus/preview/2022-01-01-preview/namespace-preview.json#L734
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: disableLocalAuth
    Location: Microsoft.ServiceBus/preview/2022-01-01-preview/namespace-preview.json#L753
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: disableLocalAuth
    Location: Microsoft.ServiceBus/preview/2022-01-01-preview/namespace-preview.json#L824
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: requireInfrastructureEncryption
    Location: Microsoft.ServiceBus/preview/2022-01-01-preview/namespace-preview.json#L955
    ⚠️ R4021 - DescriptionAndTitleMissing 'groupId' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
    Location: Microsoft.ServiceBus/preview/2022-01-01-preview/namespace-preview.json#L1112
    ⚠️ R4021 - DescriptionAndTitleMissing 'userAssignedIdentityProperties' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
    Location: Microsoft.ServiceBus/preview/2022-01-01-preview/namespace-preview.json#L1148
    ⚠️ R4030 - UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: NameSpaceCreate
    Location: Microsoft.ServiceBus/preview/2022-01-01-preview/namespace-preview.json#L346
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️️✔️PoliCheck succeeded [Detail] [Expand]
    Validation passed for PoliCheck.
    ️️✔️SDK Track2 Validation succeeded [Detail] [Expand]
    Validation passes for SDKTrack2Validation

    ️️✔️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).
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented May 13, 2022

    Swagger Generation Artifacts

    ️️✔️ApiDocPreview succeeded [Detail] [Expand]
     Please click here to preview with your @microsoft account. 
    ️❌SDK Breaking Change Tracking failed [Detail]

    Breaking Changes Tracking

    ️✔️azure-sdk-for-go - servicebus/mgmt/2017-04-01/servicebus - v64.0.0
    ️✔️azure-sdk-for-go - servicebus/mgmt/2015-08-01/servicebus - v64.0.0
    ️✔️azure-sdk-for-go - preview/servicebus/mgmt/2021-06-01-preview/servicebus - v64.0.0
    ️✔️azure-sdk-for-go - preview/servicebus/mgmt/2018-01-01-preview/servicebus - v64.0.0
    ️✔️azure-sdk-for-python-track2 - track2_azure-mgmt-servicebus - 7.1.0
    azure-sdk-for-go-track2 - armservicebus - 0.6.0
    ️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 634d614. 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
      command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
      cmderr	[generate.py] SLF4J: Failed to load class "org.slf4j.impl.StaticLoggerBinder".
      cmderr	[generate.py] SLF4J: Defaulting to no-operation (NOP) logger implementation
      cmderr	[generate.py] SLF4J: See http://www.slf4j.org/codes.html#StaticLoggerBinder for further details.
      cmderr	[generate.py] SLF4J: Failed to load class "org.slf4j.impl.StaticLoggerBinder".
      cmderr	[generate.py] SLF4J: Defaulting to no-operation (NOP) logger implementation
      cmderr	[generate.py] SLF4J: See http://www.slf4j.org/codes.html#StaticLoggerBinder for further details.
    • ️✔️azure-resourcemanager-servicebus-generated [View full logs]  [Release SDK Changes]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 634d614. SDK Automation 14.0.0
      command	sh ./eng/initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
      command	generator automation ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
    • ️✔️servicebus/mgmt/2017-04-01/servicebus [View full logs]  [Release SDK Changes]
      info	[Changelog] ### Other Changes
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 0 additive change(s).
    • ️✔️servicebus/mgmt/2015-08-01/servicebus [View full logs
      info	[Changelog] ### Other Changes
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 0 additive change(s).
    • ️✔️preview/servicebus/mgmt/2021-06-01-preview/servicebus [View full logs
      info	[Changelog] ### Other Changes
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 0 additive change(s).
    • ️✔️preview/servicebus/mgmt/2018-01-01-preview/servicebus [View full logs
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog] - New function `NewNetworkRuleSetListResultPage(NetworkRuleSetListResult, func(context.Context, NetworkRuleSetListResult) (NetworkRuleSetListResult, error)) NetworkRuleSetListResultPage`
      info	[Changelog] - New function `NetworkRuleSetListResultIterator.Response() NetworkRuleSetListResult`
      info	[Changelog] - New function `NewNetworkRuleSetListResultIterator(NetworkRuleSetListResultPage) NetworkRuleSetListResultIterator`
      info	[Changelog] - New function `NetworkRuleSetListResultIterator.Value() NetworkRuleSet`
      info	[Changelog] - New function `NetworkRuleSetListResultPage.Response() NetworkRuleSetListResult`
      info	[Changelog] - New function `NamespacesClient.ListNetworkRuleSetsResponder(*http.Response) (NetworkRuleSetListResult, error)`
      info	[Changelog] - New function `*NetworkRuleSetListResultPage.Next() error`
      info	[Changelog] - New function `NetworkRuleSetListResultPage.NotDone() bool`
      info	[Changelog] - New function `NamespacesClient.ListNetworkRuleSetsSender(*http.Request) (*http.Response, error)`
      info	[Changelog] - New function `NetworkRuleSetListResultIterator.NotDone() bool`
      info	[Changelog] - New function `NetworkRuleSetListResultPage.Values() []NetworkRuleSet`
      info	[Changelog] - New function `*NetworkRuleSetListResultIterator.NextWithContext(context.Context) error`
      info	[Changelog] - New function `*NetworkRuleSetListResultPage.NextWithContext(context.Context) error`
      info	[Changelog] - New function `NetworkRuleSetListResult.IsEmpty() bool`
      info	[Changelog] - New function `*NetworkRuleSetListResultIterator.Next() error`
      info	[Changelog] - New function `NamespacesClient.ListNetworkRuleSetsPreparer(context.Context, string, string) (*http.Request, error)`
      info	[Changelog] - New function `NamespacesClient.ListNetworkRuleSetsComplete(context.Context, string, string) (NetworkRuleSetListResultIterator, error)`
      info	[Changelog] - New function `NamespacesClient.ListNetworkRuleSets(context.Context, string, string) (NetworkRuleSetListResultPage, error)`
      info	[Changelog] - New struct `NetworkRuleSetListResult`
      info	[Changelog] - New struct `NetworkRuleSetListResultIterator`
      info	[Changelog] - New struct `NetworkRuleSetListResultPage`
      info	[Changelog] - New field `Status` in struct `SBNamespaceProperties`
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 25 additive change(s).
    ️️✔️ azure-sdk-for-go-track2 succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 634d614. 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
    • ️✔️armservicebus [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 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 634d614. 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
      cmderr	[automation_init.sh] deprecated read-package-tree@5.1.6: The functionality that this package provided is now in @npmcli/arborist
      cmderr	[automation_init.sh]  uuid@3.4.0: Please upgrade  to version 7 or higher.  Older versions may use Math.random() in certain circumstances, which is known to be problematic.  See https://v8.dev/blog/math-random for details.
      cmderr	[automation_init.sh] deprecated @opentelemetry/types@0.2.0: Package renamed to @opentelemetry/api, see https://github.com/open-telemetry/opentelemetry-js
      cmderr	[automation_init.sh] deprecated @azure/storage-blob@10.5.0: This version has been deprecated, please upgrade to the version tagged as latest
      cmderr	[automation_init.sh] npm WARN @octokit/plugin-request-log@1.0.4 requires a peer of @octokit/core@>=3 but none is installed. You must install peer dependencies yourself.
      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
    • ️✔️@azure/arm-servicebus [View full logs]  [Release SDK Changes]
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Added Type Alias KeySource
      info	[Changelog]   - Added Type Alias PublicNetworkAccess
      info	[Changelog]   - Added Type Alias TlsVersion
      info	[Changelog]   - Type Alias SBNamespace has a new parameter minimumTlsVersion
      info	[Changelog]   - Type Alias SBNamespace has a new parameter publicNetworkAccess
      info	[Changelog]   - Added Enum KnownAccessRights
      info	[Changelog]   - Added Enum KnownFilterType
      info	[Changelog]   - Added Enum KnownKeySource
      info	[Changelog]   - Added Enum KnownKeyType
      info	[Changelog]   - Added Enum KnownManagedServiceIdentityType
      info	[Changelog]   - Added Enum KnownProvisioningStateDR
      info	[Changelog]   - Added Enum KnownPublicNetworkAccess
      info	[Changelog]   - Added Enum KnownRoleDisasterRecovery
      info	[Changelog]   - Added Enum KnownSkuName
      info	[Changelog]   - Added Enum KnownSkuTier
      info	[Changelog]   - Added Enum KnownTlsVersion
      info	[Changelog]   - Added Enum KnownUnavailableReason
      error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 634d614. Schema Automation 14.0.0
      command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
      cmderr	[initScript.sh]  old lockfile
      cmderr	[initScript.sh] npm WARN old lockfile The package-lock.json file was created with an old version of npm,
      cmderr	[initScript.sh] npm WARN old lockfile so supplemental metadata must be fetched from the registry.
      cmderr	[initScript.sh] npm WARN old lockfile
      cmderr	[initScript.sh] npm WARN old lockfile This is a one-time fix-up, please be patient...
      cmderr	[initScript.sh] npm WARN old lockfile
      warn	File azure-resource-manager-schemas_tmp/initOutput.json not found to read
      command	.sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json
    • ️✔️servicebus [View full logs]  [Release Schema Changes]
    ️️✔️ azure-powershell succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 634d614. 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
    • ️✔️Az.ServiceBus [View full logs]  [Release SDK Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

    NewApiVersionRequired reason:

    A service’s API is a contract with customers and is represented by using the api-version query parameter. Changes such as adding an optional property to a request/response or introducing a new operation is a change to the service’s contract and therefore requires a new api-version value. This is critically important for documentation, client libraries, and customer support.

    EXAMPLE: if a customer calls a service in the public cloud using api-version=2020-07-27, the new property or operation may exist but if they call the service in a government cloud, air-gapped cloud, or Azure Stack Hub cloud using the same api-version, the property or operation may not exist. Because there is no clear relationship between the service api-version and the new property/operation, customers can’t trust the documentation and Azure customer have difficulty helping customers diagnose issues. In addition, each client library version documents the service version it supports. When an optional property or new operation is added to a service and its Swagger, new client libraries must be produced to expose this functionality to customers. Without updating the api-version, it is unclear to customers which version of a client library supports these new features.

    @v-Ajnava
    Copy link
    Member Author

    Hi @weidongxu-microsoft, can you please review the PR.
    we recently have merged new API version swagger - 2022-01-01-preview and we miss one property in the namespace.
    we have not published any clients for the new API version.

    @openapi-workflow-bot
    Copy link

    Hi @v-Ajnava, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review.
    Action: To initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
    If you want to know the production traffic statistic, please see ARM Traffic statistic.
    If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback.

    @weidongxu-microsoft
    Copy link
    Member

    weidongxu-microsoft commented May 13, 2022

    @v-Ajnava

    I've added breaking changes review request. Please see above bot comment on how to proceed.

    If this is a very recent api-verison, you can mention the date of that merge (and no SDK released) to review board.

    I am not authorized to approve or merge, until breaking changes review board approved it.

    @v-Ajnava
    Copy link
    Member Author

    @v-Ajnava

    I've added breaking changes review request. Please see above bot comment on how to proceed.

    If this is a very recent api-verison, you can mention the date of that merge (and not SDK released) to review board.

    I am not authorized to approve or merge, until breaking changes review board approved it.

    Thanks for quick replay, sure will proceed as per the process.

    @JeffreyRichter JeffreyRichter added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label May 16, 2022
    @v-Ajnava
    Copy link
    Member Author

    Hi @weidongxu-microsoft, breaking changes are approved, can you please review the PR?

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    3 participants