[Network]Add Microsoft.Network/privateLinkServices configuration to support the private endpoint connection #18000

LucasYao93 · 2022-04-28T01:21:39Z

Add Add Microsoft.Network/privateLinkServices in ProviderConfiguration.
Add hasSupportResourceURI parameter to check the resource whether support private link resource. True if support, otherwise false.

Checklist

I have read the Submitting Changes section of CONTRIBUTING.md
The title of the PR is clear and informative
The appropriate ChangeLog.md file(s) has been updated:
- For any service, the ChangeLog.md file can be found at src/{{SERVICE}}/{{SERVICE}}/ChangeLog.md
- A snippet outlining the change(s) made in the PR should be written under the ## Upcoming Release header -- no new version header should be added
The PR does not introduce breaking changes
If applicable, the changes made in the PR have proper test coverage
For public API changes to cmdlets:
- a cmdlet design review was approved for the changes in this repository (Microsoft internal only)
  - {Please put the link here}
- the markdown help files have been regenerated using the commands listed here

…C and add hasSupportResourceURI parameter.

…n or private link resource.

src/Network/Network/PrivateLinkService/PrivateLinkServiceProvider/ProviderConfiguration.cs

.../Network/PrivateLinkService/PrivateEndpointConnection/PrivateEndpointConnectionBaseCmdlet.cs

src/Network/Network/PrivateLinkService/PrivateLinkServiceProvider/GenericProvider.cs

BethanyZhou · 2022-05-09T03:33:09Z

documentation/development-docs/examples/private-link-resource-example.md

@@ -1,63 +1,69 @@
 ## Applicability
-Az.Network supports the retrieval of private link resource in `Get-AzPrivateLinkResource` as well as the management of private endpoint connection in `Approve-AzPrivateEndpointConnect`, `Deny-AzPrivateEndpointConnect`, `Remove-AzPrivateEndpointConnect` and `Set-AzPrivateEndpointConnect`. 
+Az.Network supports the retrieval of private link resource in `Get-AzPrivateLinkResource` as well as the management of private endpoint connection by `Get-AzPrivateEndpointConnect`, `Approve-AzPrivateEndpointConnect`, `Deny-AzPrivateEndpointConnect`, `Remove-AzPrivateEndpointConnect` and `Set-AzPrivateEndpointConnect`. 


Suggested change

Az.Network supports the retrieval of private link resource in `Get-AzPrivateLinkResource` as well as the management of private endpoint connection by `Get-AzPrivateEndpointConnect`, `Approve-AzPrivateEndpointConnect`, `Deny-AzPrivateEndpointConnect`, `Remove-AzPrivateEndpointConnect` and `Set-AzPrivateEndpointConnect`.

Az.Network supports the retrieval of private link resource in `Get-AzPrivateLinkResource` as well as the management of private endpoint connection by `Get-AzPrivateEndpointConnection`, `Approve-AzPrivateEndpointConnection`, `Deny-AzPrivateEndpointConnection`, `Remove-AzPrivateEndpointConnection` and `Set-AzPrivateEndpointConnection`.

BethanyZhou · 2022-05-09T03:35:18Z

documentation/development-docs/examples/private-link-resource-example.md

-For providers who 
- supports the features of private linke resource and private endpoint connection already
- and want to onboard these features in Azure PowerShell, 
+This example is for provider who 


Suggested change

This example is for provider who

For providers who

The audience should be providers.

BethanyZhou · 2022-05-09T03:35:31Z

documentation/development-docs/examples/private-link-resource-example.md

- supports the features of private linke resource and private endpoint connection already
- and want to onboard these features in Azure PowerShell, 
+This example is for provider who 
+- supports the features of private link resource and private endpoint connection already


Suggested change

- supports the features of private link resource and private endpoint connection already

- supports the features of private link resource or private endpoint connection already

BethanyZhou · 2022-05-09T03:36:51Z

documentation/development-docs/examples/private-link-resource-example.md

 ```
 ```
 # Get Private Endpoint Connection API
