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

Added support for getting a single private link resource #14785

Merged
merged 5 commits into from
Apr 26, 2021
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/Network/Network/ChangeLog.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
--->

## Upcoming Release
* Added support for getting a single private link resource.
* Updated cmdlets to enable setting of PrivateRange on AzureFirewallPolicy.
- `New-AzFirewallPolicy`
- `Set-AzFirewallPolicy`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ namespace Microsoft.Azure.Commands.Network
[Cmdlet("Get", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "PrivateLinkResource", DefaultParameterSetName = "ByPrivateLinkResourceId"), OutputType(typeof(PSPrivateLinkResource))]
public class GetAzurePrivateLinkResourceCommand : NetworkBaseCmdlet, IDynamicParameters
{
[Alias("PrivateLinkServiceId")]
[Parameter(
Mandatory = true,
ParameterSetName = "ByPrivateLinkResourceId",
Expand All @@ -48,6 +49,12 @@ public class GetAzurePrivateLinkResourceCommand : NetworkBaseCmdlet, IDynamicPar
[ValidateNotNullOrEmpty]
public string ServiceName { get; set; }

[Alias("GroupName")]
[Parameter(
ValueFromPipelineByPropertyName = true,
HelpMessage = "The private link resource name.")]
public string Name { get; set; }

public string PrivateLinkResourceType { get; set; }
string NamedContextParameterSet = "ByResource";
private RuntimeDefinedParameterDictionary DynamicParameters;
Expand Down Expand Up @@ -87,10 +94,16 @@ public override void Execute()
{
throw new ArgumentException(string.Format(Properties.Resources.InvalidResourceId, this.PrivateLinkResourceId));
}

var plrs = provider.ListPrivateLinkResource(ResourceGroupName, ServiceName);
WriteObject(plrs, true);

if (this.IsParameterBound(c => c.Name))
{
var plr = provider.GetPrivateLinkResource(ResourceGroupName, ServiceName, Name);
WriteObject(plr);
}
else
{
var plrs = provider.ListPrivateLinkResource(ResourceGroupName, ServiceName);
WriteObject(plrs, true);
}
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
using Microsoft.Rest.Azure;
using Microsoft.Azure.Internal.Common;
using System.Collections.Generic;
using System.Linq;

namespace Microsoft.Azure.Commands.Network.PrivateLinkService.PrivateLinkServiceProvider
{
Expand Down Expand Up @@ -132,9 +133,16 @@ public void DeletePrivateEndpointConnection(string resourceGroupName, string ser

public PSPrivateLinkResource GetPrivateLinkResource(string resourceGroupName, string serviceName, string name)
{
string url = BuildPrivateLinkResourceURL(resourceGroupName, serviceName, name);
PrivateLinkResource resource = ServiceClient.Operations.GetResource<PrivateLinkResource>(url, _configuration.ApiVersion);
return ToPsPrivateLinkResource(resource);
if (_configuration.HasResourceURI)
{
string url = BuildPrivateLinkResourceURL(resourceGroupName, serviceName, name);
PrivateLinkResource resource = ServiceClient.Operations.GetResource<PrivateLinkResource>(url, _configuration.ApiVersion);
return ToPsPrivateLinkResource(resource);
}
else
{
return ListPrivateLinkResource(resourceGroupName, serviceName).Single(plr => plr.Name.Equals(name));
}
}

public List<PSPrivateLinkResource> ListPrivateLinkResource(string resourceGroupName, string serviceName)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,56 +14,58 @@ internal class ProviderConfiguration

static ProviderConfiguration()
{
RegisterConfiguration("Microsoft.Automation/automationAccounts", "2020-01-13-preview");
RegisterConfiguration("Microsoft.AppConfiguration/configurationStores", "2020-06-01");
RegisterConfiguration("Microsoft.Batch/batchAccounts", "2020-03-01");
RegisterConfiguration("Microsoft.Cache/redisEnterprise", "2021-03-01");
RegisterConfiguration("Microsoft.CognitiveServices/accounts", "2017-04-18");
RegisterConfiguration("Microsoft.Compute/diskAccesses", "2020-09-30");
RegisterConfiguration("Microsoft.ContainerRegistry/registries", "2019-12-01-preview");
RegisterConfiguration("Microsoft.DBforMySQL/servers", "2018-06-01");
RegisterConfiguration("Microsoft.DBforMariaDB/servers", "2018-06-01");
RegisterConfiguration("Microsoft.DBforPostgreSQL/servers", "2018-06-01");
RegisterConfiguration("Microsoft.Devices/IotHubs", "2020-03-01");
RegisterConfiguration("Microsoft.DocumentDB/databaseAccounts", "2019-08-01-preview");
RegisterConfiguration("Microsoft.DigitalTwins/digitalTwinsInstances", "2020-12-01");
RegisterConfiguration("Microsoft.EventGrid/topics", "2020-04-01-preview");
RegisterConfiguration("Microsoft.EventGrid/domains", "2020-04-01-preview");
RegisterConfiguration("Microsoft.EventHub/namespaces", "2018-01-01-preview");
RegisterConfiguration("Microsoft.HealthcareApis/services", "2020-03-30", false);
RegisterConfiguration("Microsoft.Insights/privateLinkScopes", "2019-10-17-preview");
RegisterConfiguration("Microsoft.KeyVault/vaults", "2018-02-14", false);
RegisterConfiguration("Microsoft.Media/mediaservices", "2020-05-01");
RegisterConfiguration("Microsoft.Migrate/assessmentProjects", "2020-05-01-preview", false);
RegisterConfiguration("Microsoft.Migrate/migrateProjects", "2020-06-01-preview", false);
RegisterConfiguration("Microsoft.Network/applicationgateways", "2020-05-01");
RegisterConfiguration("Microsoft.OffAzure/masterSites", "2020-07-07", false);
RegisterConfiguration("Microsoft.Purview/accounts", "2020-12-01-preview");
RegisterConfiguration("Microsoft.Search/searchServices", "2020-08-01");
RegisterConfiguration("Microsoft.ServiceBus/namespaces", "2018-01-01-preview");
RegisterConfiguration("Microsoft.SignalRService/signalr", "2020-05-01", false);
RegisterConfiguration("Microsoft.Sql/servers", "2018-06-01-preview");
RegisterConfiguration("Microsoft.Storage/storageAccounts", "2019-06-01", false);
RegisterConfiguration("Microsoft.StorageSync/storageSyncServices", "2020-03-01");
RegisterConfiguration("Microsoft.Synapse/workspaces", "2019-06-01-preview");
RegisterConfiguration("Microsoft.Web/sites", "2019-08-01");
RegisterConfiguration("Microsoft.Web/hostingEnvironments", "2020-10-01");
RegisterConfiguration("Microsoft.AppConfiguration/configurationStores", "2020-06-01", true, true);
RegisterConfiguration("Microsoft.Automation/automationAccounts", "2020-01-13-preview", true, false);
RegisterConfiguration("Microsoft.Batch/batchAccounts", "2020-03-01", true, true);
RegisterConfiguration("Microsoft.Cache/redisEnterprise", "2021-03-01", true, false);
RegisterConfiguration("Microsoft.CognitiveServices/accounts", "2017-04-18", true, false);
RegisterConfiguration("Microsoft.Compute/diskAccesses", "2020-09-30", true, false);
RegisterConfiguration("Microsoft.ContainerRegistry/registries", "2019-12-01-preview", true, false);
RegisterConfiguration("Microsoft.DBforMariaDB/servers", "2018-06-01", true, true);
RegisterConfiguration("Microsoft.DBforMySQL/servers", "2018-06-01", true, true);
RegisterConfiguration("Microsoft.DBforPostgreSQL/servers", "2018-06-01", true, true);
RegisterConfiguration("Microsoft.Devices/IotHubs", "2020-03-01", true, true);
RegisterConfiguration("Microsoft.DigitalTwins/digitalTwinsInstances", "2020-12-01", true, true);
RegisterConfiguration("Microsoft.DocumentDB/databaseAccounts", "2019-08-01-preview", true, true);
RegisterConfiguration("Microsoft.EventGrid/topics", "2020-04-01-preview", true, true);
RegisterConfiguration("Microsoft.EventGrid/domains", "2020-04-01-preview", true, true);
RegisterConfiguration("Microsoft.EventHub/namespaces", "2018-01-01-preview", true, false);
RegisterConfiguration("Microsoft.HealthcareApis/services", "2020-03-30", false, true);
RegisterConfiguration("Microsoft.Insights/privateLinkScopes", "2019-10-17-preview", true, true);
RegisterConfiguration("Microsoft.KeyVault/vaults", "2018-02-14", false, false);
RegisterConfiguration("Microsoft.Media/mediaservices", "2020-05-01", true, true);
RegisterConfiguration("Microsoft.Migrate/assessmentProjects", "2020-05-01-preview", false, false);
RegisterConfiguration("Microsoft.Migrate/migrateProjects", "2020-06-01-preview", false, false);
RegisterConfiguration("Microsoft.Network/applicationgateways", "2020-05-01", true, false);
RegisterConfiguration("Microsoft.OffAzure/masterSites", "2020-07-07", false, false);
RegisterConfiguration("Microsoft.Purview/accounts", "2020-12-01-preview", true, true);
RegisterConfiguration("Microsoft.Search/searchServices", "2020-08-01", true, false);
RegisterConfiguration("Microsoft.ServiceBus/namespaces", "2018-01-01-preview", true, false);
RegisterConfiguration("Microsoft.SignalRService/signalr", "2020-05-01", false, false);
RegisterConfiguration("Microsoft.Sql/servers", "2018-06-01-preview", true, true);
RegisterConfiguration("Microsoft.Storage/storageAccounts", "2019-06-01", false, false);
RegisterConfiguration("Microsoft.StorageSync/storageSyncServices", "2020-03-01", true, false);
RegisterConfiguration("Microsoft.Synapse/workspaces", "2019-06-01-preview", true, true);
RegisterConfiguration("Microsoft.Web/sites", "2019-08-01", true, false);
RegisterConfiguration("Microsoft.Web/hostingEnvironments", "2020-10-01", true, false);
}

private static void RegisterConfiguration(string type, string apiVersion, bool hasConnectionsURI = true)
private static void RegisterConfiguration(string type, string apiVersion, bool hasConnectionsURI = true, bool hasResourceURI = true)
{
ProviderConfiguration configuration = new ProviderConfiguration
{
Type = type,
ApiVersion = apiVersion,
HasConnectionsURI = hasConnectionsURI
HasConnectionsURI = hasConnectionsURI,
HasResourceURI = hasResourceURI
};
_configurations.Add(type, configuration);
}

public string Type { get; set; }
public string ApiVersion { get; set; }
public bool HasConnectionsURI { get; set; }
public bool HasResourceURI { get; set; }

public static ProviderConfiguration GetProviderConfiguration(string type)
{
Expand Down
25 changes: 20 additions & 5 deletions src/Network/Network/help/Get-AzPrivateLinkResource.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@ Gets a private link resource.

### ByPrivateLinkResourceId (Default)
```
Get-AzPrivateLinkResource -PrivateLinkResourceId <String> [-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzPrivateLinkResource -PrivateLinkResourceId <String> [-Name <String>]
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
```

### ByResource
```
Get-AzPrivateLinkResource -ResourceGroupName <String> -ServiceName <String>
Get-AzPrivateLinkResource -ResourceGroupName <String> -ServiceName <String> [-Name <String>]
[-DefaultProfile <IAzureContextContainer>] [-PrivateLinkResourceType <String>] [<CommonParameters>]
```

Expand Down Expand Up @@ -53,13 +53,28 @@ Accept pipeline input: False
Accept wildcard characters: False
```

### -Name
The private link resource name.

```yaml
Type: System.String
Parameter Sets: (All)
Aliases: GroupName

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```

### -PrivateLinkResourceId
The Azure resource manager id of the private link resource.

```yaml
Type: System.String
Parameter Sets: ByPrivateLinkResourceId
Aliases:
Aliases: PrivateLinkServiceId

Required: True
Position: Named
Expand All @@ -75,7 +90,7 @@ The private link resource type.
Type: System.String
Parameter Sets: ByResource
Aliases:
Accepted values:
Accepted values: Microsoft.AppConfiguration/configurationStores, Microsoft.Automation/automationAccounts, Microsoft.Batch/batchAccounts, Microsoft.Cache/redisEnterprise, Microsoft.CognitiveServices/accounts, Microsoft.Compute/diskAccesses, Microsoft.ContainerRegistry/registries, Microsoft.DBforMariaDB/servers, Microsoft.DBforMySQL/servers, Microsoft.DBforPostgreSQL/servers, Microsoft.Devices/IotHubs, Microsoft.DocumentDB/databaseAccounts, Microsoft.EventGrid/topics, Microsoft.EventGrid/domains, Microsoft.EventHub/namespaces, Microsoft.HealthcareApis/services, Microsoft.Insights/privateLinkScopes, Microsoft.KeyVault/vaults, Microsoft.Media/mediaservices, Microsoft.Migrate/assessmentProjects, Microsoft.Migrate/migrateProjects, Microsoft.Network/applicationgateways, Microsoft.OffAzure/masterSites, Microsoft.Purview/accounts, Microsoft.Search/searchServices, Microsoft.ServiceBus/namespaces, Microsoft.SignalRService/signalr, Microsoft.Sql/servers, Microsoft.Storage/storageAccounts, Microsoft.StorageSync/storageSyncServices, Microsoft.Synapse/workspaces, Microsoft.Web/sites, Microsoft.Web/hostingEnvironments
BethanyZhou marked this conversation as resolved.
Show resolved Hide resolved
BethanyZhou marked this conversation as resolved.
Show resolved Hide resolved

Required: False
Position: Named
Expand Down