azure-rest-api-specs
azure-rest-api-specs copied to clipboard
Azure Relay - added missing publicNetworkAccess at NetwrokRuleSet level
ARM API Information (Control Plane)
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow. Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.
Changelog
Add a changelog entry for this PR by answering the following questions:
- 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
- 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.
- When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
- By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.
Contribution checklist (MS Employees Only):
- [ ] I commit to follow the Breaking Change Policy of "no breaking changes"
- [ ] I have reviewed the documentation for the workflow.
- [ ] Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Applicability: :warning:
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 apply 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 copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For 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 you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.
NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)
Please follow the link to find more details on PR review process.
Hi, @SudeshnaB1902 Thanks for your PR. I am workflow bot for review process. Here are some small tips.
Swagger Validation Report
️🔄
BreakingChange inProgress [Detail]
️🔄
Breaking Change(Cross-Version) inProgress [Detail]
️⌛
CredScan pending [Detail]
️🔄
LintDiff inProgress [Detail]
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️🔄
ApiReadinessCheck inProgress [Detail]
️🔄
~[Staging] ServiceAPIReadinessTest inProgress [Detail]
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️⌛
PoliCheck pending [Detail]
️🔄
SDK Track2 Validation inProgress [Detail]
️️✔️
PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️
SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️⌛
Lint(RPaaS) pending [Detail]
️⌛
CadlValidation pending [Detail]
️⌛
PR Summary pending [Detail]
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-python-track2 - track2_azure-mgmt-relay - 1.1.0+ Model ErrorResponse no longer has parameter code + Model ErrorResponse no longer has parameter message
❌
azure-sdk-for-js - @azure/arm-eventhub - 6.0.0+ Deleted Class EventHubManagementClient + Enum KnownSkuName no longer has value Basic + Enum KnownSkuName no longer has value Premium + Enum KnownSkuTier no longer has value Basic + Enum KnownSkuTier no longer has value Premium + Interface AccessKeys no longer has parameter aliasPrimaryConnectionString + Interface AccessKeys no longer has parameter aliasSecondaryConnectionString + Interface Sku no longer has parameter capacity + Operation Namespaces.beginCreateOrUpdate has a new signature + Operation Namespaces.beginCreateOrUpdateAndWait has a new signature + Operation Namespaces.checkNameAvailability has a new signature + Operation Namespaces.update has a new signature + Operation PrivateLinkResources.get has a new signature + Removed Enum KnownClusterSkuName + Removed Enum KnownPublicNetworkAccessFlag + Removed Enum KnownSchemaCompatibility + Removed Enum KnownSchemaType + Removed operation Namespaces.listNetworkRuleSet + Removed operation group Clusters + Removed operation group Configuration + Removed operation group ConsumerGroups + Removed operation group DisasterRecoveryConfigs + Removed operation group EventHubs + Removed operation group SchemaRegistry
❌
azure-sdk-for-js - @azure/arm-relay - 4.0.0+ Interface ErrorResponse no longer has parameter code + Interface ErrorResponse no longer has parameter message
️️✔️
azure-sdk-for-net-track2 succeeded [Detail] [Expand]
️✔️
Succeeded [Logs]Release - Generate from 591b17c5a50e7fc0ef09211197279e6d9f7ebc22. SDK Automation 14.0.0command pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json warn File azure-sdk-for-net_tmp/initOutput.json not found to read command pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
️✔️
Azure.ResourceManager.Relay [View full logs] [Release SDK Changes]info [Changelog]
️⚠️
azure-sdk-for-python-track2 warning [Detail]
⚠️
Warning [Logs]Release - Generate from 591b17c5a50e7fc0ef09211197279e6d9f7ebc22. SDK Automation 14.0.0command sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json cmderr [automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed. command sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
️✔️
track2_azure-mgmt-relay [View full logs] [Release SDK Changes] Breaking Change Detectedinfo [Changelog] ### Features Added info [Changelog] info [Changelog] - Added operation NamespacesOperations.create_or_update_network_rule_set info [Changelog] - Added operation NamespacesOperations.get_network_rule_set info [Changelog] - Added operation group PrivateEndpointConnectionsOperations info [Changelog] - Added operation group PrivateLinkResourcesOperations info [Changelog] - Model AuthorizationRule has a new parameter location info [Changelog] - Model AuthorizationRule has a new parameter system_data info [Changelog] - Model ErrorResponse has a new parameter error info [Changelog] - Model HybridConnection has a new parameter location info [Changelog] - Model HybridConnection has a new parameter system_data info [Changelog] - Model Operation has a new parameter is_data_action info [Changelog] - Model Operation has a new parameter origin info [Changelog] - Model Operation has a new parameter properties info [Changelog] - Model OperationDisplay has a new parameter description info [Changelog] - Model RelayNamespace has a new parameter private_endpoint_connections info [Changelog] - Model RelayNamespace has a new parameter public_network_access info [Changelog] - Model RelayNamespace has a new parameter status info [Changelog] - Model RelayNamespace has a new parameter system_data info [Changelog] - Model RelayUpdateParameters has a new parameter private_endpoint_connections info [Changelog] - Model RelayUpdateParameters has a new parameter public_network_access info [Changelog] - Model RelayUpdateParameters has a new parameter status info [Changelog] - Model WcfRelay has a new parameter location info [Changelog] - Model WcfRelay has a new parameter system_data info [Changelog] info [Changelog] ### Breaking Changes info [Changelog] info [Changelog] - Model ErrorResponse no longer has parameter code info [Changelog] - Model ErrorResponse no longer has parameter message
️️✔️
azure-sdk-for-java succeeded [Detail] [Expand]
️✔️
Succeeded [Logs]Release - Generate from 591b17c5a50e7fc0ef09211197279e6d9f7ebc22. SDK Automation 14.0.0command ./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
️✔️
azure-resourcemanager-relay [View full logs] [Release SDK Changes]
️️✔️
azure-sdk-for-go succeeded [Detail] [Expand]
️✔️
Succeeded [Logs]Release - Generate from 591b17c5a50e7fc0ef09211197279e6d9f7ebc22. SDK Automation 14.0.0command 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
️✔️
sdk/resourcemanager/relay/armrelay [View full logs] [Release SDK Changes]info [Changelog] ### Features Added info [Changelog] info [Changelog] - New field `PublicNetworkAccess` in struct `NetworkRuleSetProperties` info [Changelog] info [Changelog] Total 0 breaking change(s), 1 additive change(s).
️️✔️
azure-sdk-for-js succeeded [Detail] [Expand]
️✔️
Succeeded [Logs]Release - Generate from 591b17c5a50e7fc0ef09211197279e6d9f7ebc22. SDK Automation 14.0.0command sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json 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-relay [View full logs] [Release SDK Changes] Breaking Change Detectedinfo [Changelog] **Features** info [Changelog] info [Changelog] - Added operation group PrivateEndpointConnections info [Changelog] - Added operation group PrivateLinkResources info [Changelog] - Added operation Namespaces.createOrUpdateNetworkRuleSet info [Changelog] - Added operation Namespaces.getNetworkRuleSet info [Changelog] - Added Interface ConnectionState info [Changelog] - Added Interface ErrorAdditionalInfo info [Changelog] - Added Interface ErrorDetail info [Changelog] - Added Interface NamespacesCreateOrUpdateNetworkRuleSetOptionalParams info [Changelog] - Added Interface NamespacesGetNetworkRuleSetOptionalParams info [Changelog] - Added Interface NetworkRuleSet info [Changelog] - Added Interface NWRuleSetIpRules info [Changelog] - Added Interface PrivateEndpoint info [Changelog] - Added Interface PrivateEndpointConnection info [Changelog] - Added Interface PrivateEndpointConnectionListResult info [Changelog] - Added Interface PrivateEndpointConnectionsCreateOrUpdateOptionalParams info [Changelog] - Added Interface PrivateEndpointConnectionsDeleteOptionalParams info [Changelog] - Added Interface PrivateEndpointConnectionsGetOptionalParams info [Changelog] - Added Interface PrivateEndpointConnectionsListNextOptionalParams info [Changelog] - Added Interface PrivateEndpointConnectionsListOptionalParams info [Changelog] - Added Interface PrivateLinkResource info [Changelog] - Added Interface PrivateLinkResourcesGetOptionalParams info [Changelog] - Added Interface PrivateLinkResourcesListOptionalParams info [Changelog] - Added Interface PrivateLinkResourcesListResult info [Changelog] - Added Interface ProxyResource info [Changelog] - Added Interface SystemData info [Changelog] - Added Type Alias CreatedByType info [Changelog] - Added Type Alias DefaultAction info [Changelog] - Added Type Alias EndPointProvisioningState info [Changelog] - Added Type Alias NamespacesCreateOrUpdateNetworkRuleSetResponse info [Changelog] - Added Type Alias NamespacesGetNetworkRuleSetResponse info [Changelog] - Added Type Alias NetworkRuleIPAction info [Changelog] - Added Type Alias PrivateEndpointConnectionsCreateOrUpdateResponse info [Changelog] - Added Type Alias PrivateEndpointConnectionsGetResponse info [Changelog] - Added Type Alias PrivateEndpointConnectionsListNextResponse info [Changelog] - Added Type Alias PrivateEndpointConnectionsListResponse info [Changelog] - Added Type Alias PrivateLinkConnectionStatus info [Changelog] - Added Type Alias PrivateLinkResourcesGetResponse info [Changelog] - Added Type Alias PrivateLinkResourcesListResponse info [Changelog] - Added Type Alias PublicNetworkAccess info [Changelog] - Added Type Alias SkuName info [Changelog] - Added Type Alias SkuTier info [Changelog] - Interface AuthorizationRule has a new optional parameter systemData info [Changelog] - Interface ErrorResponse has a new optional parameter error info [Changelog] - Interface HybridConnection has a new optional parameter systemData info [Changelog] - Interface Operation has a new optional parameter isDataAction info [Changelog] - Interface Operation has a new optional parameter origin info [Changelog] - Interface Operation has a new optional parameter properties info [Changelog] - Interface OperationDisplay has a new optional parameter description info [Changelog] - Interface RelayNamespace has a new optional parameter privateEndpointConnections info [Changelog] - Interface RelayNamespace has a new optional parameter publicNetworkAccess info [Changelog] - Interface RelayNamespace has a new optional parameter status info [Changelog] - Interface RelayNamespace has a new optional parameter systemData info [Changelog] - Interface RelayUpdateParameters has a new optional parameter privateEndpointConnections info [Changelog] - Interface RelayUpdateParameters has a new optional parameter publicNetworkAccess info [Changelog] - Interface RelayUpdateParameters has a new optional parameter status info [Changelog] - Interface WcfRelay has a new optional parameter systemData info [Changelog] - Class RelayAPI has a new parameter privateEndpointConnections info [Changelog] - Class RelayAPI has a new parameter privateLinkResources info [Changelog] - Added Enum KnownAccessRights info [Changelog] - Added Enum KnownCreatedByType info [Changelog] - Added Enum KnownDefaultAction info [Changelog] - Added Enum KnownEndPointProvisioningState info [Changelog] - Added Enum KnownKeyType info [Changelog] - Added Enum KnownNetworkRuleIPAction info [Changelog] - Added Enum KnownPrivateLinkConnectionStatus info [Changelog] - Added Enum KnownPublicNetworkAccess info [Changelog] - Added Enum KnownSkuName info [Changelog] - Added Enum KnownSkuTier info [Changelog] - Added Enum KnownUnavailableReason info [Changelog] info [Changelog] **Breaking Changes** info [Changelog] info [Changelog] - Interface ErrorResponse no longer has parameter code info [Changelog] - Interface ErrorResponse no longer has parameter message
️⚠️
azure-resource-manager-schemas warning [Detail]
⚠️
Warning [Logs]Release - Generate from 591b17c5a50e7fc0ef09211197279e6d9f7ebc22. Schema Automation 14.0.0command .sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json cmderr [initScript.sh] 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
️✔️
relay [View full logs] [Release Schema Changes]
️️✔️
azure-powershell succeeded [Detail] [Expand]
️✔️
Succeeded [Logs]Release - Generate from 591b17c5a50e7fc0ef09211197279e6d9f7ebc22. SDK Automation 14.0.0command 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.RelayApi [View full logs] [Release SDK Changes]
Generated ApiView
Language | Package Name | ApiView Link |
---|---|---|
Go | sdk/resourcemanager/relay/armrelay | Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI. |
Python | track2_azure-mgmt-relay | Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI. |
Java | azure-resourcemanager-relay | Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI. |
.Net | Azure.ResourceManager.Relay | Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI. |
JavaScript | @azure/arm-relay | Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI. |
Thank you for your contribution SudeshnaB1902! We will review the pull request and get back to you soon.
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.
Hi @SudeshnaB1902, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff
. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.
Task | How to fix | Priority |
---|---|---|
Avocado | Fix-Avocado | High |
Semantic validation | Fix-SemanticValidation-Error | High |
Model validation | Fix-ModelValidation-Error | High |
LintDiff | Fix-LintDiff | high |
/azp run
Azure Pipelines successfully started running 1 pipeline(s).
/azp run
Azure Pipelines successfully started running 1 pipeline(s).
Hi team, please remember to remove this property from the /Namespace documentation on next link https://learn.microsoft.com/en-us/azure/templates/microsoft.relay/namespaces?pivots=deployment-language-bicep and leave it only under the Namespaces/NetworkRuleSet/ Thanks!
Swagger Validation Report
️❌
BreakingChange: 1 Errors, 0 Warnings failed [Detail]
compared swaggers (via Oad v0.10.1)] | new version | base version |
---|---|---|
2021-11-01 | 2021-11-01(07058fa) | 2021-11-01(main) |
Rule | Message |
---|---|
1041 - AddedPropertyInResponse |
The new version has a new property 'publicNetworkAccess' in response that was not found in the old version. New: Microsoft.Relay/stable/2021-11-01/NetworkRuleSets.json#L162:11 Old: Microsoft.Relay/stable/2021-11-01/NetworkRuleSets.json#L162:11 |
️️✔️
Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️
LintDiff: 0 Warnings warning [Detail]
compared tags (via openapi-validator v1.13.0) | new version | base version |
---|---|---|
package-2021-11 | package-2021-11(07058fa) | package-2021-11(main) |
The following errors/warnings exist before current PR submission:
Rule | Message |
---|---|
R4037 - MissingTypeObject |
The schema 'OperationListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Relay/stable/2021-11-01/operations.json#L78 |
:warning: R3018 - EnumInsteadOfBoolean | Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDataAction Location: Microsoft.Relay/stable/2021-11-01/operations.json#L106 |
:warning: R4006 - DeprecatedXmsCodeGenerationSetting | The x-ms-code-generation-setting extension is being deprecated. Please remove it and move settings to readme file for code generation. Location: Microsoft.Relay/stable/2021-11-01/NetworkRuleSets.json#L7 |
:warning: R4006 - DeprecatedXmsCodeGenerationSetting | The x-ms-code-generation-setting extension is being deprecated. Please remove it and move settings to readme file for code generation. Location: Microsoft.Relay/stable/2021-11-01/operations.json#L7 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
ApiReadinessCheck succeeded [Detail] [Expand]
️⚠️
~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️
PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️
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).
️️✔️
CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️
PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
@microsoft-github-policy-service agree [company="Microsoft"]
@microsoft-github-policy-service agree company="Microsoft"
/azp run
Azure Pipelines successfully started running 1 pipeline(s).
Hi @live1206 , can you please review the PR? SDK breaking changes are expected and we are okay with these changes.