Adding Network security perimeter common types [v5] #28958

TimLovellSmith · 2024-05-02T22:48:40Z

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.

Purpose of this PR

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

New resource provider.
New API version for an existing resource provider. (If API spec is not defined in TypeSpec, the PR should have been created in adherence to OpenAPI specs PR creation guidance).
Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
Update existing version to fix OpenAPI spec quality issues in S360.
Other, please clarify:
- Adding common types for Network Security Perimeters so that they may be more widely adopted or implemented in a consistent fashion

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:

I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
I have reviewed following Resource Provider guidelines, including
ARM resource provider contract and
REST guidelines (estimated time: 4 hours).
I understand this is required before I can proceed to the diagram Step 2, "ARM API changes review", for this PR.

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 to get approval.

Getting help

First, please carefully read through this PR description, from top to bottom. Please fill out the Purpose of this PR and Due diligence checklist.
To understand what you must do next to merge this PR, see the Next Steps to Merge comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.
For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure
and https://aka.ms/ci-fix.
For help with ARM review (PR workflow diagram Step 2), see https://aka.ms/azsdk/pr-arm-review.
If the PR CI checks appear to be stuck in queued state, please add a comment with contents /azp run.
This should result in a new comment denoting a PR validation pipeline has started and the checks should be updated after few minutes.
If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.

…oked pretty clean.

…e/type/id from that). I've left 'location' property on it for now but I'm not sure if it should actually be there. Get rid of x-ms-client-flatten. Remove parameters that wouldn't be needed for implementing NSP.

…-manager/Microsoft.BotService/preview/2023-09-15-preview /networksecurityperimeter.json

openapi-pipeline-app · 2024-05-02T22:48:51Z

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 · 2024-05-02T22:48:51Z

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]

There are no breaking changes.

Compared specs (v0.10.8)	new version	base version
networksecurityperimeter.json	0000-00-00(cda181f)	0000-00-00(main)

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

️️✔️Avocado succeeded [Detail] [Expand]

Validation passes for Avocado.

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

Rule	Message
`❌` Failed to generate swagger APIView. The readme file format is invalid and the tag is not defined. Use the provided readme template for guidance readme template. For more details, please check the detail log.	"How to fix":"Check the readme file and make sure the readme file format is valid and the tag is defined. Use the provided readme template"

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

️️✔️SpellCheck succeeded [Detail] [Expand]

Validation passes for SpellCheck.

️️✔️Lint(RPaaS) succeeded [Detail] [Expand]

Validation passes for Lint(RPaaS).

️️✔️PR Summary succeeded [Detail] [Expand]

Validation passes for Summary.

️️✔️Automated merging requirements met succeeded [Detail] [Expand]

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

openapi-pipeline-app · 2024-05-02T22:48:52Z

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]

 Please click here to preview with your @microsoft account.

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

openapi-pipeline-app · 2024-05-02T22:48:53Z

PR validation pipeline restarted successfully. If there is ApiView generated, it will be updated in this comment.

mikekistler

I ran the Spectral linter on this file and it flagged some structural an Azure style issues.

specification/common-types/resource-management/v5/networksecurityperimeter.json

…-level Definition so it can more easily be reused.

specification/common-types/resource-management/v5/networksecurityperimeter.json

…kSecurityPerimeters

TimLovellSmith · 2024-05-15T16:05:35Z

/azp run

azure-pipelines · 2024-05-15T16:05:59Z

Azure Pipelines successfully started running 5 pipeline(s).

Adding network security perimeter type definitions to common-types.

kaushal087 · 2024-05-17T03:55:28Z

specification/common-types/resource-management/v5/networksecurityperimeter.json

