azure-native.network.getActiveSessions
Explore with Pulumi AI
Returns the list of currently active sessions on the Bastion.
Uses Azure REST API version 2024-05-01.
Other available API versions: 2019-09-01, 2019-11-01, 2019-12-01, 2020-03-01, 2020-04-01, 2020-05-01, 2020-06-01, 2020-07-01, 2020-08-01, 2020-11-01, 2021-02-01, 2021-03-01, 2021-05-01, 2021-08-01, 2022-01-01, 2022-05-01, 2022-07-01, 2022-09-01, 2022-11-01, 2023-02-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native network [ApiVersion]. See the version guide for details.
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)
public static Output<GetActiveSessionsResult> getActiveSessions(GetActiveSessionsArgs args, InvokeOptions options)
fn::invoke:
  function: azure-native:network:getActiveSessions
  arguments:
    # arguments dictionaryThe following arguments are supported:
- Bastion
Host stringName  - The name of the Bastion Host.
 - Resource
Group stringName  - The name of the resource group.
 
- Bastion
Host stringName  - The name of the Bastion Host.
 - Resource
Group stringName  - The name of the resource group.
 
- bastion
Host StringName  - The name of the Bastion Host.
 - resource
Group StringName  - The name of the resource group.
 
- bastion
Host stringName  - The name of the Bastion Host.
 - resource
Group stringName  - The name of the resource group.
 
- bastion_
host_ strname  - The name of the Bastion Host.
 - resource_
group_ strname  - The name of the resource group.
 
- bastion
Host StringName  - The name of the Bastion Host.
 - resource
Group StringName  - The name of the resource group.
 
getActiveSessions Result
The following output properties are available:
- Next
Link string - The URL to get the next set of results.
 - Value
List<Pulumi.
Azure Native. Network. Outputs. Bastion Active Session Response>  - List of active sessions on the bastion.
 
- Next
Link string - The URL to get the next set of results.
 - Value
[]Bastion
Active Session Response  - List of active sessions on the bastion.
 
- next
Link String - The URL to get the next set of results.
 - value
List<Bastion
Active Session Response>  - List of active sessions on the bastion.
 
- next
Link string - The URL to get the next set of results.
 - value
Bastion
Active Session Response[]  - List of active sessions on the bastion.
 
- next_
link str - The URL to get the next set of results.
 - value
Sequence[Bastion
Active Session Response]  - List of active sessions on the bastion.
 
- next
Link 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.
 - Resource
Type string - The type of the resource.
 - Session
Duration doubleIn Mins  - Duration in mins the session has been active.
 - Session
Id string - A unique id for the session.
 - Start
Time object - The time when the session started.
 - Target
Host stringName  - The host name of the target.
 - Target
Ip stringAddress  - The IP Address of the target.
 - Target
Resource stringGroup  - The resource group of the target.
 - Target
Resource stringId  - The resource id of the target.
 - Target
Subscription stringId  - The subscription id for the target virtual machine.
 - User
Name string - The user name who is active on this session.
 
- Protocol string
 - The protocol used to connect to the target.
 - Resource
Type string - The type of the resource.
 - Session
Duration float64In Mins  - Duration in mins the session has been active.
 - Session
Id string - A unique id for the session.
 - Start
Time interface{} - The time when the session started.
 - Target
Host stringName  - The host name of the target.
 - Target
Ip stringAddress  - The IP Address of the target.
 - Target
Resource stringGroup  - The resource group of the target.
 - Target
Resource stringId  - The resource id of the target.
 - Target
Subscription stringId  - The subscription id for the target virtual machine.
 - User
Name string - The user name who is active on this session.
 
- protocol String
 - The protocol used to connect to the target.
 - resource
Type String - The type of the resource.
 - session
Duration DoubleIn Mins  - Duration in mins the session has been active.
 - session
Id String - A unique id for the session.
 - start
Time Object - The time when the session started.
 - target
Host StringName  - The host name of the target.
 - target
Ip StringAddress  - The IP Address of the target.
 - target
Resource StringGroup  - The resource group of the target.
 - target
Resource StringId  - The resource id of the target.
 - target
Subscription StringId  - The subscription id for the target virtual machine.
 - user
Name String - The user name who is active on this session.
 
- protocol string
 - The protocol used to connect to the target.
 - resource
Type string - The type of the resource.
 - session
Duration numberIn Mins  - Duration in mins the session has been active.
 - session
Id string - A unique id for the session.
 - start
Time any - The time when the session started.
 - target
Host stringName  - The host name of the target.
 - target
Ip stringAddress  - The IP Address of the target.
 - target
Resource stringGroup  - The resource group of the target.
 - target
Resource stringId  - The resource id of the target.
 - target
Subscription stringId  - The subscription id for the target virtual machine.
 - user
Name 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_ floatin_ mins  - 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_ strname  - The host name of the target.
 - target_
ip_ straddress  - The IP Address of the target.
 - target_
resource_ strgroup  - The resource group of the target.
 - target_
resource_ strid  - The resource id of the target.
 - target_
subscription_ strid  - 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.
 - resource
Type String - The type of the resource.
 - session
Duration NumberIn Mins  - Duration in mins the session has been active.
 - session
Id String - A unique id for the session.
 - start
Time Any - The time when the session started.
 - target
Host StringName  - The host name of the target.
 - target
Ip StringAddress  - The IP Address of the target.
 - target
Resource StringGroup  - The resource group of the target.
 - target
Resource StringId  - The resource id of the target.
 - target
Subscription StringId  - The subscription id for the target virtual machine.
 - user
Name String - The user name who is active on this session.
 
Package Details
- Repository
 - Azure Native pulumi/pulumi-azure-native
 - License
 - Apache-2.0