Get Active Sessions - Get Active Sessions

Returns the list of currently active sessions on the Bastion.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/bastionHosts/{bastionHostName}/getActiveSessions?api-version=2022-01-01

URI Parameters

Name In Required Type Description
bastionHostName
path True
  • string

The name of the Bastion Host.

resourceGroupName
path True
  • string

The name of the resource group.

subscriptionId
path True
  • string

The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

api-version
query True
  • string

Client API version.

Responses

Name Type Description
200 OK

Success. The operation returns a list of active sessions on the Bastion.

202 Accepted

Accepted and the operation will complete asynchronously.

Other Status Codes

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

Returns a list of currently active sessions on the Bastion

Sample Request

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant/getActiveSessions?api-version=2022-01-01

Sample Response

{
  "value": [
    {
      "sessionId": "sessionId",
      "startTime": "2019-1-1T12:00:00.0000Z",
      "targetSubscriptionId": "subid",
      "resourceType": "VM",
      "targetHostName": "vm01",
      "targetResourceGroup": "rg1",
      "userName": "user",
      "targetIpAddress": "1.1.1.1",
      "protocol": "SSH",
      "targetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm01",
      "sessionDurationInMins": 0
    }
  ]
}

Definitions

BastionActiveSession

The session detail for a target.

BastionActiveSessionListResult

Response for GetActiveSessions.

BastionConnectProtocol

The protocol used to connect to the target.

CloudError

An error response from the service.

CloudErrorBody

An error response from the service.

BastionActiveSession

The session detail for a target.

Name Type Description
protocol

The protocol used to connect to the target.

resourceType
  • string

The type of the resource.

sessionDurationInMins
  • number

Duration in mins the session has been active.

sessionId
  • string

A unique id for the session.

startTime
  • object

The time when the session started.

targetHostName
  • string

The host name of the target.

targetIpAddress
  • string

The IP Address of the target.

targetResourceGroup
  • string

The resource group of the target.

targetResourceId
  • string

The resource id of the target.

targetSubscriptionId
  • string

The subscription id for the target virtual machine.

userName
  • string

The user name who is active on this session.

BastionActiveSessionListResult

Response for GetActiveSessions.

Name Type Description
nextLink
  • string

The URL to get the next set of results.

value

List of active sessions on the bastion.

BastionConnectProtocol

The protocol used to connect to the target.

Name Type Description
RDP
  • string
SSH
  • string

CloudError

An error response from the service.

Name Type Description
error

Cloud error body.

CloudErrorBody

An error response from the service.

Name Type Description
code
  • string

An identifier for the error. Codes are invariant and are intended to be consumed programmatically.

details

A list of additional details about the error.

message
  • string

A message describing the error, intended to be suitable for display in a user interface.

target
  • string

The target of the particular error. For example, the name of the property in error.