+          "$ref": "#/definitions/ResourceAssociation"
+        },
+        "profile": {
+          "$ref": "#/definitions/NetworkSecurityProfile"


It's better to use "NetworkSecurityPerimeterProfile" or "PerimeterProfile", "Profile" or "NspProfile". We never use NetworkSecurityProfile and don't recommend to use it.

"Profile" would be best recommended to make it consistent with other keys like "ResourceAssociation", "AccessRule"

specification/common-types/resource-management/v5/networksecurityperimeter.json

Adding network security perimeter type definitions to common-types.

TimLovellSmith added 8 commits May 1, 2024 18:59

Start by copying networksecurityperimeter.json of BotService which lo…

84d1add

…oked pretty clean.

Use types.json and ProxyResource instead of Resource (and inherit nam…

04d23b5

…e/type/id from that). I've left 'location' property on it for now but I'm not sure if it should actually be there. Get rid of x-ms-client-flatten. Remove parameters that wouldn't be needed for implementing NSP.

Overwrite from azure-rest-api-specs/specification/botservice/resource…

9d2f414

…-manager/Microsoft.BotService/preview/2023-09-15-preview /networksecurityperimeter.json

Add PublicNetworkAccess enum to networksecurityperimeter.json v5.

09f5e10

Minor changes

88b4ecf

Refactor based on merging with proposed 'workspaces' NSP API.

ba1cc54

Fix title

71b76d2

Fixups based on consistency merge with proposed CosmosDB NSP APIs

47d022d

TimLovellSmith changed the title ~~Network security perimeter common types~~ Adding Network security perimeter common types [v5] May 2, 2024

TimLovellSmith requested a review from rkmanda May 2, 2024 22:56

TimLovellSmith added 2 commits May 2, 2024 16:03

prettier.io

591f4a0

Revert privatelinks.json

dc1d536

mikekistler requested changes May 3, 2024

View reviewed changes

TimLovellSmith added 8 commits May 3, 2024 08:56

Add empty paths element.

0bf12c4

Add 'values' to x-ms-enum for PublicNetworkAccess.

50a792d

Add more x-ms-enum values documentation

b17554c

Revise readOnly-ness and comments

fd7fb23

Fix values declaration

9bfbf65

Fix closing braces

c2ee1ab

Fix common-types link

2355b53

Promote NetworkSecurityPerimeterConfigurationProvisioningState to top…

5f7bf9e

…-level Definition so it can more easily be reused.

markcowl requested changes May 13, 2024

View reviewed changes

TimLovellSmith added 3 commits May 13, 2024 19:56

Zeroth day zeroth month is a thing?

e6d89a9

Adding x-ms-arm-id-details alllowedResources Microsoft.Network networ…

3565f01

…kSecurityPerimeters

Fix syntax, note default scope = resource group

b8617f8

openapi-pipeline-app bot added PipelineBotTrigger and removed PipelineBotTrigger labels May 14, 2024

markcowl approved these changes May 14, 2024

View reviewed changes

Removing the pattern constraint

4d3d476

TimLovellSmith enabled auto-merge (squash) May 14, 2024 23:40

TimLovellSmith added the MergeRequested label May 15, 2024

TimLovellSmith disabled auto-merge May 15, 2024 00:27

TimLovellSmith removed the MergeRequested label May 15, 2024

Merge branch 'main' into networkSecurityPerimeterCommonTypes

cda181f

TimLovellSmith enabled auto-merge (squash) May 15, 2024 02:11

openapi-pipeline-app bot added PipelineBotTrigger and removed PipelineBotTrigger labels May 15, 2024

TimLovellSmith merged commit fe6a0a3 into main May 15, 2024
30 of 35 checks passed

TimLovellSmith deleted the networkSecurityPerimeterCommonTypes branch May 15, 2024 16:16

TimLovellSmith mentioned this pull request May 15, 2024

[Cosmos DB] Microsoft.DocumentDB New API Version 2024-05-15 #28367

Merged

7 tasks

pjohari-ms pushed a commit to pjohari-ms/azure-rest-api-specs that referenced this pull request May 15, 2024

Adding Network security perimeter common types [v5] (Azure#28958)

925df87

Adding network security perimeter type definitions to common-types.

kaushal087 reviewed May 17, 2024

View reviewed changes

specification/common-types/resource-management/v5/networksecurityperimeter.json Show resolved Hide resolved

Francisco-Gamino pushed a commit to Francisco-Gamino/azure-rest-api-specs that referenced this pull request Jun 5, 2024

Adding Network security perimeter common types [v5] (Azure#28958)

daa6aa1

Adding network security perimeter type definitions to common-types.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding Network security perimeter common types [v5] #28958

Adding Network security perimeter common types [v5] #28958

TimLovellSmith commented May 2, 2024

openapi-pipeline-app bot commented May 2, 2024 •

edited

Loading

openapi-pipeline-app bot commented May 2, 2024 •

edited

Loading

openapi-pipeline-app bot commented May 2, 2024 •

edited

Loading

openapi-pipeline-app bot commented May 2, 2024 •

edited

Loading

mikekistler left a comment

TimLovellSmith commented May 15, 2024

azure-pipelines bot commented May 15, 2024

kaushal087 May 17, 2024

kaushal087 May 17, 2024

Adding Network security perimeter common types [v5] #28958

Adding Network security perimeter common types [v5] #28958

Conversation

TimLovellSmith commented May 2, 2024

ARM (Control Plane) API Specification Update Pull Request

PR review workflow diagram

Purpose of this PR

Due diligence checklist

Additional information

Getting help

openapi-pipeline-app bot commented May 2, 2024 • edited Loading

Next Steps to Merge

openapi-pipeline-app bot commented May 2, 2024 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented May 2, 2024 • edited Loading

Swagger Generation Artifacts

openapi-pipeline-app bot commented May 2, 2024 • edited Loading

mikekistler left a comment

Choose a reason for hiding this comment

TimLovellSmith commented May 15, 2024

azure-pipelines bot commented May 15, 2024

kaushal087 May 17, 2024

Choose a reason for hiding this comment

kaushal087 May 17, 2024

Choose a reason for hiding this comment

openapi-pipeline-app bot commented May 2, 2024 •

edited

Loading

openapi-pipeline-app bot commented May 2, 2024 •

edited

Loading

openapi-pipeline-app bot commented May 2, 2024 •

edited

Loading

openapi-pipeline-app bot commented May 2, 2024 •

edited

Loading