Skip to content

Add new cmdlets for Synapse managed private endpoint #15562

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

Merged
merged 18 commits into from
Jul 30, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
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
11 changes: 8 additions & 3 deletions src/Synapse/Synapse/Az.Synapse.psd1
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,8 @@ RequiredModules = @(@{ModuleName = 'Az.Accounts'; ModuleVersion = '2.5.1'; })
RequiredAssemblies = 'Microsoft.Azure.Management.Synapse.dll',
'Azure.Analytics.Synapse.Spark.dll',
'Azure.Analytics.Synapse.AccessControl.dll',
'Azure.Analytics.Synapse.Artifacts.dll'
'Azure.Analytics.Synapse.Artifacts.dll',
'Azure.Analytics.Synapse.ManagedPrivateEndpoints.dll'

# Script files (.ps1) that are run in the caller's environment prior to importing this module.
# ScriptsToProcess = @()
Expand Down Expand Up @@ -174,7 +175,10 @@ CmdletsToExport = 'Get-AzSynapseSparkJob', 'Stop-AzSynapseSparkJob',
'Update-AzSynapseManagedVirtualNetworkConfig',
'Get-AzSynapseSparkJobDefinition',
'Remove-AzSynapseSparkJobDefinition',
'Set-AzSynapseSparkJobDefinition'
'Set-AzSynapseSparkJobDefinition',
'Get-AzSynapseManagedPrivateEndpoint',
'New-AzSynapseManagedPrivateEndpoint',
'Remove-AzSynapseManagedPrivateEndpoint'

# Variables to export from this module
# VariablesToExport = @()
Expand All @@ -193,7 +197,8 @@ AliasesToExport = 'New-AzSynapsePipeline', 'New-AzSynapseLinkedService',
'Clear-AzSynapseSqlPoolVulnerabilityAssessmentSetting',
'Enable-AzSynapseSqlAdvancedThreatProtection',
'Disable-AzSynapseSqlAdvancedThreatProtection',
'New-AzSynapseSparkJobDefinition'
'New-AzSynapseSparkJobDefinition',
'Set-AzSynapseManagedPrivateEndpoint'

# DSC resources to export from this module
# DscResourcesToExport = @()
Expand Down
4 changes: 4 additions & 0 deletions src/Synapse/Synapse/ChangeLog.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,10 @@
- Additional information about change #1
-->
## Upcoming Release
* Added support for Synapse Managed Private Endpoint
- Added `New-AzSynapseManagedPrivateEndpoint` cmdlet
- Added `Get-AzSynapseManagedPrivateEndpoint` cmdlet
- Added `Remove-AzSynapseManagedPrivateEndpoint` cmdlet
* Added parameter `-ManagedResourceGroupName` for the `New-AzSynapseWorkspace` cmdlet

## Version 0.13.0
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
using Microsoft.Azure.Commands.ResourceManager.Common.ArgumentCompleters;
using Microsoft.Azure.Commands.Synapse.Common;
using Microsoft.Azure.Commands.Synapse.Models;
using Microsoft.WindowsAzure.Commands.Utilities.Common;
using System.Linq;
using System.Management.Automation;

