Edit

Share via


Get-AzP2sVpnGatewayDetailedConnectionHealth

Gets the detailed information of current point to site connections from P2SVpnGateway.

Syntax

ByP2SVpnGatewayName (Default)

Get-AzP2sVpnGatewayDetailedConnectionHealth
    -ResourceGroupName <String>
    -OutputBlobSasUrl <String>
    [-Name <String>]
    [-VpnUserNamesFilter <String[]>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

ByP2SVpnGatewayObject

Get-AzP2sVpnGatewayDetailedConnectionHealth
    -InputObject <PSP2SVpnGateway>
    -OutputBlobSasUrl <String>
    [-VpnUserNamesFilter <String[]>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

ByP2SVpnGatewayResourceId

Get-AzP2sVpnGatewayDetailedConnectionHealth
    -ResourceId <String>
    -OutputBlobSasUrl <String>
    [-VpnUserNamesFilter <String[]>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Description

The Get-AzP2sVpnGatewayDetailedConnectionHealth cmdlet enables you to get the detailed information of current point to site connections from P2SVpnGateway. Customer needs to pass SAS url where we can put this detailed health information.

Please note that the SAS url provided should be one for the blob (file) that has been created in the storage account and not the container. Please use the New-AzStorageBlobSASToken Powershell command and not the New-AzStorageContainerSASToken. You will also need to allow read and write permissions on your SaSURl.

Examples

Example 1

$blobSasUrl = New-AzStorageBlobSASToken -Container contp2stesting -Blob emptyfile.txt -Context $context -Permission "rwd" -StartTime $now.AddHours(-1) -ExpiryTime $now.AddDays(1) -FullUri
$blobSasUrl
SignedSasUrl
Get-AzP2sVpnGatewayDetailedConnectionHealth -Name 683482ade8564515aed4b8448c9757ea-westus-gw -ResourceGroupName P2SCortexGATesting -OutputBlobSasUrl $blobSasUrl
SasUrl : SignedSasUrl

The Get-AzP2sVpnGatewayDetailedConnectionHealth cmdlet enables you to get the detailed information of current point to site connections from P2SVpnGateway. Customer can download health details from passed SAS url download. This will show information of each point to site connection with usernames, bytes in, bytes out, allocated ip address etc.

Parameters

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Parameter properties

Type:IAzureContextContainer
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzContext, AzureRmContext, AzureCredential

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InputObject

The p2s vpn gateway object to be modified

Parameter properties

Type:PSP2SVpnGateway
Default value:None
Supports wildcards:False
DontShow:False
Aliases:P2SVpnGateway

Parameter sets

ByP2SVpnGatewayObject
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

The resource name.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:ResourceName

Parameter sets

ByP2SVpnGatewayName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-OutputBlobSasUrl

OutputBlob Sas url to which the p2s vpn connection health will be written.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-ResourceGroupName

The resource group name.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByP2SVpnGatewayName
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ResourceId

The Azure resource ID of the P2SVpnGateway to be modified.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByP2SVpnGatewayResourceId
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-VpnUserNamesFilter

The list of P2S vpn user names to filter.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

String

Microsoft.Azure.Commands.Network.Models.PSP2SVpnGateway

Outputs

PSP2SVpnConnectionHealth