Add new properties for email/sms rules to access rule API. #22000

manishrw · 2022-12-28T07:26:13Z

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: ⚠️

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.

openapi-workflow-bot · 2022-12-28T07:26:15Z

Hi, @manishrw 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 · 2022-12-28T07:26:17Z

Swagger Validation Report

️❌BreakingChange: 4 Errors, 0 Warnings failed [Detail]

compared swaggers (via Oad v0.10.4)]	new version	base version
networkSecurityPerimeter.json	2021-02-01-preview(efc3584)	2021-02-01-preview(main)

Rule	Message
`❌` 1041 - AddedPropertyInResponse	The new version has a new property 'emailAddresses' in response that was not found in the old version. New: Microsoft.Network/preview/2021-02-01-preview/networkSecurityPerimeter.json#L1484:7 Old: Microsoft.Network/preview/2021-02-01-preview/networkSecurityPerimeter.json#L1484:7
`❌` 1041 - AddedPropertyInResponse	The new version has a new property 'phoneNumbers' in response that was not found in the old version. New: Microsoft.Network/preview/2021-02-01-preview/networkSecurityPerimeter.json#L1484:7 Old: Microsoft.Network/preview/2021-02-01-preview/networkSecurityPerimeter.json#L1484:7
`❌` 1045 - AddedOptionalProperty	The new version has a new optional property 'emailAddresses' that was not found in the old version. New: Microsoft.Network/preview/2021-02-01-preview/networkSecurityPerimeter.json#L1484:7 Old: Microsoft.Network/preview/2021-02-01-preview/networkSecurityPerimeter.json#L1484:7
`❌` 1045 - AddedOptionalProperty	The new version has a new optional property 'phoneNumbers' that was not found in the old version. New: Microsoft.Network/preview/2021-02-01-preview/networkSecurityPerimeter.json#L1484:7 Old: Microsoft.Network/preview/2021-02-01-preview/networkSecurityPerimeter.json#L1484:7

️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️CredScan succeeded [Detail] [Expand]

There is no credential detected.

️️✔️LintDiff succeeded [Detail] [Expand]

Validation passes for LintDiff.

compared tags (via openapi-validator v2.0.0)	new version	base version
package-2021-02-preview	package-2021-02-preview(efc3584)	package-2021-02-preview(main)

️️✔️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.

️❌~[Staging] SwaggerAPIView: 0 Errors, 0 Warnings failed [Detail]

️️✔️~[Staging] CadlAPIView succeeded [Detail] [Expand]

️️✔️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.

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2022-12-28T07:26:18Z

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 - sdk/resourcemanager/network/armnetwork - Approved - 3.0.0

+	Type of `BastionActiveSession.StartTime` has been changed from `interface{}` to `any`

️❌ azure-sdk-for-net failed [Detail]

❌Code Generator Failed [Logs]Release - Generate from 18e83e2. SDK Automation 14.0.0

warn	Skip initScript due to not configured
command	sudo apt-get install -y dotnet-sdk-6.0
command	autorest --version=2.0.4421 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.csharp@2.3.82 --csharp-sdks-folder=/mnt/vss/_work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/network/resource-manager/readme.md
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied

❌Microsoft.Azure.Management.Network [View full logs] [Release SDK Changes]

cmderr	[msbuild] The command could not be loaded, possibly because:
cmderr	[msbuild]   * You intended to execute a .NET application:
cmderr	[msbuild]       The application 'msbuild' does not exist.
cmderr	[msbuild]   * You intended to execute a .NET SDK command:
cmderr	[msbuild]       A compatible .NET SDK was not found.
cmderr	[msbuild] Requested SDK version: 7.0.101
cmderr	[msbuild] global.json file: /mnt/vss/_work/1/s/azure-sdk-for-net/global.json
cmderr	[msbuild] Installed SDKs:
cmderr	[msbuild] Install the [7.0.101] .NET SDK or update [/mnt/vss/_work/1/s/azure-sdk-for-net/global.json] to match an installed SDK.
cmderr	[msbuild] Learn about SDK resolution:
cmderr	[msbuild] https://aka.ms/dotnet/sdk-not-found
error	Script return with result [failed] code [145] signal [null] cwd [azure-sdk-for-net]: dotnet

️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 18e83e2. SDK Automation 14.0.0

command	pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json
command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json

️✔️Azure.ResourceManager.Network [View full logs] [Release SDK Changes]
- Azure.ResourceManager.Network.1.2.0-alpha.20230130.1.nupkg
```
info	[Changelog]
```

️⚠️ azure-sdk-for-python-track2 warning [Detail]

⚠️Warning [Logs]Release - Generate from 18e83e2. SDK Automation 14.0.0

