Azure Native v1.98.1, Mar 24 23

azure-native.networkcloud.getConsole

Get properties of the provided virtual machine console. API Version: 2022-12-12-preview.

Using getConsole

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 getConsole(args: GetConsoleArgs, opts?: InvokeOptions): Promise<GetConsoleResult>
function getConsoleOutput(args: GetConsoleOutputArgs, opts?: InvokeOptions): Output<GetConsoleResult>

def get_console(console_name: Optional[str] = None,
                resource_group_name: Optional[str] = None,
                virtual_machine_name: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetConsoleResult
def get_console_output(console_name: Optional[pulumi.Input[str]] = None,
                resource_group_name: Optional[pulumi.Input[str]] = None,
                virtual_machine_name: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetConsoleResult]

func LookupConsole(ctx *Context, args *LookupConsoleArgs, opts ...InvokeOption) (*LookupConsoleResult, error)
func LookupConsoleOutput(ctx *Context, args *LookupConsoleOutputArgs, opts ...InvokeOption) LookupConsoleResultOutput

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

public static class GetConsole 
{
    public static Task<GetConsoleResult> InvokeAsync(GetConsoleArgs args, InvokeOptions? opts = null)
    public static Output<GetConsoleResult> Invoke(GetConsoleInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetConsoleResult> getConsole(GetConsoleArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: azure-native:networkcloud:getConsole
  arguments:
    # arguments dictionary

The following arguments are supported:

ConsoleName string: The name of the virtual machine console.
ResourceGroupName string: The name of the resource group. The name is case insensitive.
VirtualMachineName string: The name of the virtual machine.

ConsoleName string: The name of the virtual machine console.
ResourceGroupName string: The name of the resource group. The name is case insensitive.
VirtualMachineName string: The name of the virtual machine.

consoleName String: The name of the virtual machine console.
resourceGroupName String: The name of the resource group. The name is case insensitive.
virtualMachineName String: The name of the virtual machine.

consoleName string: The name of the virtual machine console.
resourceGroupName string: The name of the resource group. The name is case insensitive.
virtualMachineName string: The name of the virtual machine.

console_name str: The name of the virtual machine console.
resource_group_name str: The name of the resource group. The name is case insensitive.
virtual_machine_name str: The name of the virtual machine.

consoleName String: The name of the virtual machine console.
resourceGroupName String: The name of the resource group. The name is case insensitive.
virtualMachineName String: The name of the virtual machine.

getConsole Result

The following output properties are available:

DetailedStatus string: The more detailed status of the console.
DetailedStatusMessage string: The descriptive message about the current detailed status.
Enabled string: The indicator of whether the console access is enabled.
ExtendedLocation Pulumi.AzureNative.NetworkCloud.Outputs.ExtendedLocationResponse: The extended location of the cluster manager associated with the cluster this virtual machine is created on.
Id string: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Location string: The geo-location where the resource lives
Name string: The name of the resource
PrivateLinkServiceId string: The resource ID of the private link service that is used to provide virtual machine console access.
ProvisioningState string: The provisioning state of the virtual machine console.
SshPublicKey Pulumi.AzureNative.NetworkCloud.Outputs.SshPublicKeyResponse
SystemData Pulumi.AzureNative.NetworkCloud.Outputs.SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
VirtualMachineAccessId string: The unique identifier for the virtual machine that is used to access the console.
Expiration string: The date and time after which the key will be disallowed access.
Tags Dictionary<string, string>: Resource tags.

DetailedStatus string: The more detailed status of the console.
DetailedStatusMessage string: The descriptive message about the current detailed status.
Enabled string: The indicator of whether the console access is enabled.
ExtendedLocation ExtendedLocationResponse: The extended location of the cluster manager associated with the cluster this virtual machine is created on.
Id string: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Location string: The geo-location where the resource lives
Name string: The name of the resource
PrivateLinkServiceId string: The resource ID of the private link service that is used to provide virtual machine console access.
ProvisioningState string: The provisioning state of the virtual machine console.
SshPublicKey SshPublicKeyResponse
SystemData SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
VirtualMachineAccessId string: The unique identifier for the virtual machine that is used to access the console.
Expiration string: The date and time after which the key will be disallowed access.
Tags map[string]string: Resource tags.

detailedStatus String: The more detailed status of the console.
detailedStatusMessage String: The descriptive message about the current detailed status.
enabled String: The indicator of whether the console access is enabled.
extendedLocation ExtendedLocationResponse: The extended location of the cluster manager associated with the cluster this virtual machine is created on.
id String: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location String: The geo-location where the resource lives
name String: The name of the resource
privateLinkServiceId String: The resource ID of the private link service that is used to provide virtual machine console access.
provisioningState String: The provisioning state of the virtual machine console.
sshPublicKey SshPublicKeyResponse
systemData SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
virtualMachineAccessId String: The unique identifier for the virtual machine that is used to access the console.
expiration String: The date and time after which the key will be disallowed access.
tags Map<String,String>: Resource tags.

detailedStatus string: The more detailed status of the console.
detailedStatusMessage string: The descriptive message about the current detailed status.
enabled string: The indicator of whether the console access is enabled.
extendedLocation ExtendedLocationResponse: The extended location of the cluster manager associated with the cluster this virtual machine is created on.
id string: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location string: The geo-location where the resource lives
name string: The name of the resource
privateLinkServiceId string: The resource ID of the private link service that is used to provide virtual machine console access.
provisioningState string: The provisioning state of the virtual machine console.
sshPublicKey SshPublicKeyResponse
systemData SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
virtualMachineAccessId string: The unique identifier for the virtual machine that is used to access the console.
expiration string: The date and time after which the key will be disallowed access.
tags {[key: string]: string}: Resource tags.

detailed_status str: The more detailed status of the console.
detailed_status_message str: The descriptive message about the current detailed status.
enabled str: The indicator of whether the console access is enabled.
extended_location ExtendedLocationResponse: The extended location of the cluster manager associated with the cluster this virtual machine is created on.
id str: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location str: The geo-location where the resource lives
name str: The name of the resource
private_link_service_id str: The resource ID of the private link service that is used to provide virtual machine console access.
provisioning_state str: The provisioning state of the virtual machine console.
ssh_public_key SshPublicKeyResponse
system_data SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
virtual_machine_access_id str: The unique identifier for the virtual machine that is used to access the console.
expiration str: The date and time after which the key will be disallowed access.
tags Mapping[str, str]: Resource tags.

detailedStatus String: The more detailed status of the console.
detailedStatusMessage String: The descriptive message about the current detailed status.
enabled String: The indicator of whether the console access is enabled.
extendedLocation Property Map: The extended location of the cluster manager associated with the cluster this virtual machine is created on.
id String: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location String: The geo-location where the resource lives
name String: The name of the resource
privateLinkServiceId String: The resource ID of the private link service that is used to provide virtual machine console access.
provisioningState String: The provisioning state of the virtual machine console.
sshPublicKey Property Map
systemData Property Map: Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
virtualMachineAccessId String: The unique identifier for the virtual machine that is used to access the console.
expiration String: The date and time after which the key will be disallowed access.
tags Map<String>: Resource tags.

Supporting Types

ExtendedLocationResponse

Name string: The resource ID of the extended location on which the resource will be created.
Type string: The extended location type, for example, CustomLocation.

Name string: The resource ID of the extended location on which the resource will be created.
Type string: The extended location type, for example, CustomLocation.

name String: The resource ID of the extended location on which the resource will be created.
type String: The extended location type, for example, CustomLocation.

name string: The resource ID of the extended location on which the resource will be created.
type string: The extended location type, for example, CustomLocation.

name str: The resource ID of the extended location on which the resource will be created.
type str: The extended location type, for example, CustomLocation.

name String: The resource ID of the extended location on which the resource will be created.
type String: The extended location type, for example, CustomLocation.

SshPublicKeyResponse

KeyData string: The public ssh key of the user.

KeyData string: The public ssh key of the user.

keyData String: The public ssh key of the user.

keyData string: The public ssh key of the user.

key_data str: The public ssh key of the user.

keyData String: The public ssh key of the user.

SystemDataResponse

CreatedAt string: The timestamp of resource creation (UTC).
CreatedBy string: The identity that created the resource.
CreatedByType string: The type of identity that created the resource.
LastModifiedAt string: The timestamp of resource last modification (UTC)
LastModifiedBy string: The identity that last modified the resource.
LastModifiedByType string: The type of identity that last modified the resource.

CreatedAt string: The timestamp of resource creation (UTC).
CreatedBy string: The identity that created the resource.
CreatedByType string: The type of identity that created the resource.
LastModifiedAt string: The timestamp of resource last modification (UTC)
LastModifiedBy string: The identity that last modified the resource.
LastModifiedByType string: The type of identity that last modified the resource.

createdAt String: The timestamp of resource creation (UTC).
createdBy String: The identity that created the resource.
createdByType String: The type of identity that created the resource.
lastModifiedAt String: The timestamp of resource last modification (UTC)
lastModifiedBy String: The identity that last modified the resource.
lastModifiedByType String: The type of identity that last modified the resource.

createdAt string: The timestamp of resource creation (UTC).
createdBy string: The identity that created the resource.
createdByType string: The type of identity that created the resource.
lastModifiedAt string: The timestamp of resource last modification (UTC)
lastModifiedBy string: The identity that last modified the resource.
lastModifiedByType string: The type of identity that last modified the resource.

created_at str: The timestamp of resource creation (UTC).
created_by str: The identity that created the resource.
created_by_type str: The type of identity that created the resource.
last_modified_at str: The timestamp of resource last modification (UTC)
last_modified_by str: The identity that last modified the resource.
last_modified_by_type str: The type of identity that last modified the resource.

createdAt String: The timestamp of resource creation (UTC).
createdBy String: The identity that created the resource.
createdByType String: The type of identity that created the resource.
lastModifiedAt String: The timestamp of resource last modification (UTC)
lastModifiedBy String: The identity that last modified the resource.
lastModifiedByType String: The type of identity that last modified the resource.

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0