1. Packages
  2. Azure Native
  3. API Docs
  4. network
  5. getActiveSessions
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.76.0 published on Friday, Dec 6, 2024 by Pulumi

azure-native.network.getActiveSessions

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.76.0 published on Friday, Dec 6, 2024 by Pulumi

    Returns the list of currently active sessions on the Bastion. Azure REST API version: 2023-02-01.

    Other available API versions: 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

    Using getActiveSessions

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getActiveSessions(args: GetActiveSessionsArgs, opts?: InvokeOptions): Promise<GetActiveSessionsResult>
    function getActiveSessionsOutput(args: GetActiveSessionsOutputArgs, opts?: InvokeOptions): Output<GetActiveSessionsResult>
    def get_active_sessions(bastion_host_name: Optional[str] = None,
                            resource_group_name: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetActiveSessionsResult
    def get_active_sessions_output(bastion_host_name: Optional[pulumi.Input[str]] = None,
                            resource_group_name: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetActiveSessionsResult]
    func GetActiveSessions(ctx *Context, args *GetActiveSessionsArgs, opts ...InvokeOption) (*GetActiveSessionsResult, error)
    func GetActiveSessionsOutput(ctx *Context, args *GetActiveSessionsOutputArgs, opts ...InvokeOption) GetActiveSessionsResultOutput

    > Note: This function is named GetActiveSessions in the Go SDK.

    public static class GetActiveSessions 
    {
        public static Task<GetActiveSessionsResult> InvokeAsync(GetActiveSessionsArgs args, InvokeOptions? opts = null)
        public static Output<GetActiveSessionsResult> Invoke(GetActiveSessionsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetActiveSessionsResult> getActiveSessions(GetActiveSessionsArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:network:getActiveSessions
      arguments:
        # arguments dictionary

    The following arguments are supported:

    BastionHostName string
    The name of the Bastion Host.
    ResourceGroupName string
    The name of the resource group.
    BastionHostName string
    The name of the Bastion Host.
    ResourceGroupName string
    The name of the resource group.
    bastionHostName String
    The name of the Bastion Host.
    resourceGroupName String
    The name of the resource group.
    bastionHostName string
    The name of the Bastion Host.
    resourceGroupName string
    The name of the resource group.
    bastion_host_name str
    The name of the Bastion Host.
    resource_group_name str
    The name of the resource group.
    bastionHostName String
    The name of the Bastion Host.
    resourceGroupName String
    The name of the resource group.

    getActiveSessions Result

    The following output properties are available:

    NextLink string
    The URL to get the next set of results.
    Value List<Pulumi.AzureNative.Network.Outputs.BastionActiveSessionResponse>
    List of active sessions on the bastion.
    NextLink string
    The URL to get the next set of results.
    Value []BastionActiveSessionResponse
    List of active sessions on the bastion.
    nextLink String
    The URL to get the next set of results.
    value List<BastionActiveSessionResponse>
    List of active sessions on the bastion.
    nextLink string
    The URL to get the next set of results.
    value BastionActiveSessionResponse[]
    List of active sessions on the bastion.
    next_link str
    The URL to get the next set of results.
    value Sequence[BastionActiveSessionResponse]
    List of active sessions on the bastion.
    nextLink String
    The URL to get the next set of results.
    value List<Property Map>
    List of active sessions on the bastion.

    Supporting Types

    BastionActiveSessionResponse

    Protocol string
    The protocol used to connect to the target.
    ResourceType string
    The type of the resource.
    SessionDurationInMins double
    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.
    Protocol string
    The protocol used to connect to the target.
    ResourceType string
    The type of the resource.
    SessionDurationInMins float64
    Duration in mins the session has been active.
    SessionId string
    A unique id for the session.
    StartTime interface{}
    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.
    protocol String
    The protocol used to connect to the target.
    resourceType String
    The type of the resource.
    sessionDurationInMins Double
    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.
    protocol string
    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 any
    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.
    protocol str
    The protocol used to connect to the target.
    resource_type str
    The type of the resource.
    session_duration_in_mins float
    Duration in mins the session has been active.
    session_id str
    A unique id for the session.
    start_time Any
    The time when the session started.
    target_host_name str
    The host name of the target.
    target_ip_address str
    The IP Address of the target.
    target_resource_group str
    The resource group of the target.
    target_resource_id str
    The resource id of the target.
    target_subscription_id str
    The subscription id for the target virtual machine.
    user_name str
    The user name who is active on this session.
    protocol String
    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 Any
    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.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.76.0 published on Friday, Dec 6, 2024 by Pulumi