command	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
cmderr	[automation_generate.sh]
cmderr	[automation_generate.sh] npm notice New major version of npm available! 8.19.3 -> 9.4.0
cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.4.0>
cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@9.4.0` to update!
cmderr	[automation_generate.sh] npm notice

️✔️track2_azure-mgmt-network [View full logs] [Release SDK Changes]

info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog]   - Model NspAccessRule has a new parameter email_addresses
info	[Changelog]   - Model NspAccessRule has a new parameter phone_numbers
info	[Changelog]   - Model NspLink has a new parameter remote_perimeter_location
info	[Changelog]   - Model NspLinkReference has a new parameter remote_perimeter_location

️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 18e83e2. 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

️✔️azure-resourcemanager-network-generated [View full logs] [Release SDK Changes]

️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 18e83e2. 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

️✔️sdk/resourcemanager/network/armnetwork [View full logs] [Release SDK Changes]

info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog] - New value `ApplicationGatewaySKUNameStandardBasic` added to type alias `ApplicationGatewaySKUName`
info	[Changelog] - New value `ApplicationGatewayTierStandardBasic` added to type alias `ApplicationGatewayTier`
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 2 additive change(s).

️❌ azure-sdk-for-js failed [Detail]

❌Failed [Logs]Release - Generate from 18e83e2. 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
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
cmderr	[automation_generate.sh] [ERROR] Error:
cmderr	[automation_generate.sh] [ERROR] An error occurred while run build for readme file: "specification/network/resource-manager/readme.md":
cmderr	[automation_generate.sh] [ERROR] Err: Error: Command failed: rush build -t @azure/arm-network
cmderr	[automation_generate.sh] [ERROR] Stderr: "null"
cmderr	[automation_generate.sh] [ERROR] Stdout: "null"
cmderr	[automation_generate.sh] [ERROR] ErrorStack: "Error: Command failed: rush build -t @azure/arm-network
cmderr	[automation_generate.sh] [ERROR]     at checkExecSyncError (node:child_process:861:11)
cmderr	[automation_generate.sh] [ERROR]     at Object.execSync (node:child_process:932:15)
cmderr	[automation_generate.sh] [ERROR]     at Object.<anonymous> (/opt/hostedtoolcache/node/16.19.0/x64/lib/node_modules/@azure-tools/js-sdk-release-tools/dist/hlc/generateMgmt.js:87:33)
cmderr	[automation_generate.sh] [ERROR]     at Generator.next (<anonymous>)
cmderr	[automation_generate.sh] [ERROR]     at fulfilled (/opt/hostedtoolcache/node/16.19.0/x64/lib/node_modules/@azure-tools/js-sdk-release-tools/node_modules/tslib/tslib.js:112:62)
cmderr	[automation_generate.sh] [ERROR]     at processTicksAndRejections (node:internal/process/task_queues:96:5)"

❌@azure/arm-network [View full logs] [Release SDK Changes]

info	[Changelog]
error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.

️🔄 azure-resource-manager-schemas inProgress [Detail]

️❌ azure-powershell failed [Detail]

❌Failed [Logs]Release - Generate from 18e83e2. 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.network [View full logs] [Release SDK Changes]

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2022-12-28T07:26:18Z

Generated ApiView

Language	Package Name	ApiView Link
Go	sdk/resourcemanager/network/armnetwork	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-network-generated	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.Network	Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.

openapi-workflow-bot · 2022-12-28T07:42:08Z

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.

zzvswxy · 2023-01-09T02:00:37Z

/azp run

azure-pipelines · 2023-01-09T02:00:46Z

Azure Pipelines successfully started running 1 pipeline(s).

zzvswxy · 2023-01-16T02:11:07Z

/azp run

azure-pipelines · 2023-01-16T02:11:16Z

Azure Pipelines successfully started running 1 pipeline(s).

zzvswxy · 2023-01-16T09:01:15Z

Hi @manishrw , as there are BreakingChanges, please have a BreakingChange review

manishrw · 2023-01-24T07:32:24Z

Hey @zzvswxy, I've initiated the breaking change review process via email. Is there anything else that needs to be done for this PR to be merged?

zzvswxy · 2023-01-24T08:15:19Z

/azp run

azure-pipelines · 2023-01-24T08:15:29Z

Azure Pipelines successfully started running 1 pipeline(s).

zzvswxy · 2023-01-24T09:25:44Z

Hi @manishrw as there are Net SDK error and go SDK breaking change. I will ask the SDK Owner to check, If it's ok to ignore the error and approve the SDK breaking change.

zzvswxy · 2023-01-24T09:27:30Z

Hi @tadelesh @ArcturusZhang , can you help me to review the go and net SDK? thanks

tadelesh · 2023-01-24T12:01:17Z

Hi @tadelesh @ArcturusZhang , can you help me to review the go and net SDK? thanks

Approved.

Add new properties for email/sms rules to access rule API.

efc3584

manishrw requested a review from MikhailTryakhov as a code owner December 28, 2022 07:26

openapi-assignment-bot bot assigned lirenhe Dec 28, 2022

ghost added the Network label Dec 28, 2022

AzureRestAPISpecReview added NewApiVersionRequired resource-manager labels Dec 28, 2022

This was referenced Dec 28, 2022

[AutoPR Azure.ResourceManager.Network] Add new properties for email/sms rules to access rule API. azure-sdk/azure-sdk-for-net#2279

Closed

[AutoPR @azure/arm-network] Add new properties for email/sms rules to access rule API. azure-sdk/azure-sdk-for-js#3378

Closed

openapi-pipeline-app bot added the CI-BreakingChange-JavaScript label Dec 28, 2022

azure-sdk mentioned this pull request Dec 28, 2022

[AutoPR Microsoft.Azure.Management.Network] Add new properties for email/sms rules to access rule API. azure-sdk/azure-sdk-for-net#2280

Closed

zzvswxy self-assigned this Jan 4, 2023

azure-sdk mentioned this pull request Jan 9, 2023

[AutoPR track2_azure-mgmt-network] Add new properties for email/sms rules to access rule API. azure-sdk/azure-sdk-for-python#2489

Closed

qiaozha added the Approved-SdkBreakingChange-JavaScript label Jan 16, 2023

openapi-pipeline-app bot added the CI-BreakingChange-Go label Jan 24, 2023

tadelesh added the Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go label Jan 24, 2023

JeffreyRichter added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Jan 24, 2023

zzvswxy self-requested a review January 30, 2023 06:42

zzvswxy approved these changes Jan 30, 2023

View reviewed changes

lirenhe merged commit 18e83e2 into Azure:main Jan 30, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add new properties for email/sms rules to access rule API. #22000

Add new properties for email/sms rules to access rule API. #22000

manishrw commented Dec 28, 2022 •

edited

Loading

openapi-workflow-bot bot commented Dec 28, 2022

openapi-pipeline-app bot commented Dec 28, 2022 •

edited

Loading

openapi-pipeline-app bot commented Dec 28, 2022 •

edited

Loading

Breaking Changes Tracking

openapi-pipeline-app bot commented Dec 28, 2022 •

edited

Loading

openapi-workflow-bot bot commented Dec 28, 2022

zzvswxy commented Jan 9, 2023

azure-pipelines bot commented Jan 9, 2023

zzvswxy commented Jan 16, 2023

azure-pipelines bot commented Jan 16, 2023

zzvswxy commented Jan 16, 2023

manishrw commented Jan 24, 2023

zzvswxy commented Jan 24, 2023

azure-pipelines bot commented Jan 24, 2023

zzvswxy commented Jan 24, 2023

zzvswxy commented Jan 24, 2023

tadelesh commented Jan 24, 2023

Add new properties for email/sms rules to access rule API. #22000

Add new properties for email/sms rules to access rule API. #22000

Conversation

manishrw commented Dec 28, 2022 • edited Loading

ARM API Information (Control Plane)

Changelog

Contribution checklist (MS Employees Only):

ARM API Review Checklist

Breaking Change Review Checklist

openapi-workflow-bot bot commented Dec 28, 2022

openapi-pipeline-app bot commented Dec 28, 2022 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented Dec 28, 2022 • edited Loading

Swagger Generation Artifacts

Breaking Changes Tracking

openapi-pipeline-app bot commented Dec 28, 2022 • edited Loading

Generated ApiView

openapi-workflow-bot bot commented Dec 28, 2022

zzvswxy commented Jan 9, 2023

azure-pipelines bot commented Jan 9, 2023

zzvswxy commented Jan 16, 2023

azure-pipelines bot commented Jan 16, 2023

zzvswxy commented Jan 16, 2023

manishrw commented Jan 24, 2023

zzvswxy commented Jan 24, 2023

azure-pipelines bot commented Jan 24, 2023

zzvswxy commented Jan 24, 2023

zzvswxy commented Jan 24, 2023

tadelesh commented Jan 24, 2023

manishrw commented Dec 28, 2022 •

edited

Loading

openapi-pipeline-app bot commented Dec 28, 2022 •

edited

Loading

openapi-pipeline-app bot commented Dec 28, 2022 •

edited

Loading

openapi-pipeline-app bot commented Dec 28, 2022 •

edited

Loading