pulumi-vsphere 4.10.0a1709017641__py3-none-any.whl → 4.17.0a1763710194__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of pulumi-vsphere might be problematic. Click here for more details.
- pulumi_vsphere/__init__.py +51 -1
- pulumi_vsphere/_inputs.py +2568 -1025
- pulumi_vsphere/_utilities.py +50 -10
- pulumi_vsphere/compute_cluster.py +1564 -2373
- pulumi_vsphere/compute_cluster_host_group.py +191 -55
- pulumi_vsphere/compute_cluster_vm_affinity_rule.py +157 -113
- pulumi_vsphere/compute_cluster_vm_anti_affinity_rule.py +133 -89
- pulumi_vsphere/compute_cluster_vm_dependency_rule.py +314 -106
- pulumi_vsphere/compute_cluster_vm_group.py +256 -55
- pulumi_vsphere/compute_cluster_vm_host_rule.py +323 -123
- pulumi_vsphere/config/__init__.py +2 -1
- pulumi_vsphere/config/__init__.pyi +7 -2
- pulumi_vsphere/config/vars.py +20 -15
- pulumi_vsphere/configuration_profile.py +286 -0
- pulumi_vsphere/content_library.py +177 -71
- pulumi_vsphere/content_library_item.py +252 -106
- pulumi_vsphere/custom_attribute.py +118 -38
- pulumi_vsphere/datacenter.py +128 -107
- pulumi_vsphere/datastore_cluster.py +636 -731
- pulumi_vsphere/datastore_cluster_vm_anti_affinity_rule.py +251 -89
- pulumi_vsphere/distributed_port_group.py +1129 -967
- pulumi_vsphere/distributed_virtual_switch.py +1971 -2239
- pulumi_vsphere/distributed_virtual_switch_pvlan_mapping.py +294 -0
- pulumi_vsphere/dpm_host_override.py +222 -72
- pulumi_vsphere/drs_vm_override.py +236 -72
- pulumi_vsphere/entity_permissions.py +96 -69
- pulumi_vsphere/file.py +173 -178
- pulumi_vsphere/folder.py +236 -113
- pulumi_vsphere/get_compute_cluster.py +34 -23
- pulumi_vsphere/get_compute_cluster_host_group.py +52 -41
- pulumi_vsphere/get_configuration_profile.py +145 -0
- pulumi_vsphere/get_content_library.py +33 -21
- pulumi_vsphere/get_content_library_item.py +47 -31
- pulumi_vsphere/get_custom_attribute.py +26 -17
- pulumi_vsphere/get_datacenter.py +40 -18
- pulumi_vsphere/get_datastore.py +60 -24
- pulumi_vsphere/get_datastore_cluster.py +47 -22
- pulumi_vsphere/get_datastore_stats.py +204 -0
- pulumi_vsphere/get_distributed_virtual_switch.py +36 -23
- pulumi_vsphere/get_dynamic.py +55 -45
- pulumi_vsphere/get_folder.py +163 -25
- pulumi_vsphere/get_guest_os_customization.py +68 -37
- pulumi_vsphere/get_host.py +34 -23
- pulumi_vsphere/get_host_base_images.py +104 -0
- pulumi_vsphere/get_host_pci_device.py +78 -35
- pulumi_vsphere/get_host_thumbprint.py +58 -38
- pulumi_vsphere/get_host_vgpu_profile.py +195 -0
- pulumi_vsphere/get_license.py +44 -28
- pulumi_vsphere/get_network.py +157 -46
- pulumi_vsphere/get_ovf_vm_template.py +184 -301
- pulumi_vsphere/get_policy.py +23 -15
- pulumi_vsphere/get_resource_pool.py +107 -40
- pulumi_vsphere/get_role.py +49 -35
- pulumi_vsphere/get_tag.py +34 -23
- pulumi_vsphere/get_tag_category.py +32 -21
- pulumi_vsphere/get_vapp_container.py +31 -21
- pulumi_vsphere/get_virtual_machine.py +499 -287
- pulumi_vsphere/get_vmfs_disks.py +42 -29
- pulumi_vsphere/guest_os_customization.py +135 -79
- pulumi_vsphere/ha_vm_override.py +470 -577
- pulumi_vsphere/host.py +515 -262
- pulumi_vsphere/host_port_group.py +352 -355
- pulumi_vsphere/host_virtual_switch.py +580 -580
- pulumi_vsphere/license.py +110 -92
- pulumi_vsphere/nas_datastore.py +398 -270
- pulumi_vsphere/offline_software_depot.py +190 -0
- pulumi_vsphere/outputs.py +1582 -1027
- pulumi_vsphere/provider.py +172 -152
- pulumi_vsphere/pulumi-plugin.json +2 -1
- pulumi_vsphere/resource_pool.py +357 -273
- pulumi_vsphere/role.py +79 -47
- pulumi_vsphere/storage_drs_vm_override.py +225 -89
- pulumi_vsphere/supervisor.py +1064 -0
- pulumi_vsphere/tag.py +217 -55
- pulumi_vsphere/tag_category.py +158 -72
- pulumi_vsphere/vapp_container.py +425 -259
- pulumi_vsphere/vapp_entity.py +324 -174
- pulumi_vsphere/virtual_disk.py +245 -153
- pulumi_vsphere/virtual_machine.py +1696 -1836
- pulumi_vsphere/virtual_machine_class.py +448 -0
- pulumi_vsphere/virtual_machine_snapshot.py +137 -131
- pulumi_vsphere/vm_storage_policy.py +160 -154
- pulumi_vsphere/vmfs_datastore.py +460 -186
- pulumi_vsphere/vnic.py +249 -231
- {pulumi_vsphere-4.10.0a1709017641.dist-info → pulumi_vsphere-4.17.0a1763710194.dist-info}/METADATA +7 -6
- pulumi_vsphere-4.17.0a1763710194.dist-info/RECORD +89 -0
- {pulumi_vsphere-4.10.0a1709017641.dist-info → pulumi_vsphere-4.17.0a1763710194.dist-info}/WHEEL +1 -1
- pulumi_vsphere-4.10.0a1709017641.dist-info/RECORD +0 -80
- {pulumi_vsphere-4.10.0a1709017641.dist-info → pulumi_vsphere-4.17.0a1763710194.dist-info}/top_level.txt +0 -0
pulumi_vsphere/tag_category.py
CHANGED
|
@@ -1,12 +1,17 @@
|
|
|
1
1
|
# coding=utf-8
|
|
2
|
-
# *** WARNING: this file was generated by
|
|
2
|
+
# *** WARNING: this file was generated by pulumi-language-python. ***
|
|
3
3
|
# *** Do not edit by hand unless you're certain you know what you are doing! ***
|
|
4
4
|
|
|
5
|
-
import
|
|
5
|
+
import builtins as _builtins
|
|
6
6
|
import warnings
|
|
7
|
+
import sys
|
|
7
8
|
import pulumi
|
|
8
9
|
import pulumi.runtime
|
|
9
10
|
from typing import Any, Mapping, Optional, Sequence, Union, overload
|
|
11
|
+
if sys.version_info >= (3, 11):
|
|
12
|
+
from typing import NotRequired, TypedDict, TypeAlias
|
|
13
|
+
else:
|
|
14
|
+
from typing_extensions import NotRequired, TypedDict, TypeAlias
|
|
10
15
|
from . import _utilities
|
|
11
16
|
|
|
12
17
|
__all__ = ['TagCategoryArgs', 'TagCategory']
|
|
@@ -14,24 +19,24 @@ __all__ = ['TagCategoryArgs', 'TagCategory']
|
|
|
14
19
|
@pulumi.input_type
|
|
15
20
|
class TagCategoryArgs:
|
|
16
21
|
def __init__(__self__, *,
|
|
17
|
-
associable_types: pulumi.Input[Sequence[pulumi.Input[str]]],
|
|
18
|
-
cardinality: pulumi.Input[str],
|
|
19
|
-
description: Optional[pulumi.Input[str]] = None,
|
|
20
|
-
name: Optional[pulumi.Input[str]] = None):
|
|
22
|
+
associable_types: pulumi.Input[Sequence[pulumi.Input[_builtins.str]]],
|
|
23
|
+
cardinality: pulumi.Input[_builtins.str],
|
|
24
|
+
description: Optional[pulumi.Input[_builtins.str]] = None,
|
|
25
|
+
name: Optional[pulumi.Input[_builtins.str]] = None):
|
|
21
26
|
"""
|
|
22
27
|
The set of arguments for constructing a TagCategory resource.
|
|
23
|
-
:param pulumi.Input[Sequence[pulumi.Input[str]]] associable_types: A list object types that this category is
|
|
28
|
+
:param pulumi.Input[Sequence[pulumi.Input[_builtins.str]]] associable_types: A list object types that this category is
|
|
24
29
|
valid to be assigned to. For a full list, click
|
|
25
30
|
here.
|
|
26
|
-
:param pulumi.Input[str] cardinality: The number of tags that can be assigned from this
|
|
31
|
+
:param pulumi.Input[_builtins.str] cardinality: The number of tags that can be assigned from this
|
|
27
32
|
category to a single object at once. Can be one of `SINGLE` (object can only
|
|
28
33
|
be assigned one tag in this category), to `MULTIPLE` (object can be assigned
|
|
29
34
|
multiple tags in this category). Forces a new resource if changed.
|
|
30
|
-
:param pulumi.Input[str] description: A description for the category.
|
|
35
|
+
:param pulumi.Input[_builtins.str] description: A description for the category.
|
|
31
36
|
|
|
32
37
|
> **NOTE:** You can add associable types to a category, but you cannot remove
|
|
33
38
|
them. Attempting to do so will result in an error.
|
|
34
|
-
:param pulumi.Input[str] name: The name of the category.
|
|
39
|
+
:param pulumi.Input[_builtins.str] name: The name of the category.
|
|
35
40
|
"""
|
|
36
41
|
pulumi.set(__self__, "associable_types", associable_types)
|
|
37
42
|
pulumi.set(__self__, "cardinality", cardinality)
|
|
@@ -40,9 +45,9 @@ class TagCategoryArgs:
|
|
|
40
45
|
if name is not None:
|
|
41
46
|
pulumi.set(__self__, "name", name)
|
|
42
47
|
|
|
43
|
-
@property
|
|
48
|
+
@_builtins.property
|
|
44
49
|
@pulumi.getter(name="associableTypes")
|
|
45
|
-
def associable_types(self) -> pulumi.Input[Sequence[pulumi.Input[str]]]:
|
|
50
|
+
def associable_types(self) -> pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]:
|
|
46
51
|
"""
|
|
47
52
|
A list object types that this category is
|
|
48
53
|
valid to be assigned to. For a full list, click
|
|
@@ -51,12 +56,12 @@ class TagCategoryArgs:
|
|
|
51
56
|
return pulumi.get(self, "associable_types")
|
|
52
57
|
|
|
53
58
|
@associable_types.setter
|
|
54
|
-
def associable_types(self, value: pulumi.Input[Sequence[pulumi.Input[str]]]):
|
|
59
|
+
def associable_types(self, value: pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]):
|
|
55
60
|
pulumi.set(self, "associable_types", value)
|
|
56
61
|
|
|
57
|
-
@property
|
|
62
|
+
@_builtins.property
|
|
58
63
|
@pulumi.getter
|
|
59
|
-
def cardinality(self) -> pulumi.Input[str]:
|
|
64
|
+
def cardinality(self) -> pulumi.Input[_builtins.str]:
|
|
60
65
|
"""
|
|
61
66
|
The number of tags that can be assigned from this
|
|
62
67
|
category to a single object at once. Can be one of `SINGLE` (object can only
|
|
@@ -66,12 +71,12 @@ class TagCategoryArgs:
|
|
|
66
71
|
return pulumi.get(self, "cardinality")
|
|
67
72
|
|
|
68
73
|
@cardinality.setter
|
|
69
|
-
def cardinality(self, value: pulumi.Input[str]):
|
|
74
|
+
def cardinality(self, value: pulumi.Input[_builtins.str]):
|
|
70
75
|
pulumi.set(self, "cardinality", value)
|
|
71
76
|
|
|
72
|
-
@property
|
|
77
|
+
@_builtins.property
|
|
73
78
|
@pulumi.getter
|
|
74
|
-
def description(self) -> Optional[pulumi.Input[str]]:
|
|
79
|
+
def description(self) -> Optional[pulumi.Input[_builtins.str]]:
|
|
75
80
|
"""
|
|
76
81
|
A description for the category.
|
|
77
82
|
|
|
@@ -81,43 +86,43 @@ class TagCategoryArgs:
|
|
|
81
86
|
return pulumi.get(self, "description")
|
|
82
87
|
|
|
83
88
|
@description.setter
|
|
84
|
-
def description(self, value: Optional[pulumi.Input[str]]):
|
|
89
|
+
def description(self, value: Optional[pulumi.Input[_builtins.str]]):
|
|
85
90
|
pulumi.set(self, "description", value)
|
|
86
91
|
|
|
87
|
-
@property
|
|
92
|
+
@_builtins.property
|
|
88
93
|
@pulumi.getter
|
|
89
|
-
def name(self) -> Optional[pulumi.Input[str]]:
|
|
94
|
+
def name(self) -> Optional[pulumi.Input[_builtins.str]]:
|
|
90
95
|
"""
|
|
91
96
|
The name of the category.
|
|
92
97
|
"""
|
|
93
98
|
return pulumi.get(self, "name")
|
|
94
99
|
|
|
95
100
|
@name.setter
|
|
96
|
-
def name(self, value: Optional[pulumi.Input[str]]):
|
|
101
|
+
def name(self, value: Optional[pulumi.Input[_builtins.str]]):
|
|
97
102
|
pulumi.set(self, "name", value)
|
|
98
103
|
|
|
99
104
|
|
|
100
105
|
@pulumi.input_type
|
|
101
106
|
class _TagCategoryState:
|
|
102
107
|
def __init__(__self__, *,
|
|
103
|
-
associable_types: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
|
|
104
|
-
cardinality: Optional[pulumi.Input[str]] = None,
|
|
105
|
-
description: Optional[pulumi.Input[str]] = None,
|
|
106
|
-
name: Optional[pulumi.Input[str]] = None):
|
|
108
|
+
associable_types: Optional[pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]] = None,
|
|
109
|
+
cardinality: Optional[pulumi.Input[_builtins.str]] = None,
|
|
110
|
+
description: Optional[pulumi.Input[_builtins.str]] = None,
|
|
111
|
+
name: Optional[pulumi.Input[_builtins.str]] = None):
|
|
107
112
|
"""
|
|
108
113
|
Input properties used for looking up and filtering TagCategory resources.
|
|
109
|
-
:param pulumi.Input[Sequence[pulumi.Input[str]]] associable_types: A list object types that this category is
|
|
114
|
+
:param pulumi.Input[Sequence[pulumi.Input[_builtins.str]]] associable_types: A list object types that this category is
|
|
110
115
|
valid to be assigned to. For a full list, click
|
|
111
116
|
here.
|
|
112
|
-
:param pulumi.Input[str] cardinality: The number of tags that can be assigned from this
|
|
117
|
+
:param pulumi.Input[_builtins.str] cardinality: The number of tags that can be assigned from this
|
|
113
118
|
category to a single object at once. Can be one of `SINGLE` (object can only
|
|
114
119
|
be assigned one tag in this category), to `MULTIPLE` (object can be assigned
|
|
115
120
|
multiple tags in this category). Forces a new resource if changed.
|
|
116
|
-
:param pulumi.Input[str] description: A description for the category.
|
|
121
|
+
:param pulumi.Input[_builtins.str] description: A description for the category.
|
|
117
122
|
|
|
118
123
|
> **NOTE:** You can add associable types to a category, but you cannot remove
|
|
119
124
|
them. Attempting to do so will result in an error.
|
|
120
|
-
:param pulumi.Input[str] name: The name of the category.
|
|
125
|
+
:param pulumi.Input[_builtins.str] name: The name of the category.
|
|
121
126
|
"""
|
|
122
127
|
if associable_types is not None:
|
|
123
128
|
pulumi.set(__self__, "associable_types", associable_types)
|
|
@@ -128,9 +133,9 @@ class _TagCategoryState:
|
|
|
128
133
|
if name is not None:
|
|
129
134
|
pulumi.set(__self__, "name", name)
|
|
130
135
|
|
|
131
|
-
@property
|
|
136
|
+
@_builtins.property
|
|
132
137
|
@pulumi.getter(name="associableTypes")
|
|
133
|
-
def associable_types(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
|
|
138
|
+
def associable_types(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]]:
|
|
134
139
|
"""
|
|
135
140
|
A list object types that this category is
|
|
136
141
|
valid to be assigned to. For a full list, click
|
|
@@ -139,12 +144,12 @@ class _TagCategoryState:
|
|
|
139
144
|
return pulumi.get(self, "associable_types")
|
|
140
145
|
|
|
141
146
|
@associable_types.setter
|
|
142
|
-
def associable_types(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
|
|
147
|
+
def associable_types(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]]):
|
|
143
148
|
pulumi.set(self, "associable_types", value)
|
|
144
149
|
|
|
145
|
-
@property
|
|
150
|
+
@_builtins.property
|
|
146
151
|
@pulumi.getter
|
|
147
|
-
def cardinality(self) -> Optional[pulumi.Input[str]]:
|
|
152
|
+
def cardinality(self) -> Optional[pulumi.Input[_builtins.str]]:
|
|
148
153
|
"""
|
|
149
154
|
The number of tags that can be assigned from this
|
|
150
155
|
category to a single object at once. Can be one of `SINGLE` (object can only
|
|
@@ -154,12 +159,12 @@ class _TagCategoryState:
|
|
|
154
159
|
return pulumi.get(self, "cardinality")
|
|
155
160
|
|
|
156
161
|
@cardinality.setter
|
|
157
|
-
def cardinality(self, value: Optional[pulumi.Input[str]]):
|
|
162
|
+
def cardinality(self, value: Optional[pulumi.Input[_builtins.str]]):
|
|
158
163
|
pulumi.set(self, "cardinality", value)
|
|
159
164
|
|
|
160
|
-
@property
|
|
165
|
+
@_builtins.property
|
|
161
166
|
@pulumi.getter
|
|
162
|
-
def description(self) -> Optional[pulumi.Input[str]]:
|
|
167
|
+
def description(self) -> Optional[pulumi.Input[_builtins.str]]:
|
|
163
168
|
"""
|
|
164
169
|
A description for the category.
|
|
165
170
|
|
|
@@ -169,48 +174,89 @@ class _TagCategoryState:
|
|
|
169
174
|
return pulumi.get(self, "description")
|
|
170
175
|
|
|
171
176
|
@description.setter
|
|
172
|
-
def description(self, value: Optional[pulumi.Input[str]]):
|
|
177
|
+
def description(self, value: Optional[pulumi.Input[_builtins.str]]):
|
|
173
178
|
pulumi.set(self, "description", value)
|
|
174
179
|
|
|
175
|
-
@property
|
|
180
|
+
@_builtins.property
|
|
176
181
|
@pulumi.getter
|
|
177
|
-
def name(self) -> Optional[pulumi.Input[str]]:
|
|
182
|
+
def name(self) -> Optional[pulumi.Input[_builtins.str]]:
|
|
178
183
|
"""
|
|
179
184
|
The name of the category.
|
|
180
185
|
"""
|
|
181
186
|
return pulumi.get(self, "name")
|
|
182
187
|
|
|
183
188
|
@name.setter
|
|
184
|
-
def name(self, value: Optional[pulumi.Input[str]]):
|
|
189
|
+
def name(self, value: Optional[pulumi.Input[_builtins.str]]):
|
|
185
190
|
pulumi.set(self, "name", value)
|
|
186
191
|
|
|
187
192
|
|
|
193
|
+
@pulumi.type_token("vsphere:index/tagCategory:TagCategory")
|
|
188
194
|
class TagCategory(pulumi.CustomResource):
|
|
189
195
|
@overload
|
|
190
196
|
def __init__(__self__,
|
|
191
197
|
resource_name: str,
|
|
192
198
|
opts: Optional[pulumi.ResourceOptions] = None,
|
|
193
|
-
associable_types: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
|
|
194
|
-
cardinality: Optional[pulumi.Input[str]] = None,
|
|
195
|
-
description: Optional[pulumi.Input[str]] = None,
|
|
196
|
-
name: Optional[pulumi.Input[str]] = None,
|
|
199
|
+
associable_types: Optional[pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]] = None,
|
|
200
|
+
cardinality: Optional[pulumi.Input[_builtins.str]] = None,
|
|
201
|
+
description: Optional[pulumi.Input[_builtins.str]] = None,
|
|
202
|
+
name: Optional[pulumi.Input[_builtins.str]] = None,
|
|
197
203
|
__props__=None):
|
|
198
204
|
"""
|
|
199
|
-
|
|
205
|
+
The `TagCategory` resource can be used to create and manage tag
|
|
206
|
+
categories, which determine how tags are grouped together and applied to
|
|
207
|
+
specific objects.
|
|
208
|
+
|
|
209
|
+
For more information about tags, click [here][ext-tags-general].
|
|
210
|
+
|
|
211
|
+
[ext-tags-general]: https://techdocs.broadcom.com/us/en/vmware-cis/vsphere/vsphere/8-0/vsphere-tags-and-attributes.html
|
|
212
|
+
|
|
213
|
+
## Example Usage
|
|
214
|
+
|
|
215
|
+
This example creates a tag category named `test-category`, with
|
|
216
|
+
single cardinality (meaning that only one tag in this category can be assigned
|
|
217
|
+
to an object at any given time). Tags in this category can only be assigned to
|
|
218
|
+
VMs and datastores.
|
|
219
|
+
|
|
220
|
+
```python
|
|
221
|
+
import pulumi
|
|
222
|
+
import pulumi_vsphere as vsphere
|
|
223
|
+
|
|
224
|
+
category = vsphere.TagCategory("category",
|
|
225
|
+
name="test-category",
|
|
226
|
+
description="Managed by Pulumi",
|
|
227
|
+
cardinality="SINGLE",
|
|
228
|
+
associable_types=[
|
|
229
|
+
"VirtualMachine",
|
|
230
|
+
"Datastore",
|
|
231
|
+
])
|
|
232
|
+
```
|
|
233
|
+
|
|
234
|
+
## Import
|
|
235
|
+
|
|
236
|
+
An existing tag category can be imported into this resource via
|
|
237
|
+
|
|
238
|
+
its name, using the following command:
|
|
239
|
+
|
|
240
|
+
[docs-import]: https://developer.hashicorp.com/terraform/cli/import
|
|
241
|
+
|
|
242
|
+
```sh
|
|
243
|
+
$ pulumi import vsphere:index/tagCategory:TagCategory category terraform-test-category
|
|
244
|
+
```
|
|
245
|
+
|
|
200
246
|
:param str resource_name: The name of the resource.
|
|
201
247
|
:param pulumi.ResourceOptions opts: Options for the resource.
|
|
202
|
-
:param pulumi.Input[Sequence[pulumi.Input[str]]] associable_types: A list object types that this category is
|
|
248
|
+
:param pulumi.Input[Sequence[pulumi.Input[_builtins.str]]] associable_types: A list object types that this category is
|
|
203
249
|
valid to be assigned to. For a full list, click
|
|
204
250
|
here.
|
|
205
|
-
:param pulumi.Input[str] cardinality: The number of tags that can be assigned from this
|
|
251
|
+
:param pulumi.Input[_builtins.str] cardinality: The number of tags that can be assigned from this
|
|
206
252
|
category to a single object at once. Can be one of `SINGLE` (object can only
|
|
207
253
|
be assigned one tag in this category), to `MULTIPLE` (object can be assigned
|
|
208
254
|
multiple tags in this category). Forces a new resource if changed.
|
|
209
|
-
:param pulumi.Input[str] description: A description for the category.
|
|
255
|
+
:param pulumi.Input[_builtins.str] description: A description for the category.
|
|
210
256
|
|
|
211
257
|
> **NOTE:** You can add associable types to a category, but you cannot remove
|
|
212
258
|
them. Attempting to do so will result in an error.
|
|
213
|
-
:param pulumi.Input[str] name: The name of the category.
|
|
259
|
+
:param pulumi.Input[_builtins.str] name: The name of the category.
|
|
214
260
|
"""
|
|
215
261
|
...
|
|
216
262
|
@overload
|
|
@@ -219,7 +265,47 @@ class TagCategory(pulumi.CustomResource):
|
|
|
219
265
|
args: TagCategoryArgs,
|
|
220
266
|
opts: Optional[pulumi.ResourceOptions] = None):
|
|
221
267
|
"""
|
|
222
|
-
|
|
268
|
+
The `TagCategory` resource can be used to create and manage tag
|
|
269
|
+
categories, which determine how tags are grouped together and applied to
|
|
270
|
+
specific objects.
|
|
271
|
+
|
|
272
|
+
For more information about tags, click [here][ext-tags-general].
|
|
273
|
+
|
|
274
|
+
[ext-tags-general]: https://techdocs.broadcom.com/us/en/vmware-cis/vsphere/vsphere/8-0/vsphere-tags-and-attributes.html
|
|
275
|
+
|
|
276
|
+
## Example Usage
|
|
277
|
+
|
|
278
|
+
This example creates a tag category named `test-category`, with
|
|
279
|
+
single cardinality (meaning that only one tag in this category can be assigned
|
|
280
|
+
to an object at any given time). Tags in this category can only be assigned to
|
|
281
|
+
VMs and datastores.
|
|
282
|
+
|
|
283
|
+
```python
|
|
284
|
+
import pulumi
|
|
285
|
+
import pulumi_vsphere as vsphere
|
|
286
|
+
|
|
287
|
+
category = vsphere.TagCategory("category",
|
|
288
|
+
name="test-category",
|
|
289
|
+
description="Managed by Pulumi",
|
|
290
|
+
cardinality="SINGLE",
|
|
291
|
+
associable_types=[
|
|
292
|
+
"VirtualMachine",
|
|
293
|
+
"Datastore",
|
|
294
|
+
])
|
|
295
|
+
```
|
|
296
|
+
|
|
297
|
+
## Import
|
|
298
|
+
|
|
299
|
+
An existing tag category can be imported into this resource via
|
|
300
|
+
|
|
301
|
+
its name, using the following command:
|
|
302
|
+
|
|
303
|
+
[docs-import]: https://developer.hashicorp.com/terraform/cli/import
|
|
304
|
+
|
|
305
|
+
```sh
|
|
306
|
+
$ pulumi import vsphere:index/tagCategory:TagCategory category terraform-test-category
|
|
307
|
+
```
|
|
308
|
+
|
|
223
309
|
:param str resource_name: The name of the resource.
|
|
224
310
|
:param TagCategoryArgs args: The arguments to use to populate this resource's properties.
|
|
225
311
|
:param pulumi.ResourceOptions opts: Options for the resource.
|
|
@@ -235,10 +321,10 @@ class TagCategory(pulumi.CustomResource):
|
|
|
235
321
|
def _internal_init(__self__,
|
|
236
322
|
resource_name: str,
|
|
237
323
|
opts: Optional[pulumi.ResourceOptions] = None,
|
|
238
|
-
associable_types: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
|
|
239
|
-
cardinality: Optional[pulumi.Input[str]] = None,
|
|
240
|
-
description: Optional[pulumi.Input[str]] = None,
|
|
241
|
-
name: Optional[pulumi.Input[str]] = None,
|
|
324
|
+
associable_types: Optional[pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]] = None,
|
|
325
|
+
cardinality: Optional[pulumi.Input[_builtins.str]] = None,
|
|
326
|
+
description: Optional[pulumi.Input[_builtins.str]] = None,
|
|
327
|
+
name: Optional[pulumi.Input[_builtins.str]] = None,
|
|
242
328
|
__props__=None):
|
|
243
329
|
opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts)
|
|
244
330
|
if not isinstance(opts, pulumi.ResourceOptions):
|
|
@@ -266,10 +352,10 @@ class TagCategory(pulumi.CustomResource):
|
|
|
266
352
|
def get(resource_name: str,
|
|
267
353
|
id: pulumi.Input[str],
|
|
268
354
|
opts: Optional[pulumi.ResourceOptions] = None,
|
|
269
|
-
associable_types: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
|
|
270
|
-
cardinality: Optional[pulumi.Input[str]] = None,
|
|
271
|
-
description: Optional[pulumi.Input[str]] = None,
|
|
272
|
-
name: Optional[pulumi.Input[str]] = None) -> 'TagCategory':
|
|
355
|
+
associable_types: Optional[pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]] = None,
|
|
356
|
+
cardinality: Optional[pulumi.Input[_builtins.str]] = None,
|
|
357
|
+
description: Optional[pulumi.Input[_builtins.str]] = None,
|
|
358
|
+
name: Optional[pulumi.Input[_builtins.str]] = None) -> 'TagCategory':
|
|
273
359
|
"""
|
|
274
360
|
Get an existing TagCategory resource's state with the given name, id, and optional extra
|
|
275
361
|
properties used to qualify the lookup.
|
|
@@ -277,18 +363,18 @@ class TagCategory(pulumi.CustomResource):
|
|
|
277
363
|
:param str resource_name: The unique name of the resulting resource.
|
|
278
364
|
:param pulumi.Input[str] id: The unique provider ID of the resource to lookup.
|
|
279
365
|
:param pulumi.ResourceOptions opts: Options for the resource.
|
|
280
|
-
:param pulumi.Input[Sequence[pulumi.Input[str]]] associable_types: A list object types that this category is
|
|
366
|
+
:param pulumi.Input[Sequence[pulumi.Input[_builtins.str]]] associable_types: A list object types that this category is
|
|
281
367
|
valid to be assigned to. For a full list, click
|
|
282
368
|
here.
|
|
283
|
-
:param pulumi.Input[str] cardinality: The number of tags that can be assigned from this
|
|
369
|
+
:param pulumi.Input[_builtins.str] cardinality: The number of tags that can be assigned from this
|
|
284
370
|
category to a single object at once. Can be one of `SINGLE` (object can only
|
|
285
371
|
be assigned one tag in this category), to `MULTIPLE` (object can be assigned
|
|
286
372
|
multiple tags in this category). Forces a new resource if changed.
|
|
287
|
-
:param pulumi.Input[str] description: A description for the category.
|
|
373
|
+
:param pulumi.Input[_builtins.str] description: A description for the category.
|
|
288
374
|
|
|
289
375
|
> **NOTE:** You can add associable types to a category, but you cannot remove
|
|
290
376
|
them. Attempting to do so will result in an error.
|
|
291
|
-
:param pulumi.Input[str] name: The name of the category.
|
|
377
|
+
:param pulumi.Input[_builtins.str] name: The name of the category.
|
|
292
378
|
"""
|
|
293
379
|
opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
|
|
294
380
|
|
|
@@ -300,9 +386,9 @@ class TagCategory(pulumi.CustomResource):
|
|
|
300
386
|
__props__.__dict__["name"] = name
|
|
301
387
|
return TagCategory(resource_name, opts=opts, __props__=__props__)
|
|
302
388
|
|
|
303
|
-
@property
|
|
389
|
+
@_builtins.property
|
|
304
390
|
@pulumi.getter(name="associableTypes")
|
|
305
|
-
def associable_types(self) -> pulumi.Output[Sequence[str]]:
|
|
391
|
+
def associable_types(self) -> pulumi.Output[Sequence[_builtins.str]]:
|
|
306
392
|
"""
|
|
307
393
|
A list object types that this category is
|
|
308
394
|
valid to be assigned to. For a full list, click
|
|
@@ -310,9 +396,9 @@ class TagCategory(pulumi.CustomResource):
|
|
|
310
396
|
"""
|
|
311
397
|
return pulumi.get(self, "associable_types")
|
|
312
398
|
|
|
313
|
-
@property
|
|
399
|
+
@_builtins.property
|
|
314
400
|
@pulumi.getter
|
|
315
|
-
def cardinality(self) -> pulumi.Output[str]:
|
|
401
|
+
def cardinality(self) -> pulumi.Output[_builtins.str]:
|
|
316
402
|
"""
|
|
317
403
|
The number of tags that can be assigned from this
|
|
318
404
|
category to a single object at once. Can be one of `SINGLE` (object can only
|
|
@@ -321,9 +407,9 @@ class TagCategory(pulumi.CustomResource):
|
|
|
321
407
|
"""
|
|
322
408
|
return pulumi.get(self, "cardinality")
|
|
323
409
|
|
|
324
|
-
@property
|
|
410
|
+
@_builtins.property
|
|
325
411
|
@pulumi.getter
|
|
326
|
-
def description(self) -> pulumi.Output[Optional[str]]:
|
|
412
|
+
def description(self) -> pulumi.Output[Optional[_builtins.str]]:
|
|
327
413
|
"""
|
|
328
414
|
A description for the category.
|
|
329
415
|
|
|
@@ -332,9 +418,9 @@ class TagCategory(pulumi.CustomResource):
|
|
|
332
418
|
"""
|
|
333
419
|
return pulumi.get(self, "description")
|
|
334
420
|
|
|
335
|
-
@property
|
|
421
|
+
@_builtins.property
|
|
336
422
|
@pulumi.getter
|
|
337
|
-
def name(self) -> pulumi.Output[str]:
|
|
423
|
+
def name(self) -> pulumi.Output[_builtins.str]:
|
|
338
424
|
"""
|
|
339
425
|
The name of the category.
|
|
340
426
|
"""
|