Disconnect Active Sessions - Disconnect Active Sessions

Service:

Virtual Networks

API Version:

2024-05-01

Returns the list of currently active sessions on the Bastion.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/bastionHosts/{bastionHostName}/disconnectActiveSessions?api-version=2024-05-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.

Request Body

Name	Type	Description
sessionIds	string[]	List of session IDs.

Responses

Name	Type	Description
200 OK	BastionSessionDeleteResult	Success. The operation returns a list of sessions with the state of deleted/failed/not found.
Other Status Codes	CloudError	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

Deletes the specified active session

Sample request

HTTP

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

[
  "session1",
  "session2",
  "session3"
]

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.network import NetworkManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-network
# USAGE
    python bastion_session_delete.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = NetworkManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.disconnect_active_sessions(
        resource_group_name="rg1",
        bastion_host_name="bastionhosttenant",
        session_ids=["session1", "session2", "session3"],
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/BastionSessionDelete.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armnetwork_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/network/armnetwork/v6"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/ab04533261eff228f28e08900445d0edef3eb70c/specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/BastionSessionDelete.json
func ExampleManagementClient_NewDisconnectActiveSessionsPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armnetwork.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewManagementClient().NewDisconnectActiveSessionsPager("rg1", "bastionhosttenant", armnetwork.SessionIDs{}, nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.BastionSessionDeleteResult = armnetwork.BastionSessionDeleteResult{
		// 	Value: []*armnetwork.BastionSessionState{
		// 		{
		// 			Message: to.Ptr("session session1 invalidated!"),
		// 			SessionID: to.Ptr("session1"),
		// 			State: to.Ptr("Disconnected"),
		// 		},
		// 		{
		// 			Message: to.Ptr("session session2 could not be disconnected!"),
		// 			SessionID: to.Ptr("session2"),
		// 			State: to.Ptr("Failed"),
		// 		},
		// 		{
		// 			Message: to.Ptr("session session3 not found!"),
		// 			SessionID: to.Ptr("session3"),
		// 			State: to.Ptr("NotFound"),
		// 	}},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { NetworkManagementClient } = require("@azure/arm-network");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Returns the list of currently active sessions on the Bastion.
 *
 * @summary Returns the list of currently active sessions on the Bastion.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/BastionSessionDelete.json
 */
async function deletesTheSpecifiedActiveSession() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const bastionHostName = "bastionhosttenant";
  const sessionIds = {};
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.listDisconnectActiveSessions(
    resourceGroupName,
    bastionHostName,
    sessionIds,
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "value": [
    {
      "sessionId": "session1",
      "message": "session session1 invalidated!",
      "state": "Disconnected"
    },
    {
      "sessionId": "session2",
      "message": "session session2 could not be disconnected!",
      "state": "Failed"
    },
    {
      "sessionId": "session3",
      "message": "session session3 not found!",
      "state": "NotFound"
    }
  ]
}

Definitions

Name	Description
BastionSessionDeleteResult	Response for DisconnectActiveSessions.
BastionSessionState	The session state detail for a target.
CloudError	An error response from the service.
CloudErrorBody	An error response from the service.
SessionIds	List of session IDs.

BastionSessionDeleteResult

Object

Response for DisconnectActiveSessions.

Name	Type	Description
nextLink	string	The URL to get the next set of results.
value	BastionSessionState[]	List of sessions with their corresponding state.

BastionSessionState

Object

The session state detail for a target.

Name	Type	Description
message	string	Used for extra information.
sessionId	string	A unique id for the session.
state	string	The state of the session. Disconnected/Failed/NotFound.

CloudError

Object

An error response from the service.

Name	Type	Description
error	CloudErrorBody	Cloud error body.

CloudErrorBody

Object

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	CloudErrorBody[]	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.

SessionIds

Object

List of session IDs.

Name	Type	Description
sessionIds	string[]	List of session IDs.