azure-native-v2.networkcloud.Console
Explore with Pulumi AI
Azure REST API version: 2023-10-01-preview. Prior API version in Azure Native 1.x: 2022-12-12-preview.
Other available API versions: 2023-07-01, 2024-06-01-preview, 2024-07-01, 2024-10-01-preview.
Create Console Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Console(name: string, args: ConsoleArgs, opts?: CustomResourceOptions);
@overload
def Console(resource_name: str,
args: ConsoleArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Console(resource_name: str,
opts: Optional[ResourceOptions] = None,
enabled: Optional[Union[str, ConsoleEnabled]] = None,
extended_location: Optional[ExtendedLocationArgs] = None,
resource_group_name: Optional[str] = None,
ssh_public_key: Optional[SshPublicKeyArgs] = None,
virtual_machine_name: Optional[str] = None,
console_name: Optional[str] = None,
expiration: Optional[str] = None,
location: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None)
func NewConsole(ctx *Context, name string, args ConsoleArgs, opts ...ResourceOption) (*Console, error)
public Console(string name, ConsoleArgs args, CustomResourceOptions? opts = null)
public Console(String name, ConsoleArgs args)
public Console(String name, ConsoleArgs args, CustomResourceOptions options)
type: azure-native:networkcloud:Console
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name
This property is required. string - The unique name of the resource.
- args
This property is required. ConsoleArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
This property is required. str - The unique name of the resource.
- args
This property is required. ConsoleArgs - The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. ConsoleArgs - The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. ConsoleArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name
This property is required. String - The unique name of the resource.
- args
This property is required. ConsoleArgs - The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var consoleResource = new AzureNative.Networkcloud.Console("consoleResource", new()
{
Enabled = "string",
ExtendedLocation =
{
{ "name", "string" },
{ "type", "string" },
},
ResourceGroupName = "string",
SshPublicKey =
{
{ "keyData", "string" },
},
VirtualMachineName = "string",
ConsoleName = "string",
Expiration = "string",
Location = "string",
Tags =
{
{ "string", "string" },
},
});
example, err := networkcloud.NewConsole(ctx, "consoleResource", &networkcloud.ConsoleArgs{
Enabled: "string",
ExtendedLocation: map[string]interface{}{
"name": "string",
"type": "string",
},
ResourceGroupName: "string",
SshPublicKey: map[string]interface{}{
"keyData": "string",
},
VirtualMachineName: "string",
ConsoleName: "string",
Expiration: "string",
Location: "string",
Tags: map[string]interface{}{
"string": "string",
},
})
var consoleResource = new Console("consoleResource", ConsoleArgs.builder()
.enabled("string")
.extendedLocation(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.resourceGroupName("string")
.sshPublicKey(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.virtualMachineName("string")
.consoleName("string")
.expiration("string")
.location("string")
.tags(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.build());
console_resource = azure_native.networkcloud.Console("consoleResource",
enabled=string,
extended_location={
name: string,
type: string,
},
resource_group_name=string,
ssh_public_key={
keyData: string,
},
virtual_machine_name=string,
console_name=string,
expiration=string,
location=string,
tags={
string: string,
})
const consoleResource = new azure_native.networkcloud.Console("consoleResource", {
enabled: "string",
extendedLocation: {
name: "string",
type: "string",
},
resourceGroupName: "string",
sshPublicKey: {
keyData: "string",
},
virtualMachineName: "string",
consoleName: "string",
expiration: "string",
location: "string",
tags: {
string: "string",
},
});
type: azure-native:networkcloud:Console
properties:
consoleName: string
enabled: string
expiration: string
extendedLocation:
name: string
type: string
location: string
resourceGroupName: string
sshPublicKey:
keyData: string
tags:
string: string
virtualMachineName: string
Console Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Console resource accepts the following input properties:
- Enabled
This property is required. string | Pulumi.Azure Native. Network Cloud. Console Enabled - The indicator of whether the console access is enabled.
- Extended
Location This property is required. Pulumi.Azure Native. Network Cloud. Inputs. Extended Location - The extended location of the cluster manager associated with the cluster this virtual machine is created on.
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- Ssh
Public Key This property is required. Pulumi.Azure Native. Network Cloud. Inputs. Ssh Public Key - The SSH public key that will be provisioned for user access. The user is expected to have the corresponding SSH private key for logging in.
- Virtual
Machine Name This property is required. Changes to this property will trigger replacement.
- The name of the virtual machine.
- Console
Name Changes to this property will trigger replacement.
- The name of the virtual machine console.
- Expiration string
- The date and time after which the key will be disallowed access.
- Location
Changes to this property will trigger replacement.
- The geo-location where the resource lives
- Dictionary<string, string>
- Resource tags.
- Enabled
This property is required. string | ConsoleEnabled - The indicator of whether the console access is enabled.
- Extended
Location This property is required. ExtendedLocation Args - The extended location of the cluster manager associated with the cluster this virtual machine is created on.
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- Ssh
Public Key This property is required. SshPublic Key Args - The SSH public key that will be provisioned for user access. The user is expected to have the corresponding SSH private key for logging in.
- Virtual
Machine Name This property is required. Changes to this property will trigger replacement.
- The name of the virtual machine.
- Console
Name Changes to this property will trigger replacement.
- The name of the virtual machine console.
- Expiration string
- The date and time after which the key will be disallowed access.
- Location
Changes to this property will trigger replacement.
- The geo-location where the resource lives
- map[string]string
- Resource tags.
- enabled
This property is required. String | ConsoleEnabled - The indicator of whether the console access is enabled.
- extended
Location This property is required. ExtendedLocation - The extended location of the cluster manager associated with the cluster this virtual machine is created on.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- ssh
Public Key This property is required. SshPublic Key - The SSH public key that will be provisioned for user access. The user is expected to have the corresponding SSH private key for logging in.
- virtual
Machine Name This property is required. Changes to this property will trigger replacement.
- The name of the virtual machine.
- console
Name Changes to this property will trigger replacement.
- The name of the virtual machine console.
- expiration String
- The date and time after which the key will be disallowed access.
- location
Changes to this property will trigger replacement.
- The geo-location where the resource lives
- Map<String,String>
- Resource tags.
- enabled
This property is required. string | ConsoleEnabled - The indicator of whether the console access is enabled.
- extended
Location This property is required. ExtendedLocation - The extended location of the cluster manager associated with the cluster this virtual machine is created on.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- ssh
Public Key This property is required. SshPublic Key - The SSH public key that will be provisioned for user access. The user is expected to have the corresponding SSH private key for logging in.
- virtual
Machine Name This property is required. Changes to this property will trigger replacement.
- The name of the virtual machine.
- console
Name Changes to this property will trigger replacement.
- The name of the virtual machine console.
- expiration string
- The date and time after which the key will be disallowed access.
- location
Changes to this property will trigger replacement.
- The geo-location where the resource lives
- {[key: string]: string}
- Resource tags.
- enabled
This property is required. str | ConsoleEnabled - The indicator of whether the console access is enabled.
- extended_
location This property is required. ExtendedLocation Args - The extended location of the cluster manager associated with the cluster this virtual machine is created on.
- resource_
group_ name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- ssh_
public_ key This property is required. SshPublic Key Args - The SSH public key that will be provisioned for user access. The user is expected to have the corresponding SSH private key for logging in.
- virtual_
machine_ name This property is required. Changes to this property will trigger replacement.
- The name of the virtual machine.
- console_
name Changes to this property will trigger replacement.
- The name of the virtual machine console.
- expiration str
- The date and time after which the key will be disallowed access.
- location
Changes to this property will trigger replacement.
- The geo-location where the resource lives
- Mapping[str, str]
- Resource tags.
- enabled
This property is required. String | "True" | "False" - The indicator of whether the console access is enabled.
- extended
Location This property is required. Property Map - The extended location of the cluster manager associated with the cluster this virtual machine is created on.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- ssh
Public Key This property is required. Property Map - The SSH public key that will be provisioned for user access. The user is expected to have the corresponding SSH private key for logging in.
- virtual
Machine Name This property is required. Changes to this property will trigger replacement.
- The name of the virtual machine.
- console
Name Changes to this property will trigger replacement.
- The name of the virtual machine console.
- expiration String
- The date and time after which the key will be disallowed access.
- location
Changes to this property will trigger replacement.
- The geo-location where the resource lives
- Map<String>
- Resource tags.
Outputs
All input properties are implicitly available as output properties. Additionally, the Console resource produces the following output properties:
- Detailed
Status string - The more detailed status of the console.
- Detailed
Status stringMessage - The descriptive message about the current detailed status.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the resource
- Private
Link stringService Id - The resource ID of the private link service that is used to provide virtual machine console access.
- Provisioning
State string - The provisioning state of the virtual machine console.
- System
Data Pulumi.Azure Native. Network Cloud. Outputs. System Data Response - 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"
- Virtual
Machine stringAccess Id - The unique identifier for the virtual machine that is used to access the console.
- Detailed
Status string - The more detailed status of the console.
- Detailed
Status stringMessage - The descriptive message about the current detailed status.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the resource
- Private
Link stringService Id - The resource ID of the private link service that is used to provide virtual machine console access.
- Provisioning
State string - The provisioning state of the virtual machine console.
- System
Data SystemData Response - 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"
- Virtual
Machine stringAccess Id - The unique identifier for the virtual machine that is used to access the console.
- detailed
Status String - The more detailed status of the console.
- detailed
Status StringMessage - The descriptive message about the current detailed status.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the resource
- private
Link StringService Id - The resource ID of the private link service that is used to provide virtual machine console access.
- provisioning
State String - The provisioning state of the virtual machine console.
- system
Data SystemData Response - 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"
- virtual
Machine StringAccess Id - The unique identifier for the virtual machine that is used to access the console.
- detailed
Status string - The more detailed status of the console.
- detailed
Status stringMessage - The descriptive message about the current detailed status.
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- The name of the resource
- private
Link stringService Id - The resource ID of the private link service that is used to provide virtual machine console access.
- provisioning
State string - The provisioning state of the virtual machine console.
- system
Data SystemData Response - 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"
- virtual
Machine stringAccess Id - The unique identifier for the virtual machine that is used to access the console.
- detailed_
status str - The more detailed status of the console.
- detailed_
status_ strmessage - The descriptive message about the current detailed status.
- id str
- The provider-assigned unique ID for this managed resource.
- name str
- The name of the resource
- private_
link_ strservice_ id - 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.
- system_
data SystemData Response - 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_ straccess_ id - The unique identifier for the virtual machine that is used to access the console.
- detailed
Status String - The more detailed status of the console.
- detailed
Status StringMessage - The descriptive message about the current detailed status.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the resource
- private
Link StringService Id - The resource ID of the private link service that is used to provide virtual machine console access.
- provisioning
State String - The provisioning state of the virtual machine console.
- system
Data 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"
- virtual
Machine StringAccess Id - The unique identifier for the virtual machine that is used to access the console.
Supporting Types
ConsoleEnabled, ConsoleEnabledArgs
- True
- True
- False
- False
- Console
Enabled True - True
- Console
Enabled False - False
- True
- True
- False
- False
- True
- True
- False
- False
- TRUE
- True
- FALSE
- False
- "True"
- True
- "False"
- False
ExtendedLocation, ExtendedLocationArgs
ExtendedLocationResponse, ExtendedLocationResponseArgs
SshPublicKey, SshPublicKeyArgs
- Key
Data This property is required. string - The SSH public key data.
- Key
Data This property is required. string - The SSH public key data.
- key
Data This property is required. String - The SSH public key data.
- key
Data This property is required. string - The SSH public key data.
- key_
data This property is required. str - The SSH public key data.
- key
Data This property is required. String - The SSH public key data.
SshPublicKeyResponse, SshPublicKeyResponseArgs
- Key
Data This property is required. string - The SSH public key data.
- Key
Data This property is required. string - The SSH public key data.
- key
Data This property is required. String - The SSH public key data.
- key
Data This property is required. string - The SSH public key data.
- key_
data This property is required. str - The SSH public key data.
- key
Data This property is required. String - The SSH public key data.
SystemDataResponse, SystemDataResponseArgs
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - 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_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:networkcloud:Console default /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/virtualMachines/{virtualMachineName}/consoles/{consoleName}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- azure-native-v2 pulumi/pulumi-azure-native
- License
- Apache-2.0