namespace Microsoft.Azure.Commands.Synapse
{
[Cmdlet(VerbsCommon.Get, ResourceManager.Common.AzureRMConstants.AzureRMPrefix + SynapseConstants.SynapsePrefix + SynapseConstants.ManagedPrivateEndpoint,
DefaultParameterSetName = GetByName)]
[OutputType(typeof(PSManagedPrivateEndpointResource))]
public class GetAzureSynapseManagedPrivateEndpoint : SynapseManagedPrivateEndpointsClientCmdletBase
{
private const string GetByName = "GetByName";
private const string GetByObject = "GetByObject";

[Parameter(ValueFromPipelineByPropertyName = false, ParameterSetName = GetByName,
Mandatory = true, HelpMessage = HelpMessages.WorkspaceName)]
[ResourceNameCompleter(ResourceTypes.Workspace, "ResourceGroupName")]
[ValidateNotNullOrEmpty]
public override string WorkspaceName { get; set; }

[Parameter(ValueFromPipeline = true, ParameterSetName = GetByObject,
Mandatory = true, HelpMessage = HelpMessages.WorkspaceObject)]
[ValidateNotNull]
public PSSynapseWorkspace WorkspaceObject { get; set; }

[Parameter(ValueFromPipelineByPropertyName = false, Mandatory = false, HelpMessage = HelpMessages.ManagedPrivateEndpointName)]
[ValidateNotNullOrEmpty]
[Alias("ManagedPrivateEndpointName")]
public string Name { get; set; }

[Parameter(ValueFromPipelineByPropertyName = false, Mandatory = false, HelpMessage = HelpMessages.DefaultVNetName)]
[ValidateNotNullOrEmpty]
[Alias("VNetName")]
[PSDefaultValue(Help = SynapseConstants.DefaultVNetName, Value = SynapseConstants.DefaultVNetName)]
public string VirtualNetworkName { get; set; } = SynapseConstants.DefaultVNetName;

public override void ExecuteCmdlet()
{
if (this.IsParameterBound(c => c.WorkspaceObject))
{
this.WorkspaceName = this.WorkspaceObject.Name;
}
if(this.IsParameterBound(c => this.Name))
{
if (!string.IsNullOrEmpty(Name))
{
WriteObject(new PSManagedPrivateEndpointResource(SynapseManagedPrivateEndpointsClient.GetManagedPrivateEndpoint(this.Name, this.VirtualNetworkName), this.WorkspaceName));
}
}
else
{
var privateEndpoints = SynapseManagedPrivateEndpointsClient.ListManagedPrivateEndpoints(this.VirtualNetworkName)
.Select(element => new PSManagedPrivateEndpointResource(element, this.WorkspaceName));
WriteObject(privateEndpoints, true);
}
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
using Microsoft.Azure.Commands.ResourceManager.Common.ArgumentCompleters;
using Microsoft.Azure.Commands.Synapse.Common;
using Microsoft.Azure.Commands.Synapse.Models;
using Microsoft.Azure.Commands.Synapse.Properties;
using Microsoft.WindowsAzure.Commands.Utilities.Common;
using System;
using System.Management.Automation;

namespace Microsoft.Azure.Commands.Synapse
{
[Cmdlet(VerbsCommon.New, ResourceManager.Common.AzureRMConstants.AzureRMPrefix + SynapseConstants.SynapsePrefix + SynapseConstants.ManagedPrivateEndpoint,
DefaultParameterSetName = SetByName, SupportsShouldProcess = true)]
[Alias("Set-" + ResourceManager.Common.AzureRMConstants.AzureRMPrefix + SynapseConstants.SynapsePrefix + SynapseConstants.ManagedPrivateEndpoint)]
[OutputType(typeof(PSManagedPrivateEndpointResource))]
public class NewAzureSynapseManagedPrivateEndpoint : SynapseManagedPrivateEndpointsClientCmdletBase
{
private const string SetByName = "SetByName";
private const string SetByObject = "SetByObject";

[Parameter(ValueFromPipelineByPropertyName = false, ParameterSetName = SetByName,
Mandatory = true, HelpMessage = HelpMessages.WorkspaceName)]
[ResourceNameCompleter(ResourceTypes.Workspace, "ResourceGroupName")]
[ValidateNotNullOrEmpty]
public override string WorkspaceName { get; set; }

[Parameter(ValueFromPipeline = true, ParameterSetName = SetByObject,
Mandatory = true, HelpMessage = HelpMessages.WorkspaceObject)]
[ValidateNotNull]
public PSSynapseWorkspace WorkspaceObject { get; set; }

[Parameter(ValueFromPipelineByPropertyName = false, Mandatory = true, HelpMessage = HelpMessages.ManagedPrivateEndpointName)]
[ValidateNotNullOrEmpty]
[Alias("ManagedPrivateEndpointName")]
public string Name { get; set; }

[Parameter(ValueFromPipelineByPropertyName = false, Mandatory = false, HelpMessage = HelpMessages.DefaultVNetName)]
[ValidateNotNullOrEmpty]
[Alias("VNetName")]
[PSDefaultValue(Help = SynapseConstants.DefaultVNetName, Value = SynapseConstants.DefaultVNetName)]
public string VirtualNetworkName { get; set; } = SynapseConstants.DefaultVNetName;

[Parameter(ValueFromPipelineByPropertyName = false, Mandatory = true, HelpMessage = HelpMessages.JsonFilePath)]
[ValidateNotNullOrEmpty]
[Alias("File")]
public string DefinitionFile { get; set; }

[Parameter(Mandatory = false, HelpMessage = HelpMessages.AsJob)]
public SwitchParameter AsJob { get; set; }

public override void ExecuteCmdlet()
{
if (this.IsParameterBound(c => c.WorkspaceObject))
{
this.WorkspaceName = this.WorkspaceObject.Name;
}

if (this.ShouldProcess(this.WorkspaceName, String.Format(Resources.SettingSynapseManagedPrivateEndPoint, this.Name, this.WorkspaceName)))
{
string rawJsonContent = SynapseManagedPrivateEndpointsClient.ReadJsonFileContent(this.TryResolvePath(DefinitionFile));
WriteObject(new PSManagedPrivateEndpointResource(SynapseManagedPrivateEndpointsClient.CreateManagedPrivateEndpoint(this.Name, rawJsonContent, this.VirtualNetworkName), this.WorkspaceName));
}
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
using Microsoft.Azure.Commands.ResourceManager.Common.ArgumentCompleters;
using Microsoft.Azure.Commands.Synapse.Common;
using Microsoft.Azure.Commands.Synapse.Models;
using Microsoft.Azure.Commands.Synapse.Properties;
using Microsoft.WindowsAzure.Commands.Utilities.Common;
using System.Management.Automation;

namespace Microsoft.Azure.Commands.Synapse
{
[Cmdlet(VerbsCommon.Remove, ResourceManager.Common.AzureRMConstants.AzureRMPrefix + SynapseConstants.SynapsePrefix + SynapseConstants.ManagedPrivateEndpoint,
DefaultParameterSetName = RemoveByName, SupportsShouldProcess = true)]
[OutputType(typeof(bool))]
public class RemoveAzureSynapseManagedPrivateEndpoint : SynapseManagedPrivateEndpointsClientCmdletBase
{
private const string RemoveByName = "RemoveByName";
private const string RemoveByObject = "RemoveByObject";
private const string RemoveByInputObject = "RemoveByInputObject";

[Parameter(ValueFromPipelineByPropertyName = false, ParameterSetName = RemoveByName,
Mandatory = true, HelpMessage = HelpMessages.WorkspaceName)]
[ResourceNameCompleter(ResourceTypes.Workspace, "ResourceGroupName")]
[ValidateNotNullOrEmpty]
public override string WorkspaceName { get; set; }

[Parameter(ValueFromPipeline = true, ParameterSetName = RemoveByObject,
Mandatory = true, HelpMessage = HelpMessages.WorkspaceObject)]
[ValidateNotNull]
public PSSynapseWorkspace WorkspaceObject { get; set; }

[Parameter(ValueFromPipeline = true, ParameterSetName = RemoveByInputObject,
Mandatory = true, HelpMessage = HelpMessages.ManagedPrivateEndpointObject)]
[ValidateNotNull]
public PSManagedPrivateEndpointResource InputObject { get; set; }

[Parameter(ValueFromPipelineByPropertyName = false, ParameterSetName = RemoveByName,
Mandatory = true, HelpMessage = HelpMessages.ManagedPrivateEndpointName)]
[Parameter(ValueFromPipelineByPropertyName = false, ParameterSetName = RemoveByObject,
Mandatory = true, HelpMessage = HelpMessages.ManagedPrivateEndpointName)]
[ValidateNotNullOrEmpty]
[Alias("ManagedPrivateEndpointName")]
public string Name { get; set; }

[Parameter(ValueFromPipelineByPropertyName = false, Mandatory = false, HelpMessage = HelpMessages.DefaultVNetName)]
[ValidateNotNullOrEmpty]
[Alias("VNetName")]
[PSDefaultValue(Help = SynapseConstants.DefaultVNetName, Value = SynapseConstants.DefaultVNetName)]
public string VirtualNetworkName { get; set; } = SynapseConstants.DefaultVNetName;

[Parameter(Mandatory = false, HelpMessage = HelpMessages.PassThru)]
public SwitchParameter PassThru { get; set; }

[Parameter(Mandatory = false, HelpMessage = HelpMessages.AsJob)]
public SwitchParameter AsJob { get; set; }

[Parameter(Mandatory = false, HelpMessage = HelpMessages.Force)]
public SwitchParameter Force { get; set; }

public override void ExecuteCmdlet()
{
if (this.IsParameterBound(c => c.WorkspaceObject))
{
this.WorkspaceName = this.WorkspaceObject.Name;
}

if (this.IsParameterBound(c => c.InputObject))
{
this.WorkspaceName = this.InputObject.WorkspaceName;
this.Name = this.InputObject.Name;
}

ConfirmAction(
Force.IsPresent,
string.Format(Resources.RemoveSynapseManagedPrivateEndpoint, this.Name),
string.Format(Resources.RemovingSynapseManagedPrivateEndpoint, this.Name, this.WorkspaceName),
Name,
() =>
{
SynapseManagedPrivateEndpointsClient.DeleteManagedPrivateEndpoint(this.Name,this.VirtualNetworkName);
if (PassThru)
{
WriteObject(true);
}
});
}
}
}
6 changes: 6 additions & 0 deletions src/Synapse/Synapse/Common/HelpMessages.cs
Original file line number Diff line number Diff line change
Expand Up @@ -440,5 +440,11 @@ SELECT on dbo.myTable by public
public const string AutoPauseTimer = "The period of inactivity in minutes before automatically pausing the sql pool.";

public const string AutoResume = "Indicates whether the sql pool can automatically resume when connection attempts are made.";

public const string ManagedPrivateEndpointName = "The Synapse Managed Private Endpoint Name.";

public const string ManagedPrivateEndpointObject = "The Synapse Managed Private Endpoint Object.";

public const string DefaultVNetName = "Managed Virtual Network Name is 'default'.";
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
using Azure.Analytics.Synapse.ManagedPrivateEndpoints.Models;

namespace Microsoft.Azure.Commands.Synapse.Models
{
public class PSManagedPrivateEndpointConnectionState
{
public PSManagedPrivateEndpointConnectionState(ManagedPrivateEndpointConnectionState state)
{
this.Status = state?.Status;
this.Description = state?.Description;
this.ActionsRequired = state?.ActionsRequired;
}

public string Status { get; }

public string Description { get; set; }

public string ActionsRequired { get; set; }
}
}
26 changes: 26 additions & 0 deletions src/Synapse/Synapse/Models/PSManagedPrivateEndpointProperties.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
using Azure.Analytics.Synapse.ManagedPrivateEndpoints.Models;

namespace Microsoft.Azure.Commands.Synapse.Models
{
public class PSManagedPrivateEndpointProperties
{
public PSManagedPrivateEndpointProperties(ManagedPrivateEndpointProperties properties)
{
this.PrivateLinkResourceId = properties?.PrivateLinkResourceId;
this.GroupId = properties?.GroupId;
this.ProvisioningState = properties?.ProvisioningState;
this.IsReserved = properties?.IsReserved;
this.ConnectionState = properties?.ConnectionState != null? new PSManagedPrivateEndpointConnectionState(properties?.ConnectionState) : null;
}

public string PrivateLinkResourceId { get; set; }

public string GroupId { get; set; }

public string ProvisioningState { get; }

public PSManagedPrivateEndpointConnectionState ConnectionState { get; set; }

public bool? IsReserved { get; }
}
}
26 changes: 26 additions & 0 deletions src/Synapse/Synapse/Models/PSManagedPrivateEndpointResource.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
using Azure.Analytics.Synapse.ManagedPrivateEndpoints.Models;

namespace Microsoft.Azure.Commands.Synapse.Models
{
public class PSManagedPrivateEndpointResource
{
public PSManagedPrivateEndpointResource(ManagedPrivateEndpoint managedPrivateEndpoint, string workspaceName)
{
this.WorkspaceName = workspaceName;
this.Id = managedPrivateEndpoint?.Id;
this.Name = managedPrivateEndpoint?.Name;
this.Type = managedPrivateEndpoint?.Type;
this.Properties = managedPrivateEndpoint?.Properties != null? new PSManagedPrivateEndpointProperties(managedPrivateEndpoint.Properties) : null;
}

public string WorkspaceName { get; set; }

public string Id { get; set; }

public string Name { get; set; }

public string Type { get; set; }

public PSManagedPrivateEndpointProperties Properties { get; set; }
}
}
4 changes: 4 additions & 0 deletions src/Synapse/Synapse/Models/SynapseConstants.cs
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,10 @@ public static class SynapseConstants

public const string DisableMaxServiceObjectiveName = "remove";

public const string ManagedPrivateEndpoint = nameof(ManagedPrivateEndpoint);

public const string DefaultVNetName = "default";

public static Dictionary<string, ComputeNodeSize> ComputeNodeSizes = new Dictionary<string, ComputeNodeSize>
{
{
Expand Down
Loading