azure-native.connectedvmwarevsphere.VCenter
Explore with Pulumi AI
Defines the vCenter.
Uses Azure REST API version 2023-12-01. In version 2.x of the Azure Native provider, it used API version 2022-07-15-preview.
Other available API versions: 2022-07-15-preview, 2023-03-01-preview, 2023-10-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native connectedvmwarevsphere [ApiVersion]
. See the version guide for details.
Create VCenter Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new VCenter(name: string, args: VCenterArgs, opts?: CustomResourceOptions);
@overload
def VCenter(resource_name: str,
args: VCenterArgs,
opts: Optional[ResourceOptions] = None)
@overload
def VCenter(resource_name: str,
opts: Optional[ResourceOptions] = None,
fqdn: Optional[str] = None,
resource_group_name: Optional[str] = None,
credentials: Optional[VICredentialArgs] = None,
extended_location: Optional[ExtendedLocationArgs] = None,
kind: Optional[str] = None,
location: Optional[str] = None,
port: Optional[int] = None,
tags: Optional[Mapping[str, str]] = None,
vcenter_name: Optional[str] = None)
func NewVCenter(ctx *Context, name string, args VCenterArgs, opts ...ResourceOption) (*VCenter, error)
public VCenter(string name, VCenterArgs args, CustomResourceOptions? opts = null)
public VCenter(String name, VCenterArgs args)
public VCenter(String name, VCenterArgs args, CustomResourceOptions options)
type: azure-native:connectedvmwarevsphere:VCenter
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. VCenterArgs - 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. VCenterArgs - 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. VCenterArgs - 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. VCenterArgs - 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. VCenterArgs - 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 vcenterResource = new AzureNative.ConnectedVMwarevSphere.VCenter("vcenterResource", new()
{
Fqdn = "string",
ResourceGroupName = "string",
Credentials = new AzureNative.ConnectedVMwarevSphere.Inputs.VICredentialArgs
{
Password = "string",
Username = "string",
},
ExtendedLocation = new AzureNative.ConnectedVMwarevSphere.Inputs.ExtendedLocationArgs
{
Name = "string",
Type = "string",
},
Kind = "string",
Location = "string",
Port = 0,
Tags =
{
{ "string", "string" },
},
VcenterName = "string",
});
example, err := connectedvmwarevsphere.NewVCenter(ctx, "vcenterResource", &connectedvmwarevsphere.VCenterArgs{
Fqdn: pulumi.String("string"),
ResourceGroupName: pulumi.String("string"),
Credentials: &connectedvmwarevsphere.VICredentialArgs{
Password: pulumi.String("string"),
Username: pulumi.String("string"),
},
ExtendedLocation: &connectedvmwarevsphere.ExtendedLocationArgs{
Name: pulumi.String("string"),
Type: pulumi.String("string"),
},
Kind: pulumi.String("string"),
Location: pulumi.String("string"),
Port: pulumi.Int(0),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
VcenterName: pulumi.String("string"),
})
var vcenterResource = new VCenter("vcenterResource", VCenterArgs.builder()
.fqdn("string")
.resourceGroupName("string")
.credentials(VICredentialArgs.builder()
.password("string")
.username("string")
.build())
.extendedLocation(ExtendedLocationArgs.builder()
.name("string")
.type("string")
.build())
.kind("string")
.location("string")
.port(0)
.tags(Map.of("string", "string"))
.vcenterName("string")
.build());
vcenter_resource = azure_native.connectedvmwarevsphere.VCenter("vcenterResource",
fqdn="string",
resource_group_name="string",
credentials={
"password": "string",
"username": "string",
},
extended_location={
"name": "string",
"type": "string",
},
kind="string",
location="string",
port=0,
tags={
"string": "string",
},
vcenter_name="string")
const vcenterResource = new azure_native.connectedvmwarevsphere.VCenter("vcenterResource", {
fqdn: "string",
resourceGroupName: "string",
credentials: {
password: "string",
username: "string",
},
extendedLocation: {
name: "string",
type: "string",
},
kind: "string",
location: "string",
port: 0,
tags: {
string: "string",
},
vcenterName: "string",
});
type: azure-native:connectedvmwarevsphere:VCenter
properties:
credentials:
password: string
username: string
extendedLocation:
name: string
type: string
fqdn: string
kind: string
location: string
port: 0
resourceGroupName: string
tags:
string: string
vcenterName: string
VCenter 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 VCenter resource accepts the following input properties:
- Fqdn
This property is required. string - Gets or sets the FQDN/IPAddress of the vCenter.
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The Resource Group Name.
- Credentials
Pulumi.
Azure Native. Connected VMwarev Sphere. Inputs. VICredential - Username / Password Credentials to connect to vcenter.
- Extended
Location Pulumi.Azure Native. Connected VMwarev Sphere. Inputs. Extended Location - Gets or sets the extended location.
- Kind string
- Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.
- Location
Changes to this property will trigger replacement.
- Gets or sets the location.
- Port int
- Gets or sets the port of the vCenter.
- Dictionary<string, string>
- Gets or sets the Resource tags.
- Vcenter
Name Changes to this property will trigger replacement.
- Name of the vCenter.
- Fqdn
This property is required. string - Gets or sets the FQDN/IPAddress of the vCenter.
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The Resource Group Name.
- Credentials
VICredential
Args - Username / Password Credentials to connect to vcenter.
- Extended
Location ExtendedLocation Args - Gets or sets the extended location.
- Kind string
- Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.
- Location
Changes to this property will trigger replacement.
- Gets or sets the location.
- Port int
- Gets or sets the port of the vCenter.
- map[string]string
- Gets or sets the Resource tags.
- Vcenter
Name Changes to this property will trigger replacement.
- Name of the vCenter.
- fqdn
This property is required. String - Gets or sets the FQDN/IPAddress of the vCenter.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The Resource Group Name.
- credentials VICredential
- Username / Password Credentials to connect to vcenter.
- extended
Location ExtendedLocation - Gets or sets the extended location.
- kind String
- Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.
- location
Changes to this property will trigger replacement.
- Gets or sets the location.
- port Integer
- Gets or sets the port of the vCenter.
- Map<String,String>
- Gets or sets the Resource tags.
- vcenter
Name Changes to this property will trigger replacement.
- Name of the vCenter.
- fqdn
This property is required. string - Gets or sets the FQDN/IPAddress of the vCenter.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The Resource Group Name.
- credentials VICredential
- Username / Password Credentials to connect to vcenter.
- extended
Location ExtendedLocation - Gets or sets the extended location.
- kind string
- Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.
- location
Changes to this property will trigger replacement.
- Gets or sets the location.
- port number
- Gets or sets the port of the vCenter.
- {[key: string]: string}
- Gets or sets the Resource tags.
- vcenter
Name Changes to this property will trigger replacement.
- Name of the vCenter.
- fqdn
This property is required. str - Gets or sets the FQDN/IPAddress of the vCenter.
- resource_
group_ name This property is required. Changes to this property will trigger replacement.
- The Resource Group Name.
- credentials
VICredential
Args - Username / Password Credentials to connect to vcenter.
- extended_
location ExtendedLocation Args - Gets or sets the extended location.
- kind str
- Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.
- location
Changes to this property will trigger replacement.
- Gets or sets the location.
- port int
- Gets or sets the port of the vCenter.
- Mapping[str, str]
- Gets or sets the Resource tags.
- vcenter_
name Changes to this property will trigger replacement.
- Name of the vCenter.
- fqdn
This property is required. String - Gets or sets the FQDN/IPAddress of the vCenter.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The Resource Group Name.
- credentials Property Map
- Username / Password Credentials to connect to vcenter.
- extended
Location Property Map - Gets or sets the extended location.
- kind String
- Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.
- location
Changes to this property will trigger replacement.
- Gets or sets the location.
- port Number
- Gets or sets the port of the vCenter.
- Map<String>
- Gets or sets the Resource tags.
- vcenter
Name Changes to this property will trigger replacement.
- Name of the vCenter.
Outputs
All input properties are implicitly available as output properties. Additionally, the VCenter resource produces the following output properties:
- Azure
Api stringVersion - The Azure API version of the resource.
- Connection
Status string - Gets or sets the connection status to the vCenter.
- Custom
Resource stringName - Gets the name of the corresponding resource in Kubernetes.
- Id string
- The provider-assigned unique ID for this managed resource.
- Instance
Uuid string - Gets or sets the instance UUID of the vCenter.
- Name string
- Gets or sets the name.
- Provisioning
State string - Gets the provisioning state.
- 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 - The system data.
- Type string
- Gets or sets the type of the resource.
- Uuid string
- Gets or sets a unique identifier for this resource.
- Version string
- Gets or sets the version of the vCenter.
- Azure
Api stringVersion - The Azure API version of the resource.
- Connection
Status string - Gets or sets the connection status to the vCenter.
- Custom
Resource stringName - Gets the name of the corresponding resource in Kubernetes.
- Id string
- The provider-assigned unique ID for this managed resource.
- Instance
Uuid string - Gets or sets the instance UUID of the vCenter.
- Name string
- Gets or sets the name.
- Provisioning
State string - Gets the provisioning state.
- Statuses
[]Resource
Status Response - The resource status information.
- System
Data SystemData Response - The system data.
- Type string
- Gets or sets the type of the resource.
- Uuid string
- Gets or sets a unique identifier for this resource.
- Version string
- Gets or sets the version of the vCenter.
- azure
Api StringVersion - The Azure API version of the resource.
- connection
Status String - Gets or sets the connection status to the vCenter.
- custom
Resource StringName - Gets the name of the corresponding resource in Kubernetes.
- id String
- The provider-assigned unique ID for this managed resource.
- instance
Uuid String - Gets or sets the instance UUID of the vCenter.
- name String
- Gets or sets the name.
- provisioning
State String - Gets the provisioning state.
- statuses
List<Resource
Status Response> - The resource status information.
- system
Data SystemData Response - The system data.
- type String
- Gets or sets the type of the resource.
- uuid String
- Gets or sets a unique identifier for this resource.
- version String
- Gets or sets the version of the vCenter.
- azure
Api stringVersion - The Azure API version of the resource.
- connection
Status string - Gets or sets the connection status to the vCenter.
- custom
Resource stringName - Gets the name of the corresponding resource in Kubernetes.
- id string
- The provider-assigned unique ID for this managed resource.
- instance
Uuid string - Gets or sets the instance UUID of the vCenter.
- name string
- Gets or sets the name.
- provisioning
State string - Gets the provisioning state.
- statuses
Resource
Status Response[] - The resource status information.
- system
Data SystemData Response - The system data.
- type string
- Gets or sets the type of the resource.
- uuid string
- Gets or sets a unique identifier for this resource.
- version string
- Gets or sets the version of the vCenter.
- azure_
api_ strversion - The Azure API version of the resource.
- connection_
status str - Gets or sets the connection status to the vCenter.
- custom_
resource_ strname - Gets the name of the corresponding resource in Kubernetes.
- id str
- The provider-assigned unique ID for this managed resource.
- instance_
uuid str - Gets or sets the instance UUID of the vCenter.
- name str
- Gets or sets the name.
- provisioning_
state str - Gets the provisioning state.
- statuses
Sequence[Resource
Status Response] - The resource status information.
- system_
data SystemData Response - The system data.
- type str
- Gets or sets the type of the resource.
- uuid str
- Gets or sets a unique identifier for this resource.
- version str
- Gets or sets the version of the vCenter.
- azure
Api StringVersion - The Azure API version of the resource.
- connection
Status String - Gets or sets the connection status to the vCenter.
- custom
Resource StringName - Gets the name of the corresponding resource in Kubernetes.
- id String
- The provider-assigned unique ID for this managed resource.
- instance
Uuid String - Gets or sets the instance UUID of the vCenter.
- name String
- Gets or sets the name.
- provisioning
State String - Gets the provisioning state.
- statuses List<Property Map>
- The resource status information.
- system
Data Property Map - The system data.
- type String
- Gets or sets the type of the resource.
- uuid String
- Gets or sets a unique identifier for this resource.
- version String
- Gets or sets the version of the vCenter.
Supporting Types
ExtendedLocation, ExtendedLocationArgs
ExtendedLocationResponse, ExtendedLocationResponseArgs
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.
VICredential, VICredentialArgs
VICredentialResponse, VICredentialResponseArgs
- Username string
- Gets or sets username to connect with the vCenter.
- Username string
- Gets or sets username to connect with the vCenter.
- username String
- Gets or sets username to connect with the vCenter.
- username string
- Gets or sets username to connect with the vCenter.
- username str
- Gets or sets username to connect with the vCenter.
- username String
- Gets or sets username to connect with the vCenter.
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:connectedvmwarevsphere:VCenter ContosoVCenter /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedVMwarevSphere/vcenters/{vcenterName}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0