vsphere-automation-cis 0.4.2 → 0.4.7
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/LICENSE +20 -0
- data/lib/vsphere-automation-cis/api_client.rb +260 -0
- data/lib/vsphere-automation-cis/api_error.rb +34 -0
- data/lib/vsphere-automation-cis/configuration.rb +212 -0
- data/lib/vsphere-automation-cis/version.rb +1 -1
- metadata +13 -280
- data/Gemfile +0 -13
- data/Gemfile.lock +0 -78
- data/README.md +0 -180
- data/Rakefile +0 -18
- data/docs/CisSessionCreateResult.md +0 -8
- data/docs/CisSessionInfo.md +0 -10
- data/docs/CisSessionResult.md +0 -8
- data/docs/CisTaggingCategoryAddToUsedBy.md +0 -8
- data/docs/CisTaggingCategoryCreate.md +0 -8
- data/docs/CisTaggingCategoryCreateResult.md +0 -8
- data/docs/CisTaggingCategoryCreateSpec.md +0 -12
- data/docs/CisTaggingCategoryListResult.md +0 -8
- data/docs/CisTaggingCategoryListUsedCategories.md +0 -8
- data/docs/CisTaggingCategoryListUsedCategoriesResult.md +0 -8
- data/docs/CisTaggingCategoryModel.md +0 -13
- data/docs/CisTaggingCategoryModelCardinality.md +0 -7
- data/docs/CisTaggingCategoryRemoveFromUsedBy.md +0 -8
- data/docs/CisTaggingCategoryResult.md +0 -8
- data/docs/CisTaggingCategoryUpdate.md +0 -8
- data/docs/CisTaggingCategoryUpdateSpec.md +0 -11
- data/docs/CisTaggingTagAddToUsedBy.md +0 -8
- data/docs/CisTaggingTagAssociationAttach.md +0 -8
- data/docs/CisTaggingTagAssociationAttachMultipleTagsToObject.md +0 -9
- data/docs/CisTaggingTagAssociationAttachMultipleTagsToObjectResult.md +0 -8
- data/docs/CisTaggingTagAssociationAttachTagToMultipleObjects.md +0 -8
- data/docs/CisTaggingTagAssociationAttachTagToMultipleObjectsResult.md +0 -8
- data/docs/CisTaggingTagAssociationBatchResult.md +0 -9
- data/docs/CisTaggingTagAssociationDetach.md +0 -8
- data/docs/CisTaggingTagAssociationDetachMultipleTagsFromObject.md +0 -9
- data/docs/CisTaggingTagAssociationDetachMultipleTagsFromObjectResult.md +0 -8
- data/docs/CisTaggingTagAssociationDetachTagFromMultipleObjects.md +0 -8
- data/docs/CisTaggingTagAssociationDetachTagFromMultipleObjectsResult.md +0 -8
- data/docs/CisTaggingTagAssociationListAttachableTags.md +0 -8
- data/docs/CisTaggingTagAssociationListAttachableTagsResult.md +0 -8
- data/docs/CisTaggingTagAssociationListAttachedObjectsOnTags.md +0 -8
- data/docs/CisTaggingTagAssociationListAttachedObjectsOnTagsResult.md +0 -8
- data/docs/CisTaggingTagAssociationListAttachedObjectsResult.md +0 -8
- data/docs/CisTaggingTagAssociationListAttachedTags.md +0 -8
- data/docs/CisTaggingTagAssociationListAttachedTagsOnObjects.md +0 -8
- data/docs/CisTaggingTagAssociationListAttachedTagsOnObjectsResult.md +0 -8
- data/docs/CisTaggingTagAssociationListAttachedTagsResult.md +0 -8
- data/docs/CisTaggingTagAssociationObjectToTags.md +0 -9
- data/docs/CisTaggingTagAssociationTagToObjects.md +0 -9
- data/docs/CisTaggingTagCreate.md +0 -8
- data/docs/CisTaggingTagCreateResult.md +0 -8
- data/docs/CisTaggingTagCreateSpec.md +0 -11
- data/docs/CisTaggingTagListResult.md +0 -8
- data/docs/CisTaggingTagListTagsForCategoryResult.md +0 -8
- data/docs/CisTaggingTagListUsedTags.md +0 -8
- data/docs/CisTaggingTagListUsedTagsResult.md +0 -8
- data/docs/CisTaggingTagModel.md +0 -12
- data/docs/CisTaggingTagRemoveFromUsedBy.md +0 -8
- data/docs/CisTaggingTagResult.md +0 -8
- data/docs/CisTaggingTagUpdate.md +0 -8
- data/docs/CisTaggingTagUpdateSpec.md +0 -9
- data/docs/CisTaskInfo.md +0 -19
- data/docs/CisTaskProgress.md +0 -10
- data/docs/CisTaskStatus.md +0 -7
- data/docs/CisTasksFilterSpec.md +0 -12
- data/docs/CisTasksGetSpec.md +0 -9
- data/docs/CisTasksListResult.md +0 -8
- data/docs/CisTasksListResultValue.md +0 -9
- data/docs/CisTasksResult.md +0 -8
- data/docs/FilterSpecTargets.md +0 -9
- data/docs/SessionApi.md +0 -151
- data/docs/TaggingCategoryApi.md +0 -464
- data/docs/TaggingTagApi.md +0 -515
- data/docs/TaggingTagAssociationApi.md +0 -575
- data/docs/TasksApi.md +0 -180
- data/docs/VapiStdDynamicID.md +0 -9
- data/docs/VapiStdErrorsAlreadyExists.md +0 -9
- data/docs/VapiStdErrorsAlreadyExistsError.md +0 -9
- data/docs/VapiStdErrorsError.md +0 -9
- data/docs/VapiStdErrorsErrorError.md +0 -9
- data/docs/VapiStdErrorsInvalidArgument.md +0 -9
- data/docs/VapiStdErrorsInvalidArgumentError.md +0 -9
- data/docs/VapiStdErrorsNotAllowedInCurrentState.md +0 -9
- data/docs/VapiStdErrorsNotAllowedInCurrentStateError.md +0 -9
- data/docs/VapiStdErrorsNotFound.md +0 -9
- data/docs/VapiStdErrorsNotFoundError.md +0 -9
- data/docs/VapiStdErrorsResourceInaccessible.md +0 -9
- data/docs/VapiStdErrorsResourceInaccessibleError.md +0 -9
- data/docs/VapiStdErrorsServiceUnavailable.md +0 -9
- data/docs/VapiStdErrorsServiceUnavailableError.md +0 -9
- data/docs/VapiStdErrorsUnauthenticated.md +0 -9
- data/docs/VapiStdErrorsUnauthenticatedError.md +0 -9
- data/docs/VapiStdErrorsUnauthorized.md +0 -9
- data/docs/VapiStdErrorsUnauthorizedError.md +0 -9
- data/docs/VapiStdErrorsUnsupported.md +0 -9
- data/docs/VapiStdErrorsUnsupportedError.md +0 -9
- data/docs/VapiStdLocalizableMessage.md +0 -10
- data/git_push.sh +0 -55
- data/pkg/vsphere-automation-cis-0.4.1.gem +0 -0
- data/pkg/vsphere-automation-cis-0.4.2.gem +0 -0
- data/spec/api/session_api_spec.rb +0 -62
- data/spec/api/tagging_category_api_spec.rb +0 -132
- data/spec/api/tagging_tag_api_spec.rb +0 -143
- data/spec/api/tagging_tag_association_api_spec.rb +0 -156
- data/spec/api/tasks_api_spec.rb +0 -72
- data/spec/models/cis_session_create_result_spec.rb +0 -37
- data/spec/models/cis_session_info_spec.rb +0 -49
- data/spec/models/cis_session_result_spec.rb +0 -37
- data/spec/models/cis_tagging_category_add_to_used_by_spec.rb +0 -37
- data/spec/models/cis_tagging_category_create_result_spec.rb +0 -37
- data/spec/models/cis_tagging_category_create_spec.rb +0 -37
- data/spec/models/cis_tagging_category_create_spec_spec.rb +0 -61
- data/spec/models/cis_tagging_category_list_result_spec.rb +0 -37
- data/spec/models/cis_tagging_category_list_used_categories_result_spec.rb +0 -37
- data/spec/models/cis_tagging_category_list_used_categories_spec.rb +0 -37
- data/spec/models/cis_tagging_category_model_cardinality_spec.rb +0 -31
- data/spec/models/cis_tagging_category_model_spec.rb +0 -67
- data/spec/models/cis_tagging_category_remove_from_used_by_spec.rb +0 -37
- data/spec/models/cis_tagging_category_result_spec.rb +0 -37
- data/spec/models/cis_tagging_category_update_spec.rb +0 -37
- data/spec/models/cis_tagging_category_update_spec_spec.rb +0 -55
- data/spec/models/cis_tagging_tag_add_to_used_by_spec.rb +0 -37
- data/spec/models/cis_tagging_tag_association_attach_multiple_tags_to_object_result_spec.rb +0 -37
- data/spec/models/cis_tagging_tag_association_attach_multiple_tags_to_object_spec.rb +0 -43
- data/spec/models/cis_tagging_tag_association_attach_spec.rb +0 -37
- data/spec/models/cis_tagging_tag_association_attach_tag_to_multiple_objects_result_spec.rb +0 -37
- data/spec/models/cis_tagging_tag_association_attach_tag_to_multiple_objects_spec.rb +0 -37
- data/spec/models/cis_tagging_tag_association_batch_result_spec.rb +0 -43
- data/spec/models/cis_tagging_tag_association_detach_multiple_tags_from_object_result_spec.rb +0 -37
- data/spec/models/cis_tagging_tag_association_detach_multiple_tags_from_object_spec.rb +0 -43
- data/spec/models/cis_tagging_tag_association_detach_spec.rb +0 -37
- data/spec/models/cis_tagging_tag_association_detach_tag_from_multiple_objects_result_spec.rb +0 -37
- data/spec/models/cis_tagging_tag_association_detach_tag_from_multiple_objects_spec.rb +0 -37
- data/spec/models/cis_tagging_tag_association_list_attachable_tags_result_spec.rb +0 -37
- data/spec/models/cis_tagging_tag_association_list_attachable_tags_spec.rb +0 -37
- data/spec/models/cis_tagging_tag_association_list_attached_objects_on_tags_result_spec.rb +0 -37
- data/spec/models/cis_tagging_tag_association_list_attached_objects_on_tags_spec.rb +0 -37
- data/spec/models/cis_tagging_tag_association_list_attached_objects_result_spec.rb +0 -37
- data/spec/models/cis_tagging_tag_association_list_attached_tags_on_objects_result_spec.rb +0 -37
- data/spec/models/cis_tagging_tag_association_list_attached_tags_on_objects_spec.rb +0 -37
- data/spec/models/cis_tagging_tag_association_list_attached_tags_result_spec.rb +0 -37
- data/spec/models/cis_tagging_tag_association_list_attached_tags_spec.rb +0 -37
- data/spec/models/cis_tagging_tag_association_object_to_tags_spec.rb +0 -43
- data/spec/models/cis_tagging_tag_association_tag_to_objects_spec.rb +0 -43
- data/spec/models/cis_tagging_tag_create_result_spec.rb +0 -37
- data/spec/models/cis_tagging_tag_create_spec.rb +0 -37
- data/spec/models/cis_tagging_tag_create_spec_spec.rb +0 -55
- data/spec/models/cis_tagging_tag_list_result_spec.rb +0 -37
- data/spec/models/cis_tagging_tag_list_tags_for_category_result_spec.rb +0 -37
- data/spec/models/cis_tagging_tag_list_used_tags_result_spec.rb +0 -37
- data/spec/models/cis_tagging_tag_list_used_tags_spec.rb +0 -37
- data/spec/models/cis_tagging_tag_model_spec.rb +0 -61
- data/spec/models/cis_tagging_tag_remove_from_used_by_spec.rb +0 -37
- data/spec/models/cis_tagging_tag_result_spec.rb +0 -37
- data/spec/models/cis_tagging_tag_update_spec.rb +0 -37
- data/spec/models/cis_tagging_tag_update_spec_spec.rb +0 -43
- data/spec/models/cis_task_info_spec.rb +0 -103
- data/spec/models/cis_task_progress_spec.rb +0 -49
- data/spec/models/cis_task_status_spec.rb +0 -31
- data/spec/models/cis_tasks_filter_spec_spec.rb +0 -61
- data/spec/models/cis_tasks_get_spec_spec.rb +0 -43
- data/spec/models/cis_tasks_list_result_spec.rb +0 -37
- data/spec/models/cis_tasks_list_result_value_spec.rb +0 -43
- data/spec/models/cis_tasks_result_spec.rb +0 -37
- data/spec/models/filter_spec_targets_spec.rb +0 -43
- data/spec/models/vapi_std_dynamic_id_spec.rb +0 -43
- data/spec/models/vapi_std_errors_already_exists_error_spec.rb +0 -43
- data/spec/models/vapi_std_errors_already_exists_spec.rb +0 -43
- data/spec/models/vapi_std_errors_error_error_spec.rb +0 -43
- data/spec/models/vapi_std_errors_error_spec.rb +0 -43
- data/spec/models/vapi_std_errors_invalid_argument_error_spec.rb +0 -43
- data/spec/models/vapi_std_errors_invalid_argument_spec.rb +0 -43
- data/spec/models/vapi_std_errors_not_allowed_in_current_state_error_spec.rb +0 -43
- data/spec/models/vapi_std_errors_not_allowed_in_current_state_spec.rb +0 -43
- data/spec/models/vapi_std_errors_not_found_error_spec.rb +0 -43
- data/spec/models/vapi_std_errors_not_found_spec.rb +0 -43
- data/spec/models/vapi_std_errors_resource_inaccessible_error_spec.rb +0 -43
- data/spec/models/vapi_std_errors_resource_inaccessible_spec.rb +0 -43
- data/spec/models/vapi_std_errors_service_unavailable_error_spec.rb +0 -43
- data/spec/models/vapi_std_errors_service_unavailable_spec.rb +0 -43
- data/spec/models/vapi_std_errors_unauthenticated_error_spec.rb +0 -43
- data/spec/models/vapi_std_errors_unauthenticated_spec.rb +0 -43
- data/spec/models/vapi_std_errors_unauthorized_error_spec.rb +0 -43
- data/spec/models/vapi_std_errors_unauthorized_spec.rb +0 -43
- data/spec/models/vapi_std_errors_unsupported_error_spec.rb +0 -43
- data/spec/models/vapi_std_errors_unsupported_spec.rb +0 -43
- data/spec/models/vapi_std_localizable_message_spec.rb +0 -49
- data/spec/spec_helper.rb +0 -110
- data/vsphere-automation-cis.gemspec +0 -39
@@ -1,575 +0,0 @@
|
|
1
|
-
# VSphereAutomation::CIS::TaggingTagAssociationApi
|
2
|
-
|
3
|
-
All URIs are relative to *https://<vcenter>/rest*
|
4
|
-
|
5
|
-
Method | HTTP request | Description
|
6
|
-
------------- | ------------- | -------------
|
7
|
-
[**attach**](TaggingTagAssociationApi.md#attach) | **POST** /com/vmware/cis/tagging/tag-association/id:{tag_id}?~action=attach | Attaches the given tag to the input object. The tag needs to meet the cardinality ({@link CategoryModel#cardinality}) and associability ({@link CategoryModel#associableTypes}) criteria in order to be eligible for attachment. If the tag is already attached to the object, then this {@term operation} is a no-op and an error will not be thrown. To invoke this {@term operation}, you need the attach tag privilege on the tag and the read privilege on the object.
|
8
|
-
[**attach_multiple_tags_to_object**](TaggingTagAssociationApi.md#attach_multiple_tags_to_object) | **POST** /com/vmware/cis/tagging/tag-association?~action=attach-multiple-tags-to-object | Attaches the given tags to the input object. If a tag is already attached to the object, then the individual {@term operation} is a no-op and an error will not be added to {@link BatchResult#errorMessages}. To invoke this {@term operation}, you need the read privilege on the object and the attach tag privilege on each tag.
|
9
|
-
[**attach_tag_to_multiple_objects**](TaggingTagAssociationApi.md#attach_tag_to_multiple_objects) | **POST** /com/vmware/cis/tagging/tag-association/id:{tag_id}?~action=attach-tag-to-multiple-objects | Attaches the given tag to the input objects. If a tag is already attached to the object, then the individual {@term operation} is a no-op and an error will not be added to {@link BatchResult#errorMessages}. To invoke this {@term operation}, you need the attach tag privilege on the tag and the read privilege on each object.
|
10
|
-
[**detach**](TaggingTagAssociationApi.md#detach) | **POST** /com/vmware/cis/tagging/tag-association/id:{tag_id}?~action=detach | Detaches the tag from the given object. If the tag is already removed from the object, then this {@term operation} is a no-op and an error will not be thrown. To invoke this {@term operation}, you need the attach tag privilege on the tag and the read privilege on the object.
|
11
|
-
[**detach_multiple_tags_from_object**](TaggingTagAssociationApi.md#detach_multiple_tags_from_object) | **POST** /com/vmware/cis/tagging/tag-association?~action=detach-multiple-tags-from-object | Detaches the given tags from the input object. If a tag is already removed from the object, then the individual {@term operation} is a no-op and an error will not be added to {@link BatchResult#errorMessages}. To invoke this {@term operation}, you need the read privilege on the object and the attach tag privilege each tag.
|
12
|
-
[**detach_tag_from_multiple_objects**](TaggingTagAssociationApi.md#detach_tag_from_multiple_objects) | **POST** /com/vmware/cis/tagging/tag-association/id:{tag_id}?~action=detach-tag-from-multiple-objects | Detaches the given tag from the input objects. If a tag is already removed from the object, then the individual {@term operation} is a no-op and an error will not be added to {@link BatchResult#errorMessages}. To invoke this {@term operation}, you need the attach tag privilege on the tag and the read privilege on each object.
|
13
|
-
[**list_attachable_tags**](TaggingTagAssociationApi.md#list_attachable_tags) | **POST** /com/vmware/cis/tagging/tag-association?~action=list-attachable-tags | Fetches the {@term list} of attachable tags for the given object, omitting the tags that have already been attached. Criteria for attachability is calculated based on tagging cardinality ({@link CategoryModel#cardinality}) and associability ({@link CategoryModel#associableTypes}) constructs. To invoke this {@term operation}, you need the read privilege on the input object. The {@term list} will only contain those tags for which you have read privileges.
|
14
|
-
[**list_attached_objects**](TaggingTagAssociationApi.md#list_attached_objects) | **POST** /com/vmware/cis/tagging/tag-association/id:{tag_id}?~action=list-attached-objects | Fetches the {@term list} of attached objects for the given tag. To invoke this {@term operation}, you need the read privilege on the input tag. Only those objects for which you have the read privilege will be returned.
|
15
|
-
[**list_attached_objects_on_tags**](TaggingTagAssociationApi.md#list_attached_objects_on_tags) | **POST** /com/vmware/cis/tagging/tag-association?~action=list-attached-objects-on-tags | Fetches the {@term list} of {@link TagToObjects} describing the input tag identifiers and the objects they are attached to. To invoke this {@term operation}, you need the read privilege on each input tag. The {@link TagToObjects#objectIds} will only contain those objects for which you have the read privilege.
|
16
|
-
[**list_attached_tags**](TaggingTagAssociationApi.md#list_attached_tags) | **POST** /com/vmware/cis/tagging/tag-association?~action=list-attached-tags | Fetches the {@term list} of tags attached to the given object. To invoke this {@term operation}, you need the read privilege on the input object. The {@term list} will only contain those tags for which you have the read privileges.
|
17
|
-
[**list_attached_tags_on_objects**](TaggingTagAssociationApi.md#list_attached_tags_on_objects) | **POST** /com/vmware/cis/tagging/tag-association?~action=list-attached-tags-on-objects | Fetches the {@term list} of {@link ObjectToTags} describing the input object identifiers and the tags attached to each object. To invoke this {@term operation}, you need the read privilege on each input object. The {@link ObjectToTags#tagIds} will only contain those tags for which you have the read privilege.
|
18
|
-
|
19
|
-
|
20
|
-
# **attach**
|
21
|
-
> attach(tag_id, request_body)
|
22
|
-
|
23
|
-
Attaches the given tag to the input object. The tag needs to meet the cardinality ({@link CategoryModel#cardinality}) and associability ({@link CategoryModel#associableTypes}) criteria in order to be eligible for attachment. If the tag is already attached to the object, then this {@term operation} is a no-op and an error will not be thrown. To invoke this {@term operation}, you need the attach tag privilege on the tag and the read privilege on the object.
|
24
|
-
|
25
|
-
### Example
|
26
|
-
```ruby
|
27
|
-
# load the gem
|
28
|
-
require 'vsphere-automation-cis'
|
29
|
-
# setup authorization
|
30
|
-
VSphereAutomation::Configuration.new.tap do |config|
|
31
|
-
# Configure API key authorization: api_key
|
32
|
-
config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
|
33
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
34
|
-
#config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
|
35
|
-
end
|
36
|
-
|
37
|
-
api_instance = VSphereAutomation::CIS::TaggingTagAssociationApi.new
|
38
|
-
tag_id = 'tag_id_example' # String | The identifier of the input tag.
|
39
|
-
request_body = CIS::CisTaggingTagAssociationAttach.new # CisTaggingTagAssociationAttach |
|
40
|
-
|
41
|
-
begin
|
42
|
-
#Attaches the given tag to the input object. The tag needs to meet the cardinality ({@link CategoryModel#cardinality}) and associability ({@link CategoryModel#associableTypes}) criteria in order to be eligible for attachment. If the tag is already attached to the object, then this {@term operation} is a no-op and an error will not be thrown. To invoke this {@term operation}, you need the attach tag privilege on the tag and the read privilege on the object.
|
43
|
-
api_instance.attach(tag_id, request_body)
|
44
|
-
rescue VSphereAutomation::ApiError => e
|
45
|
-
puts "Exception when calling TaggingTagAssociationApi->attach: #{e}"
|
46
|
-
end
|
47
|
-
```
|
48
|
-
|
49
|
-
### Parameters
|
50
|
-
|
51
|
-
Name | Type | Description | Notes
|
52
|
-
------------- | ------------- | ------------- | -------------
|
53
|
-
**tag_id** | **String**| The identifier of the input tag. |
|
54
|
-
**request_body** | [**CisTaggingTagAssociationAttach**](CisTaggingTagAssociationAttach.md)| |
|
55
|
-
|
56
|
-
### Return type
|
57
|
-
|
58
|
-
nil (empty response body)
|
59
|
-
|
60
|
-
### Authorization
|
61
|
-
|
62
|
-
[api_key](../README.md#api_key)
|
63
|
-
|
64
|
-
### HTTP request headers
|
65
|
-
|
66
|
-
- **Content-Type**: application/json
|
67
|
-
- **Accept**: application/json
|
68
|
-
|
69
|
-
|
70
|
-
|
71
|
-
# **attach_multiple_tags_to_object**
|
72
|
-
> CisTaggingTagAssociationAttachMultipleTagsToObjectResult attach_multiple_tags_to_object(request_body)
|
73
|
-
|
74
|
-
Attaches the given tags to the input object. If a tag is already attached to the object, then the individual {@term operation} is a no-op and an error will not be added to {@link BatchResult#errorMessages}. To invoke this {@term operation}, you need the read privilege on the object and the attach tag privilege on each tag.
|
75
|
-
|
76
|
-
### Example
|
77
|
-
```ruby
|
78
|
-
# load the gem
|
79
|
-
require 'vsphere-automation-cis'
|
80
|
-
# setup authorization
|
81
|
-
VSphereAutomation::Configuration.new.tap do |config|
|
82
|
-
# Configure API key authorization: api_key
|
83
|
-
config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
|
84
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
85
|
-
#config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
|
86
|
-
end
|
87
|
-
|
88
|
-
api_instance = VSphereAutomation::CIS::TaggingTagAssociationApi.new
|
89
|
-
request_body = CIS::CisTaggingTagAssociationAttachMultipleTagsToObject.new # CisTaggingTagAssociationAttachMultipleTagsToObject |
|
90
|
-
|
91
|
-
begin
|
92
|
-
#Attaches the given tags to the input object. If a tag is already attached to the object, then the individual {@term operation} is a no-op and an error will not be added to {@link BatchResult#errorMessages}. To invoke this {@term operation}, you need the read privilege on the object and the attach tag privilege on each tag.
|
93
|
-
result = api_instance.attach_multiple_tags_to_object(request_body)
|
94
|
-
p result
|
95
|
-
rescue VSphereAutomation::ApiError => e
|
96
|
-
puts "Exception when calling TaggingTagAssociationApi->attach_multiple_tags_to_object: #{e}"
|
97
|
-
end
|
98
|
-
```
|
99
|
-
|
100
|
-
### Parameters
|
101
|
-
|
102
|
-
Name | Type | Description | Notes
|
103
|
-
------------- | ------------- | ------------- | -------------
|
104
|
-
**request_body** | [**CisTaggingTagAssociationAttachMultipleTagsToObject**](CisTaggingTagAssociationAttachMultipleTagsToObject.md)| |
|
105
|
-
|
106
|
-
### Return type
|
107
|
-
|
108
|
-
[**CisTaggingTagAssociationAttachMultipleTagsToObjectResult**](CisTaggingTagAssociationAttachMultipleTagsToObjectResult.md)
|
109
|
-
|
110
|
-
### Authorization
|
111
|
-
|
112
|
-
[api_key](../README.md#api_key)
|
113
|
-
|
114
|
-
### HTTP request headers
|
115
|
-
|
116
|
-
- **Content-Type**: application/json
|
117
|
-
- **Accept**: application/json
|
118
|
-
|
119
|
-
|
120
|
-
|
121
|
-
# **attach_tag_to_multiple_objects**
|
122
|
-
> CisTaggingTagAssociationAttachTagToMultipleObjectsResult attach_tag_to_multiple_objects(tag_id, request_body)
|
123
|
-
|
124
|
-
Attaches the given tag to the input objects. If a tag is already attached to the object, then the individual {@term operation} is a no-op and an error will not be added to {@link BatchResult#errorMessages}. To invoke this {@term operation}, you need the attach tag privilege on the tag and the read privilege on each object.
|
125
|
-
|
126
|
-
### Example
|
127
|
-
```ruby
|
128
|
-
# load the gem
|
129
|
-
require 'vsphere-automation-cis'
|
130
|
-
# setup authorization
|
131
|
-
VSphereAutomation::Configuration.new.tap do |config|
|
132
|
-
# Configure API key authorization: api_key
|
133
|
-
config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
|
134
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
135
|
-
#config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
|
136
|
-
end
|
137
|
-
|
138
|
-
api_instance = VSphereAutomation::CIS::TaggingTagAssociationApi.new
|
139
|
-
tag_id = 'tag_id_example' # String | The identifier of the input tag.
|
140
|
-
request_body = CIS::CisTaggingTagAssociationAttachTagToMultipleObjects.new # CisTaggingTagAssociationAttachTagToMultipleObjects |
|
141
|
-
|
142
|
-
begin
|
143
|
-
#Attaches the given tag to the input objects. If a tag is already attached to the object, then the individual {@term operation} is a no-op and an error will not be added to {@link BatchResult#errorMessages}. To invoke this {@term operation}, you need the attach tag privilege on the tag and the read privilege on each object.
|
144
|
-
result = api_instance.attach_tag_to_multiple_objects(tag_id, request_body)
|
145
|
-
p result
|
146
|
-
rescue VSphereAutomation::ApiError => e
|
147
|
-
puts "Exception when calling TaggingTagAssociationApi->attach_tag_to_multiple_objects: #{e}"
|
148
|
-
end
|
149
|
-
```
|
150
|
-
|
151
|
-
### Parameters
|
152
|
-
|
153
|
-
Name | Type | Description | Notes
|
154
|
-
------------- | ------------- | ------------- | -------------
|
155
|
-
**tag_id** | **String**| The identifier of the input tag. |
|
156
|
-
**request_body** | [**CisTaggingTagAssociationAttachTagToMultipleObjects**](CisTaggingTagAssociationAttachTagToMultipleObjects.md)| |
|
157
|
-
|
158
|
-
### Return type
|
159
|
-
|
160
|
-
[**CisTaggingTagAssociationAttachTagToMultipleObjectsResult**](CisTaggingTagAssociationAttachTagToMultipleObjectsResult.md)
|
161
|
-
|
162
|
-
### Authorization
|
163
|
-
|
164
|
-
[api_key](../README.md#api_key)
|
165
|
-
|
166
|
-
### HTTP request headers
|
167
|
-
|
168
|
-
- **Content-Type**: application/json
|
169
|
-
- **Accept**: application/json
|
170
|
-
|
171
|
-
|
172
|
-
|
173
|
-
# **detach**
|
174
|
-
> detach(tag_id, request_body)
|
175
|
-
|
176
|
-
Detaches the tag from the given object. If the tag is already removed from the object, then this {@term operation} is a no-op and an error will not be thrown. To invoke this {@term operation}, you need the attach tag privilege on the tag and the read privilege on the object.
|
177
|
-
|
178
|
-
### Example
|
179
|
-
```ruby
|
180
|
-
# load the gem
|
181
|
-
require 'vsphere-automation-cis'
|
182
|
-
# setup authorization
|
183
|
-
VSphereAutomation::Configuration.new.tap do |config|
|
184
|
-
# Configure API key authorization: api_key
|
185
|
-
config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
|
186
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
187
|
-
#config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
|
188
|
-
end
|
189
|
-
|
190
|
-
api_instance = VSphereAutomation::CIS::TaggingTagAssociationApi.new
|
191
|
-
tag_id = 'tag_id_example' # String | The identifier of the input tag.
|
192
|
-
request_body = CIS::CisTaggingTagAssociationDetach.new # CisTaggingTagAssociationDetach |
|
193
|
-
|
194
|
-
begin
|
195
|
-
#Detaches the tag from the given object. If the tag is already removed from the object, then this {@term operation} is a no-op and an error will not be thrown. To invoke this {@term operation}, you need the attach tag privilege on the tag and the read privilege on the object.
|
196
|
-
api_instance.detach(tag_id, request_body)
|
197
|
-
rescue VSphereAutomation::ApiError => e
|
198
|
-
puts "Exception when calling TaggingTagAssociationApi->detach: #{e}"
|
199
|
-
end
|
200
|
-
```
|
201
|
-
|
202
|
-
### Parameters
|
203
|
-
|
204
|
-
Name | Type | Description | Notes
|
205
|
-
------------- | ------------- | ------------- | -------------
|
206
|
-
**tag_id** | **String**| The identifier of the input tag. |
|
207
|
-
**request_body** | [**CisTaggingTagAssociationDetach**](CisTaggingTagAssociationDetach.md)| |
|
208
|
-
|
209
|
-
### Return type
|
210
|
-
|
211
|
-
nil (empty response body)
|
212
|
-
|
213
|
-
### Authorization
|
214
|
-
|
215
|
-
[api_key](../README.md#api_key)
|
216
|
-
|
217
|
-
### HTTP request headers
|
218
|
-
|
219
|
-
- **Content-Type**: application/json
|
220
|
-
- **Accept**: application/json
|
221
|
-
|
222
|
-
|
223
|
-
|
224
|
-
# **detach_multiple_tags_from_object**
|
225
|
-
> CisTaggingTagAssociationDetachMultipleTagsFromObjectResult detach_multiple_tags_from_object(request_body)
|
226
|
-
|
227
|
-
Detaches the given tags from the input object. If a tag is already removed from the object, then the individual {@term operation} is a no-op and an error will not be added to {@link BatchResult#errorMessages}. To invoke this {@term operation}, you need the read privilege on the object and the attach tag privilege each tag.
|
228
|
-
|
229
|
-
### Example
|
230
|
-
```ruby
|
231
|
-
# load the gem
|
232
|
-
require 'vsphere-automation-cis'
|
233
|
-
# setup authorization
|
234
|
-
VSphereAutomation::Configuration.new.tap do |config|
|
235
|
-
# Configure API key authorization: api_key
|
236
|
-
config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
|
237
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
238
|
-
#config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
|
239
|
-
end
|
240
|
-
|
241
|
-
api_instance = VSphereAutomation::CIS::TaggingTagAssociationApi.new
|
242
|
-
request_body = CIS::CisTaggingTagAssociationDetachMultipleTagsFromObject.new # CisTaggingTagAssociationDetachMultipleTagsFromObject |
|
243
|
-
|
244
|
-
begin
|
245
|
-
#Detaches the given tags from the input object. If a tag is already removed from the object, then the individual {@term operation} is a no-op and an error will not be added to {@link BatchResult#errorMessages}. To invoke this {@term operation}, you need the read privilege on the object and the attach tag privilege each tag.
|
246
|
-
result = api_instance.detach_multiple_tags_from_object(request_body)
|
247
|
-
p result
|
248
|
-
rescue VSphereAutomation::ApiError => e
|
249
|
-
puts "Exception when calling TaggingTagAssociationApi->detach_multiple_tags_from_object: #{e}"
|
250
|
-
end
|
251
|
-
```
|
252
|
-
|
253
|
-
### Parameters
|
254
|
-
|
255
|
-
Name | Type | Description | Notes
|
256
|
-
------------- | ------------- | ------------- | -------------
|
257
|
-
**request_body** | [**CisTaggingTagAssociationDetachMultipleTagsFromObject**](CisTaggingTagAssociationDetachMultipleTagsFromObject.md)| |
|
258
|
-
|
259
|
-
### Return type
|
260
|
-
|
261
|
-
[**CisTaggingTagAssociationDetachMultipleTagsFromObjectResult**](CisTaggingTagAssociationDetachMultipleTagsFromObjectResult.md)
|
262
|
-
|
263
|
-
### Authorization
|
264
|
-
|
265
|
-
[api_key](../README.md#api_key)
|
266
|
-
|
267
|
-
### HTTP request headers
|
268
|
-
|
269
|
-
- **Content-Type**: application/json
|
270
|
-
- **Accept**: application/json
|
271
|
-
|
272
|
-
|
273
|
-
|
274
|
-
# **detach_tag_from_multiple_objects**
|
275
|
-
> CisTaggingTagAssociationDetachTagFromMultipleObjectsResult detach_tag_from_multiple_objects(tag_id, request_body)
|
276
|
-
|
277
|
-
Detaches the given tag from the input objects. If a tag is already removed from the object, then the individual {@term operation} is a no-op and an error will not be added to {@link BatchResult#errorMessages}. To invoke this {@term operation}, you need the attach tag privilege on the tag and the read privilege on each object.
|
278
|
-
|
279
|
-
### Example
|
280
|
-
```ruby
|
281
|
-
# load the gem
|
282
|
-
require 'vsphere-automation-cis'
|
283
|
-
# setup authorization
|
284
|
-
VSphereAutomation::Configuration.new.tap do |config|
|
285
|
-
# Configure API key authorization: api_key
|
286
|
-
config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
|
287
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
288
|
-
#config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
|
289
|
-
end
|
290
|
-
|
291
|
-
api_instance = VSphereAutomation::CIS::TaggingTagAssociationApi.new
|
292
|
-
tag_id = 'tag_id_example' # String | The identifier of the input tag.
|
293
|
-
request_body = CIS::CisTaggingTagAssociationDetachTagFromMultipleObjects.new # CisTaggingTagAssociationDetachTagFromMultipleObjects |
|
294
|
-
|
295
|
-
begin
|
296
|
-
#Detaches the given tag from the input objects. If a tag is already removed from the object, then the individual {@term operation} is a no-op and an error will not be added to {@link BatchResult#errorMessages}. To invoke this {@term operation}, you need the attach tag privilege on the tag and the read privilege on each object.
|
297
|
-
result = api_instance.detach_tag_from_multiple_objects(tag_id, request_body)
|
298
|
-
p result
|
299
|
-
rescue VSphereAutomation::ApiError => e
|
300
|
-
puts "Exception when calling TaggingTagAssociationApi->detach_tag_from_multiple_objects: #{e}"
|
301
|
-
end
|
302
|
-
```
|
303
|
-
|
304
|
-
### Parameters
|
305
|
-
|
306
|
-
Name | Type | Description | Notes
|
307
|
-
------------- | ------------- | ------------- | -------------
|
308
|
-
**tag_id** | **String**| The identifier of the input tag. |
|
309
|
-
**request_body** | [**CisTaggingTagAssociationDetachTagFromMultipleObjects**](CisTaggingTagAssociationDetachTagFromMultipleObjects.md)| |
|
310
|
-
|
311
|
-
### Return type
|
312
|
-
|
313
|
-
[**CisTaggingTagAssociationDetachTagFromMultipleObjectsResult**](CisTaggingTagAssociationDetachTagFromMultipleObjectsResult.md)
|
314
|
-
|
315
|
-
### Authorization
|
316
|
-
|
317
|
-
[api_key](../README.md#api_key)
|
318
|
-
|
319
|
-
### HTTP request headers
|
320
|
-
|
321
|
-
- **Content-Type**: application/json
|
322
|
-
- **Accept**: application/json
|
323
|
-
|
324
|
-
|
325
|
-
|
326
|
-
# **list_attachable_tags**
|
327
|
-
> CisTaggingTagAssociationListAttachableTagsResult list_attachable_tags(request_body)
|
328
|
-
|
329
|
-
Fetches the {@term list} of attachable tags for the given object, omitting the tags that have already been attached. Criteria for attachability is calculated based on tagging cardinality ({@link CategoryModel#cardinality}) and associability ({@link CategoryModel#associableTypes}) constructs. To invoke this {@term operation}, you need the read privilege on the input object. The {@term list} will only contain those tags for which you have read privileges.
|
330
|
-
|
331
|
-
### Example
|
332
|
-
```ruby
|
333
|
-
# load the gem
|
334
|
-
require 'vsphere-automation-cis'
|
335
|
-
# setup authorization
|
336
|
-
VSphereAutomation::Configuration.new.tap do |config|
|
337
|
-
# Configure API key authorization: api_key
|
338
|
-
config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
|
339
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
340
|
-
#config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
|
341
|
-
end
|
342
|
-
|
343
|
-
api_instance = VSphereAutomation::CIS::TaggingTagAssociationApi.new
|
344
|
-
request_body = CIS::CisTaggingTagAssociationListAttachableTags.new # CisTaggingTagAssociationListAttachableTags |
|
345
|
-
|
346
|
-
begin
|
347
|
-
#Fetches the {@term list} of attachable tags for the given object, omitting the tags that have already been attached. Criteria for attachability is calculated based on tagging cardinality ({@link CategoryModel#cardinality}) and associability ({@link CategoryModel#associableTypes}) constructs. To invoke this {@term operation}, you need the read privilege on the input object. The {@term list} will only contain those tags for which you have read privileges.
|
348
|
-
result = api_instance.list_attachable_tags(request_body)
|
349
|
-
p result
|
350
|
-
rescue VSphereAutomation::ApiError => e
|
351
|
-
puts "Exception when calling TaggingTagAssociationApi->list_attachable_tags: #{e}"
|
352
|
-
end
|
353
|
-
```
|
354
|
-
|
355
|
-
### Parameters
|
356
|
-
|
357
|
-
Name | Type | Description | Notes
|
358
|
-
------------- | ------------- | ------------- | -------------
|
359
|
-
**request_body** | [**CisTaggingTagAssociationListAttachableTags**](CisTaggingTagAssociationListAttachableTags.md)| |
|
360
|
-
|
361
|
-
### Return type
|
362
|
-
|
363
|
-
[**CisTaggingTagAssociationListAttachableTagsResult**](CisTaggingTagAssociationListAttachableTagsResult.md)
|
364
|
-
|
365
|
-
### Authorization
|
366
|
-
|
367
|
-
[api_key](../README.md#api_key)
|
368
|
-
|
369
|
-
### HTTP request headers
|
370
|
-
|
371
|
-
- **Content-Type**: application/json
|
372
|
-
- **Accept**: application/json
|
373
|
-
|
374
|
-
|
375
|
-
|
376
|
-
# **list_attached_objects**
|
377
|
-
> CisTaggingTagAssociationListAttachedObjectsResult list_attached_objects(tag_id)
|
378
|
-
|
379
|
-
Fetches the {@term list} of attached objects for the given tag. To invoke this {@term operation}, you need the read privilege on the input tag. Only those objects for which you have the read privilege will be returned.
|
380
|
-
|
381
|
-
### Example
|
382
|
-
```ruby
|
383
|
-
# load the gem
|
384
|
-
require 'vsphere-automation-cis'
|
385
|
-
# setup authorization
|
386
|
-
VSphereAutomation::Configuration.new.tap do |config|
|
387
|
-
# Configure API key authorization: api_key
|
388
|
-
config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
|
389
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
390
|
-
#config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
|
391
|
-
end
|
392
|
-
|
393
|
-
api_instance = VSphereAutomation::CIS::TaggingTagAssociationApi.new
|
394
|
-
tag_id = 'tag_id_example' # String | The identifier of the input tag.
|
395
|
-
|
396
|
-
begin
|
397
|
-
#Fetches the {@term list} of attached objects for the given tag. To invoke this {@term operation}, you need the read privilege on the input tag. Only those objects for which you have the read privilege will be returned.
|
398
|
-
result = api_instance.list_attached_objects(tag_id)
|
399
|
-
p result
|
400
|
-
rescue VSphereAutomation::ApiError => e
|
401
|
-
puts "Exception when calling TaggingTagAssociationApi->list_attached_objects: #{e}"
|
402
|
-
end
|
403
|
-
```
|
404
|
-
|
405
|
-
### Parameters
|
406
|
-
|
407
|
-
Name | Type | Description | Notes
|
408
|
-
------------- | ------------- | ------------- | -------------
|
409
|
-
**tag_id** | **String**| The identifier of the input tag. |
|
410
|
-
|
411
|
-
### Return type
|
412
|
-
|
413
|
-
[**CisTaggingTagAssociationListAttachedObjectsResult**](CisTaggingTagAssociationListAttachedObjectsResult.md)
|
414
|
-
|
415
|
-
### Authorization
|
416
|
-
|
417
|
-
[api_key](../README.md#api_key)
|
418
|
-
|
419
|
-
### HTTP request headers
|
420
|
-
|
421
|
-
- **Content-Type**: Not defined
|
422
|
-
- **Accept**: application/json
|
423
|
-
|
424
|
-
|
425
|
-
|
426
|
-
# **list_attached_objects_on_tags**
|
427
|
-
> CisTaggingTagAssociationListAttachedObjectsOnTagsResult list_attached_objects_on_tags(request_body)
|
428
|
-
|
429
|
-
Fetches the {@term list} of {@link TagToObjects} describing the input tag identifiers and the objects they are attached to. To invoke this {@term operation}, you need the read privilege on each input tag. The {@link TagToObjects#objectIds} will only contain those objects for which you have the read privilege.
|
430
|
-
|
431
|
-
### Example
|
432
|
-
```ruby
|
433
|
-
# load the gem
|
434
|
-
require 'vsphere-automation-cis'
|
435
|
-
# setup authorization
|
436
|
-
VSphereAutomation::Configuration.new.tap do |config|
|
437
|
-
# Configure API key authorization: api_key
|
438
|
-
config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
|
439
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
440
|
-
#config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
|
441
|
-
end
|
442
|
-
|
443
|
-
api_instance = VSphereAutomation::CIS::TaggingTagAssociationApi.new
|
444
|
-
request_body = CIS::CisTaggingTagAssociationListAttachedObjectsOnTags.new # CisTaggingTagAssociationListAttachedObjectsOnTags |
|
445
|
-
|
446
|
-
begin
|
447
|
-
#Fetches the {@term list} of {@link TagToObjects} describing the input tag identifiers and the objects they are attached to. To invoke this {@term operation}, you need the read privilege on each input tag. The {@link TagToObjects#objectIds} will only contain those objects for which you have the read privilege.
|
448
|
-
result = api_instance.list_attached_objects_on_tags(request_body)
|
449
|
-
p result
|
450
|
-
rescue VSphereAutomation::ApiError => e
|
451
|
-
puts "Exception when calling TaggingTagAssociationApi->list_attached_objects_on_tags: #{e}"
|
452
|
-
end
|
453
|
-
```
|
454
|
-
|
455
|
-
### Parameters
|
456
|
-
|
457
|
-
Name | Type | Description | Notes
|
458
|
-
------------- | ------------- | ------------- | -------------
|
459
|
-
**request_body** | [**CisTaggingTagAssociationListAttachedObjectsOnTags**](CisTaggingTagAssociationListAttachedObjectsOnTags.md)| |
|
460
|
-
|
461
|
-
### Return type
|
462
|
-
|
463
|
-
[**CisTaggingTagAssociationListAttachedObjectsOnTagsResult**](CisTaggingTagAssociationListAttachedObjectsOnTagsResult.md)
|
464
|
-
|
465
|
-
### Authorization
|
466
|
-
|
467
|
-
[api_key](../README.md#api_key)
|
468
|
-
|
469
|
-
### HTTP request headers
|
470
|
-
|
471
|
-
- **Content-Type**: application/json
|
472
|
-
- **Accept**: application/json
|
473
|
-
|
474
|
-
|
475
|
-
|
476
|
-
# **list_attached_tags**
|
477
|
-
> CisTaggingTagAssociationListAttachedTagsResult list_attached_tags(request_body)
|
478
|
-
|
479
|
-
Fetches the {@term list} of tags attached to the given object. To invoke this {@term operation}, you need the read privilege on the input object. The {@term list} will only contain those tags for which you have the read privileges.
|
480
|
-
|
481
|
-
### Example
|
482
|
-
```ruby
|
483
|
-
# load the gem
|
484
|
-
require 'vsphere-automation-cis'
|
485
|
-
# setup authorization
|
486
|
-
VSphereAutomation::Configuration.new.tap do |config|
|
487
|
-
# Configure API key authorization: api_key
|
488
|
-
config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
|
489
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
490
|
-
#config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
|
491
|
-
end
|
492
|
-
|
493
|
-
api_instance = VSphereAutomation::CIS::TaggingTagAssociationApi.new
|
494
|
-
request_body = CIS::CisTaggingTagAssociationListAttachedTags.new # CisTaggingTagAssociationListAttachedTags |
|
495
|
-
|
496
|
-
begin
|
497
|
-
#Fetches the {@term list} of tags attached to the given object. To invoke this {@term operation}, you need the read privilege on the input object. The {@term list} will only contain those tags for which you have the read privileges.
|
498
|
-
result = api_instance.list_attached_tags(request_body)
|
499
|
-
p result
|
500
|
-
rescue VSphereAutomation::ApiError => e
|
501
|
-
puts "Exception when calling TaggingTagAssociationApi->list_attached_tags: #{e}"
|
502
|
-
end
|
503
|
-
```
|
504
|
-
|
505
|
-
### Parameters
|
506
|
-
|
507
|
-
Name | Type | Description | Notes
|
508
|
-
------------- | ------------- | ------------- | -------------
|
509
|
-
**request_body** | [**CisTaggingTagAssociationListAttachedTags**](CisTaggingTagAssociationListAttachedTags.md)| |
|
510
|
-
|
511
|
-
### Return type
|
512
|
-
|
513
|
-
[**CisTaggingTagAssociationListAttachedTagsResult**](CisTaggingTagAssociationListAttachedTagsResult.md)
|
514
|
-
|
515
|
-
### Authorization
|
516
|
-
|
517
|
-
[api_key](../README.md#api_key)
|
518
|
-
|
519
|
-
### HTTP request headers
|
520
|
-
|
521
|
-
- **Content-Type**: application/json
|
522
|
-
- **Accept**: application/json
|
523
|
-
|
524
|
-
|
525
|
-
|
526
|
-
# **list_attached_tags_on_objects**
|
527
|
-
> CisTaggingTagAssociationListAttachedTagsOnObjectsResult list_attached_tags_on_objects(request_body)
|
528
|
-
|
529
|
-
Fetches the {@term list} of {@link ObjectToTags} describing the input object identifiers and the tags attached to each object. To invoke this {@term operation}, you need the read privilege on each input object. The {@link ObjectToTags#tagIds} will only contain those tags for which you have the read privilege.
|
530
|
-
|
531
|
-
### Example
|
532
|
-
```ruby
|
533
|
-
# load the gem
|
534
|
-
require 'vsphere-automation-cis'
|
535
|
-
# setup authorization
|
536
|
-
VSphereAutomation::Configuration.new.tap do |config|
|
537
|
-
# Configure API key authorization: api_key
|
538
|
-
config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
|
539
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
540
|
-
#config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
|
541
|
-
end
|
542
|
-
|
543
|
-
api_instance = VSphereAutomation::CIS::TaggingTagAssociationApi.new
|
544
|
-
request_body = CIS::CisTaggingTagAssociationListAttachedTagsOnObjects.new # CisTaggingTagAssociationListAttachedTagsOnObjects |
|
545
|
-
|
546
|
-
begin
|
547
|
-
#Fetches the {@term list} of {@link ObjectToTags} describing the input object identifiers and the tags attached to each object. To invoke this {@term operation}, you need the read privilege on each input object. The {@link ObjectToTags#tagIds} will only contain those tags for which you have the read privilege.
|
548
|
-
result = api_instance.list_attached_tags_on_objects(request_body)
|
549
|
-
p result
|
550
|
-
rescue VSphereAutomation::ApiError => e
|
551
|
-
puts "Exception when calling TaggingTagAssociationApi->list_attached_tags_on_objects: #{e}"
|
552
|
-
end
|
553
|
-
```
|
554
|
-
|
555
|
-
### Parameters
|
556
|
-
|
557
|
-
Name | Type | Description | Notes
|
558
|
-
------------- | ------------- | ------------- | -------------
|
559
|
-
**request_body** | [**CisTaggingTagAssociationListAttachedTagsOnObjects**](CisTaggingTagAssociationListAttachedTagsOnObjects.md)| |
|
560
|
-
|
561
|
-
### Return type
|
562
|
-
|
563
|
-
[**CisTaggingTagAssociationListAttachedTagsOnObjectsResult**](CisTaggingTagAssociationListAttachedTagsOnObjectsResult.md)
|
564
|
-
|
565
|
-
### Authorization
|
566
|
-
|
567
|
-
[api_key](../README.md#api_key)
|
568
|
-
|
569
|
-
### HTTP request headers
|
570
|
-
|
571
|
-
- **Content-Type**: application/json
|
572
|
-
- **Accept**: application/json
|
573
|
-
|
574
|
-
|
575
|
-
|