-"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{provider}/{Top-Level-Resource}/{Top-Level-Resource-Name}/privateEndpointConnections/{PrivateEndpointConnection-Name}"
+"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{provider}/{Top-Resource}/{Top-Resource-Name}/privateEndpointConnections/{Resource-Name}"


Suggested change

"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{provider}/{Top-Resource}/{Top-Resource-Name}/privateEndpointConnections/{Resource-Name}"

"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{provider}/{Top-Resource}/{Top-Resource-Name}/privateEndpointConnections/{PrivateEndpointConnection-Name}"

The name should be the name of PrivateEndpointConnection

BethanyZhou · 2022-05-09T03:38:57Z

Please contact me if you have any question about these comments.

.../Network/PrivateLinkService/PrivateEndpointConnection/PrivateEndpointConnectionBaseCmdlet.cs

BethanyZhou · 2022-05-10T01:01:41Z

...Network/Network/PrivateLinkService/PrivateLinkResource/GetAzurePrivateLinkResourceCommand.cs

+
+            if (!GenericProvider.SupportsPrivateLinkResourceType(this.PrivateLinkResourceType))
+            {
+                throw new ArgumentException(string.Format(Properties.Resources.UnsupportPrivateLinkResourceType, this.PrivateLinkResourceType));


AzPSArgumentException

Use AzPSArgumentException need pass parameter name. We have to hardcode parameter name if use it.

Please find a proper exception from https://github.com/Azure/azure-powershell-common/tree/main/src/Common/Exceptions

Used AzPSApplicationException

src/Network/Network/PrivateLinkService/PrivateLinkServiceProvider/GenericProvider.cs

src/Network/Network/Properties/Resources.resx

src/Network/Network/PrivateLinkService/PrivateLinkServiceProvider/GenericProvider.cs

BethanyZhou

Need change log for this feature.

LucasYao93 · 2022-05-11T02:04:12Z

Need change log for this feature.

added change log

src/Network/Network/ChangeLog.md

BethanyZhou

LGTM

…issue/16984

dingmeng-xue · 2022-05-09T02:03:19Z

src/Network/Network/PrivateLinkService/PrivateLinkServiceProvider/ProviderConfiguration.cs

        /// <param name="name">The name of the parameter</param>
        /// <param name="runtimeParameter">The returned runtime parameter for context, with appropriate validate set</param>
        /// <returns>True if one or more contexts were found, otherwise false</returns>
-        public static bool TryGetProvideServiceParameter(string name, string parameterSetName, out RuntimeDefinedParameter runtimeParameter)
+        public static bool TryGetProvideServiceParameter(string serviceType, string name, string parameterSetName, out RuntimeDefinedParameter runtimeParameter)


My understanding is It is not required. Let's discuss further.

dingmeng-xue · 2022-05-09T05:56:45Z

src/Network/Network/PrivateLinkService/PrivateLinkServiceProvider/ProviderConfiguration.cs

        /// <param name="name">The name of the parameter</param>
        /// <param name="runtimeParameter">The returned runtime parameter for context, with appropriate validate set</param>
        /// <returns>True if one or more contexts were found, otherwise false</returns>
-        public static bool TryGetProvideServiceParameter(string name, string parameterSetName, out RuntimeDefinedParameter runtimeParameter)
+        public static bool TryGetProvideServiceParameter(string serviceType, string name, string parameterSetName, out RuntimeDefinedParameter runtimeParameter)


If possible, the method should be moved to each cmdlet implementation. So, one should go to privateendpointconnnection, another goes to GetAzurePrivateLinkResource.

dingmeng-xue · 2022-05-11T03:24:54Z

.../Network/PrivateLinkService/PrivateEndpointConnection/PrivateEndpointConnectionBaseCmdlet.cs

@@ -76,6 +77,8 @@ public new object GetDynamicParameters()

        protected IPrivateLinkProvider BuildProvider(string subscription, string privateLinkResourceType)
        {
+            if (!GenericProvider.SupportsPrivateLinkResourceType(privateLinkResourceType))


Please help to rename method to SupportsPrivateLinkFeature because it includes resource type and connection endpoint both.

dingmeng-xue · 2022-05-11T03:38:58Z

src/Network/Network/Properties/Resources.resx

@@ -735,4 +735,10 @@
  <data name="VirtualNetworkGatewayNatRuleNotFound" xml:space="preserve">
    <value>The VirtualNetworkGatewayNatRule could not be found</value>
  </data>
+  <data name="UnsupportPrivateEndpointConnectionType" xml:space="preserve">
+    <value>The {0} doesn't register private endpoint connection.</value>


Suggested change

<value>The {0} doesn't register private endpoint connection.</value>

<value>Resource type {0} doesn't support private endpoint connection.</value>

dingmeng-xue · 2022-05-11T08:32:56Z

.../Network/PrivateLinkService/PrivateEndpointConnection/PrivateEndpointConnectionBaseCmdlet.cs

+        /// Check if the resource id format is valid.
+        /// </summary>
+        /// <exception cref="AzPSApplicationException">unvaild throw exception</exception>
+        public void CheckResourceId ()


Utility method should be defined as protected static method and accept resourceId as input parameter.

Add Microsoft.Network/privateLinkServices configuration to support PE…

c5f8873

…C and add hasSupportResourceURI parameter.

LucasYao93 requested a review from MikhailTryakhov as a code owner April 28, 2022 01:21

LucasYao93 requested review from dingmeng-xue and BethanyZhou and removed request for MikhailTryakhov April 28, 2022 01:22

LucasYao93 added the Do Not Merge 🚫 label Apr 28, 2022

LucasYao93 linked an issue Apr 28, 2022 that may be closed by this pull request

Get-AzPrivateEndpointConnection with -ResourceId argument supports Microsoft.Network/privateLinkServices #16984

Closed

LucasYao93 added 2 commits April 28, 2022 16:16

[Network] modified privatelinkresourcetype dynamic parameter.

9e40299

[Network]throw message when RP not support private endpoint connectio…

f1adfcd

…n or private link resource.

LucasYao93 linked an issue Apr 29, 2022 that may be closed by this pull request

Get-AzPrivateEndpointConnection shows friendly message if rp and resource is not supported #17091

Closed

dingmeng-xue self-assigned this May 9, 2022

update example

12de965

BethanyZhou reviewed May 9, 2022

View reviewed changes

BethanyZhou assigned LucasYao93 and unassigned dingmeng-xue May 9, 2022

dingmeng-xue and others added 4 commits May 9, 2022 12:15

update code

2f832fc

[Network] adjust private endpoint connection and link resource logic.

0637d53

[Network] modified help message.

99c59f2

[Network]merged from origin.

c56d6e7

BethanyZhou reviewed May 10, 2022

View reviewed changes

LucasYao93 added 2 commits May 10, 2022 10:14

[Network] delete unnecessary.

b7db4df

[Network]adjust prinvate link resource logic.

09f1d17

LucasYao93 requested a review from BethanyZhou May 10, 2022 03:16

BethanyZhou reviewed May 10, 2022

View reviewed changes

[Network] add changelog.

822ca1e

LucasYao93 and others added 2 commits May 11, 2022 10:05

Merge branch 'main' into issue/16984

f2ef74e

[Network] update changelog.

7bd8a93

BethanyZhou reviewed May 11, 2022

View reviewed changes

src/Network/Network/ChangeLog.md Outdated Show resolved Hide resolved

Update src/Network/Network/ChangeLog.md

6e4633b

BethanyZhou reviewed May 11, 2022

View reviewed changes

src/Network/Network/ChangeLog.md Outdated Show resolved Hide resolved

Update src/Network/Network/ChangeLog.md

be3623f

BethanyZhou reviewed May 11, 2022

View reviewed changes

BethanyZhou previously approved these changes May 11, 2022

View reviewed changes

LucasYao93 removed the Do Not Merge 🚫 label May 11, 2022

LucasYao93 added this to the May 2022 (2022-05-24)❗ Breaking change release ❗ milestone May 11, 2022

LucasYao93 added the Do Not Merge 🚫 label May 11, 2022

LucasYao93 added 2 commits May 11, 2022 16:18

[Network] adjust private link feature logic.

3874144

Merge branch 'issue/16984' of github.com:Azure/azure-powershell into …

2b7b517

…issue/16984

LucasYao93 dismissed BethanyZhou’s stale review via 2b7b517 May 11, 2022 08:28

LucasYao93 added 2 commits May 11, 2022 17:16

[Network] add VaildateParentResourceAttribute for resource id field."

0053cea

[Network] changed public to internal.

08dce7f

dingmeng-xue added Waiting for CI and removed Do Not Merge 🚫 labels May 11, 2022

dingmeng-xue approved these changes May 11, 2022

View reviewed changes

dingmeng-xue merged commit 2185ac9 into main May 12, 2022

LucasYao93 deleted the issue/16984 branch May 13, 2022 06:55

isra-fel mentioned this pull request May 26, 2022

Fix exception import Az.Accounts caused by environment variables #18311

Closed

8 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Network]Add Microsoft.Network/privateLinkServices configuration to support the private endpoint connection #18000

[Network]Add Microsoft.Network/privateLinkServices configuration to support the private endpoint connection #18000

LucasYao93 commented Apr 28, 2022 •

edited

Loading

BethanyZhou May 9, 2022

BethanyZhou May 9, 2022

BethanyZhou May 9, 2022

BethanyZhou May 9, 2022

BethanyZhou commented May 9, 2022

BethanyZhou May 10, 2022

LucasYao93 May 10, 2022

BethanyZhou May 10, 2022

LucasYao93 May 11, 2022

BethanyZhou left a comment

LucasYao93 commented May 11, 2022

BethanyZhou left a comment

dingmeng-xue May 9, 2022

dingmeng-xue May 9, 2022

dingmeng-xue May 11, 2022

dingmeng-xue May 11, 2022

dingmeng-xue May 11, 2022

	Az.Network supports the retrieval of private link resource in `Get-AzPrivateLinkResource` as well as the management of private endpoint connection by `Get-AzPrivateEndpointConnect`, `Approve-AzPrivateEndpointConnect`, `Deny-AzPrivateEndpointConnect`, `Remove-AzPrivateEndpointConnect` and `Set-AzPrivateEndpointConnect`.
	Az.Network supports the retrieval of private link resource in `Get-AzPrivateLinkResource` as well as the management of private endpoint connection by `Get-AzPrivateEndpointConnection`, `Approve-AzPrivateEndpointConnection`, `Deny-AzPrivateEndpointConnection`, `Remove-AzPrivateEndpointConnection` and `Set-AzPrivateEndpointConnection`.

	- supports the features of private link resource and private endpoint connection already
	- supports the features of private link resource or private endpoint connection already

	"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{provider}/{Top-Resource}/{Top-Resource-Name}/privateEndpointConnections/{Resource-Name}"
	"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{provider}/{Top-Resource}/{Top-Resource-Name}/privateEndpointConnections/{PrivateEndpointConnection-Name}"

	<value>The {0} doesn't register private endpoint connection.</value>
	<value>Resource type {0} doesn't support private endpoint connection.</value>

[Network]Add Microsoft.Network/privateLinkServices configuration to support the private endpoint connection #18000

[Network]Add Microsoft.Network/privateLinkServices configuration to support the private endpoint connection #18000

Conversation

LucasYao93 commented Apr 28, 2022 • edited Loading

Checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

BethanyZhou commented May 9, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

BethanyZhou left a comment

Choose a reason for hiding this comment

LucasYao93 commented May 11, 2022

BethanyZhou left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

LucasYao93 commented Apr 28, 2022 •

edited

Loading