azure-native-v2.connectedvmwarevsphere.VMInstanceGuestAgent
Explore with Pulumi AI
Defines the GuestAgent. Azure REST API version: 2023-03-01-preview.
Other available API versions: 2023-10-01, 2023-12-01.
Create VMInstanceGuestAgent Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new VMInstanceGuestAgent(name: string, args: VMInstanceGuestAgentArgs, opts?: CustomResourceOptions);
@overload
def VMInstanceGuestAgent(resource_name: str,
args: VMInstanceGuestAgentArgs,
opts: Optional[ResourceOptions] = None)
@overload
def VMInstanceGuestAgent(resource_name: str,
opts: Optional[ResourceOptions] = None,
resource_uri: Optional[str] = None,
credentials: Optional[GuestCredentialArgs] = None,
http_proxy_config: Optional[HttpProxyConfigurationArgs] = None,
private_link_scope_resource_id: Optional[str] = None,
provisioning_action: Optional[Union[str, ProvisioningAction]] = None)
func NewVMInstanceGuestAgent(ctx *Context, name string, args VMInstanceGuestAgentArgs, opts ...ResourceOption) (*VMInstanceGuestAgent, error)
public VMInstanceGuestAgent(string name, VMInstanceGuestAgentArgs args, CustomResourceOptions? opts = null)
public VMInstanceGuestAgent(String name, VMInstanceGuestAgentArgs args)
public VMInstanceGuestAgent(String name, VMInstanceGuestAgentArgs args, CustomResourceOptions options)
type: azure-native:connectedvmwarevsphere:VMInstanceGuestAgent
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. VMInstanceGuestAgentArgs - 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. VMInstanceGuestAgentArgs - 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. VMInstanceGuestAgentArgs - 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. VMInstanceGuestAgentArgs - 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. VMInstanceGuestAgentArgs - 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 vminstanceGuestAgentResource = new AzureNative.Connectedvmwarevsphere.VMInstanceGuestAgent("vminstanceGuestAgentResource", new()
{
ResourceUri = "string",
Credentials =
{
{ "password", "string" },
{ "username", "string" },
},
HttpProxyConfig =
{
{ "httpsProxy", "string" },
},
PrivateLinkScopeResourceId = "string",
ProvisioningAction = "string",
});
example, err := connectedvmwarevsphere.NewVMInstanceGuestAgent(ctx, "vminstanceGuestAgentResource", &connectedvmwarevsphere.VMInstanceGuestAgentArgs{
ResourceUri: "string",
Credentials: map[string]interface{}{
"password": "string",
"username": "string",
},
HttpProxyConfig: map[string]interface{}{
"httpsProxy": "string",
},
PrivateLinkScopeResourceId: "string",
ProvisioningAction: "string",
})
var vminstanceGuestAgentResource = new VMInstanceGuestAgent("vminstanceGuestAgentResource", VMInstanceGuestAgentArgs.builder()
.resourceUri("string")
.credentials(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.httpProxyConfig(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.privateLinkScopeResourceId("string")
.provisioningAction("string")
.build());
vminstance_guest_agent_resource = azure_native.connectedvmwarevsphere.VMInstanceGuestAgent("vminstanceGuestAgentResource",
resource_uri=string,
credentials={
password: string,
username: string,
},
http_proxy_config={
httpsProxy: string,
},
private_link_scope_resource_id=string,
provisioning_action=string)
const vminstanceGuestAgentResource = new azure_native.connectedvmwarevsphere.VMInstanceGuestAgent("vminstanceGuestAgentResource", {
resourceUri: "string",
credentials: {
password: "string",
username: "string",
},
httpProxyConfig: {
httpsProxy: "string",
},
privateLinkScopeResourceId: "string",
provisioningAction: "string",
});
type: azure-native:connectedvmwarevsphere:VMInstanceGuestAgent
properties:
credentials:
password: string
username: string
httpProxyConfig:
httpsProxy: string
privateLinkScopeResourceId: string
provisioningAction: string
resourceUri: string
VMInstanceGuestAgent 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 VMInstanceGuestAgent resource accepts the following input properties:
- Resource
Uri This property is required. Changes to this property will trigger replacement.
- The fully qualified Azure Resource manager identifier of the Hybrid Compute machine resource to be extended.
- Credentials
Pulumi.
Azure Native. Connected VMwarev Sphere. Inputs. Guest Credential - Username / Password Credentials to provision guest agent.
- Http
Proxy Pulumi.Config Azure Native. Connected VMwarev Sphere. Inputs. Http Proxy Configuration - HTTP Proxy configuration for the VM.
- Private
Link stringScope Resource Id - The resource id of the private link scope this machine is assigned to, if any.
- Provisioning
Action string | Pulumi.Azure Native. Connected VMwarev Sphere. Provisioning Action - Gets or sets the guest agent provisioning action.
- Resource
Uri This property is required. Changes to this property will trigger replacement.
- The fully qualified Azure Resource manager identifier of the Hybrid Compute machine resource to be extended.
- Credentials
Guest
Credential Args - Username / Password Credentials to provision guest agent.
- Http
Proxy HttpConfig Proxy Configuration Args - HTTP Proxy configuration for the VM.
- Private
Link stringScope Resource Id - The resource id of the private link scope this machine is assigned to, if any.
- Provisioning
Action string | ProvisioningAction - Gets or sets the guest agent provisioning action.
- resource
Uri This property is required. Changes to this property will trigger replacement.
- The fully qualified Azure Resource manager identifier of the Hybrid Compute machine resource to be extended.
- credentials
Guest
Credential - Username / Password Credentials to provision guest agent.
- http
Proxy HttpConfig Proxy Configuration - HTTP Proxy configuration for the VM.
- private
Link StringScope Resource Id - The resource id of the private link scope this machine is assigned to, if any.
- provisioning
Action String | ProvisioningAction - Gets or sets the guest agent provisioning action.
- resource
Uri This property is required. Changes to this property will trigger replacement.
- The fully qualified Azure Resource manager identifier of the Hybrid Compute machine resource to be extended.
- credentials
Guest
Credential - Username / Password Credentials to provision guest agent.
- http
Proxy HttpConfig Proxy Configuration - HTTP Proxy configuration for the VM.
- private
Link stringScope Resource Id - The resource id of the private link scope this machine is assigned to, if any.
- provisioning
Action string | ProvisioningAction - Gets or sets the guest agent provisioning action.
- resource_
uri This property is required. Changes to this property will trigger replacement.
- The fully qualified Azure Resource manager identifier of the Hybrid Compute machine resource to be extended.
- credentials
Guest
Credential Args - Username / Password Credentials to provision guest agent.
- http_
proxy_ Httpconfig Proxy Configuration Args - HTTP Proxy configuration for the VM.
- private_
link_ strscope_ resource_ id - The resource id of the private link scope this machine is assigned to, if any.
- provisioning_
action str | ProvisioningAction - Gets or sets the guest agent provisioning action.
- resource
Uri This property is required. Changes to this property will trigger replacement.
- The fully qualified Azure Resource manager identifier of the Hybrid Compute machine resource to be extended.
- credentials Property Map
- Username / Password Credentials to provision guest agent.
- http
Proxy Property MapConfig - HTTP Proxy configuration for the VM.
- private
Link StringScope Resource Id - The resource id of the private link scope this machine is assigned to, if any.
- provisioning
Action String | "install" | "uninstall" | "repair" - Gets or sets the guest agent provisioning action.
Outputs
All input properties are implicitly available as output properties. Additionally, the VMInstanceGuestAgent resource produces the following output properties:
- Custom
Resource stringName - Gets the name of the corresponding resource in Kubernetes.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the resource
- Provisioning
State string - Gets the provisioning state.
- Status string
- Gets or sets the guest agent status.
- Statuses
List<Pulumi.
Azure Native. Connected VMwarev Sphere. Outputs. Resource Status Response> - The resource status information.
- System
Data Pulumi.Azure Native. Connected VMwarev Sphere. 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"
- Uuid string
- Gets or sets a unique identifier for this resource.
- Custom
Resource stringName - Gets the name of the corresponding resource in Kubernetes.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the resource
- Provisioning
State string - Gets the provisioning state.
- Status string
- Gets or sets the guest agent status.
- Statuses
[]Resource
Status Response - The resource status information.
- 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"
- Uuid string
- Gets or sets a unique identifier for this resource.
- custom
Resource StringName - Gets the name of the corresponding resource in Kubernetes.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the resource
- provisioning
State String - Gets the provisioning state.
- status String
- Gets or sets the guest agent status.
- statuses
List<Resource
Status Response> - The resource status information.
- 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"
- uuid String
- Gets or sets a unique identifier for this resource.
- custom
Resource stringName - Gets the name of the corresponding resource in Kubernetes.
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- The name of the resource
- provisioning
State string - Gets the provisioning state.
- status string
- Gets or sets the guest agent status.
- statuses
Resource
Status Response[] - The resource status information.
- 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"
- uuid string
- Gets or sets a unique identifier for this resource.
- custom_
resource_ strname - Gets the name of the corresponding resource in Kubernetes.
- id str
- The provider-assigned unique ID for this managed resource.
- name str
- The name of the resource
- provisioning_
state str - Gets the provisioning state.
- status str
- Gets or sets the guest agent status.
- statuses
Sequence[Resource
Status Response] - The resource status information.
- 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"
- uuid str
- Gets or sets a unique identifier for this resource.
- custom
Resource StringName - Gets the name of the corresponding resource in Kubernetes.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the resource
- provisioning
State String - Gets the provisioning state.
- status String
- Gets or sets the guest agent status.
- statuses List<Property Map>
- The resource status information.
- 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"
- uuid String
- Gets or sets a unique identifier for this resource.
Supporting Types
GuestCredential, GuestCredentialArgs
GuestCredentialResponse, GuestCredentialResponseArgs
- Username string
- Gets or sets username to connect with the guest.
- Username string
- Gets or sets username to connect with the guest.
- username String
- Gets or sets username to connect with the guest.
- username string
- Gets or sets username to connect with the guest.
- username str
- Gets or sets username to connect with the guest.
- username String
- Gets or sets username to connect with the guest.
HttpProxyConfiguration, HttpProxyConfigurationArgs
- Https
Proxy string - Gets or sets httpsProxy url.
- Https
Proxy string - Gets or sets httpsProxy url.
- https
Proxy String - Gets or sets httpsProxy url.
- https
Proxy string - Gets or sets httpsProxy url.
- https_
proxy str - Gets or sets httpsProxy url.
- https
Proxy String - Gets or sets httpsProxy url.
HttpProxyConfigurationResponse, HttpProxyConfigurationResponseArgs
- Https
Proxy string - Gets or sets httpsProxy url.
- Https
Proxy string - Gets or sets httpsProxy url.
- https
Proxy String - Gets or sets httpsProxy url.
- https
Proxy string - Gets or sets httpsProxy url.
- https_
proxy str - Gets or sets httpsProxy url.
- https
Proxy String - Gets or sets httpsProxy url.
ProvisioningAction, ProvisioningActionArgs
- Install
- install
- Uninstall
- uninstall
- Repair
- repair
- Provisioning
Action Install - install
- Provisioning
Action Uninstall - uninstall
- Provisioning
Action Repair - repair
- Install
- install
- Uninstall
- uninstall
- Repair
- repair
- Install
- install
- Uninstall
- uninstall
- Repair
- repair
- INSTALL
- install
- UNINSTALL
- uninstall
- REPAIR
- repair
- "install"
- install
- "uninstall"
- uninstall
- "repair"
- repair
ResourceStatusResponse, ResourceStatusResponseArgs
- Last
Updated At This property is required. string - The last update time for this condition.
- Message
This property is required. string - A human readable message indicating details about the status.
- Reason
This property is required. string - The reason for the condition's status.
- Severity
This property is required. string - Severity with which to treat failures of this type of condition.
- Status
This property is required. string - Status of the condition.
- Type
This property is required. string - The type of the condition.
- Last
Updated At This property is required. string - The last update time for this condition.
- Message
This property is required. string - A human readable message indicating details about the status.
- Reason
This property is required. string - The reason for the condition's status.
- Severity
This property is required. string - Severity with which to treat failures of this type of condition.
- Status
This property is required. string - Status of the condition.
- Type
This property is required. string - The type of the condition.
- last
Updated At This property is required. String - The last update time for this condition.
- message
This property is required. String - A human readable message indicating details about the status.
- reason
This property is required. String - The reason for the condition's status.
- severity
This property is required. String - Severity with which to treat failures of this type of condition.
- status
This property is required. String - Status of the condition.
- type
This property is required. String - The type of the condition.
- last
Updated At This property is required. string - The last update time for this condition.
- message
This property is required. string - A human readable message indicating details about the status.
- reason
This property is required. string - The reason for the condition's status.
- severity
This property is required. string - Severity with which to treat failures of this type of condition.
- status
This property is required. string - Status of the condition.
- type
This property is required. string - The type of the condition.
- last_
updated_ at This property is required. str - The last update time for this condition.
- message
This property is required. str - A human readable message indicating details about the status.
- reason
This property is required. str - The reason for the condition's status.
- severity
This property is required. str - Severity with which to treat failures of this type of condition.
- status
This property is required. str - Status of the condition.
- type
This property is required. str - The type of the condition.
- last
Updated At This property is required. String - The last update time for this condition.
- message
This property is required. String - A human readable message indicating details about the status.
- reason
This property is required. String - The reason for the condition's status.
- severity
This property is required. String - Severity with which to treat failures of this type of condition.
- status
This property is required. String - Status of the condition.
- type
This property is required. String - The type of the condition.
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:connectedvmwarevsphere:VMInstanceGuestAgent default /{resourceUri}/providers/Microsoft.ConnectedVMwarevSphere/virtualMachineInstances/default/guestAgents/default
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