vsphere-automation-cis 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/Gemfile +3 -0
- data/Gemfile.lock +81 -0
- data/README.md +173 -0
- data/Rakefile +10 -0
- data/docs/CisSessionCreateResult.md +8 -0
- data/docs/CisSessionInfo.md +10 -0
- data/docs/CisSessionResult.md +8 -0
- data/docs/CisTaggingCategoryAddToUsedBy.md +8 -0
- data/docs/CisTaggingCategoryCreate.md +8 -0
- data/docs/CisTaggingCategoryCreateResult.md +8 -0
- data/docs/CisTaggingCategoryCreateSpec.md +12 -0
- data/docs/CisTaggingCategoryListResult.md +8 -0
- data/docs/CisTaggingCategoryListUsedCategories.md +8 -0
- data/docs/CisTaggingCategoryListUsedCategoriesResult.md +8 -0
- data/docs/CisTaggingCategoryModel.md +13 -0
- data/docs/CisTaggingCategoryModelCardinality.md +7 -0
- data/docs/CisTaggingCategoryRemoveFromUsedBy.md +8 -0
- data/docs/CisTaggingCategoryResult.md +8 -0
- data/docs/CisTaggingCategoryUpdate.md +8 -0
- data/docs/CisTaggingCategoryUpdateSpec.md +11 -0
- data/docs/CisTaggingTagAddToUsedBy.md +8 -0
- data/docs/CisTaggingTagAssociationAttach.md +8 -0
- data/docs/CisTaggingTagAssociationAttachMultipleTagsToObject.md +9 -0
- data/docs/CisTaggingTagAssociationAttachMultipleTagsToObjectResult.md +8 -0
- data/docs/CisTaggingTagAssociationAttachTagToMultipleObjects.md +8 -0
- data/docs/CisTaggingTagAssociationAttachTagToMultipleObjectsResult.md +8 -0
- data/docs/CisTaggingTagAssociationBatchResult.md +9 -0
- data/docs/CisTaggingTagAssociationDetach.md +8 -0
- data/docs/CisTaggingTagAssociationDetachMultipleTagsFromObject.md +9 -0
- data/docs/CisTaggingTagAssociationDetachMultipleTagsFromObjectResult.md +8 -0
- data/docs/CisTaggingTagAssociationDetachTagFromMultipleObjects.md +8 -0
- data/docs/CisTaggingTagAssociationDetachTagFromMultipleObjectsResult.md +8 -0
- data/docs/CisTaggingTagAssociationListAttachableTags.md +8 -0
- data/docs/CisTaggingTagAssociationListAttachableTagsResult.md +8 -0
- data/docs/CisTaggingTagAssociationListAttachedObjectsOnTags.md +8 -0
- data/docs/CisTaggingTagAssociationListAttachedObjectsOnTagsResult.md +8 -0
- data/docs/CisTaggingTagAssociationListAttachedObjectsResult.md +8 -0
- data/docs/CisTaggingTagAssociationListAttachedTags.md +8 -0
- data/docs/CisTaggingTagAssociationListAttachedTagsOnObjects.md +8 -0
- data/docs/CisTaggingTagAssociationListAttachedTagsOnObjectsResult.md +8 -0
- data/docs/CisTaggingTagAssociationListAttachedTagsResult.md +8 -0
- data/docs/CisTaggingTagAssociationObjectToTags.md +9 -0
- data/docs/CisTaggingTagAssociationTagToObjects.md +9 -0
- data/docs/CisTaggingTagCreate.md +8 -0
- data/docs/CisTaggingTagCreateResult.md +8 -0
- data/docs/CisTaggingTagCreateSpec.md +11 -0
- data/docs/CisTaggingTagListResult.md +8 -0
- data/docs/CisTaggingTagListTagsForCategoryResult.md +8 -0
- data/docs/CisTaggingTagListUsedTags.md +8 -0
- data/docs/CisTaggingTagListUsedTagsResult.md +8 -0
- data/docs/CisTaggingTagModel.md +12 -0
- data/docs/CisTaggingTagRemoveFromUsedBy.md +8 -0
- data/docs/CisTaggingTagResult.md +8 -0
- data/docs/CisTaggingTagUpdate.md +8 -0
- data/docs/CisTaggingTagUpdateSpec.md +9 -0
- data/docs/CisTaskInfo.md +19 -0
- data/docs/CisTaskProgress.md +10 -0
- data/docs/CisTaskStatus.md +7 -0
- data/docs/CisTasksFilterSpec.md +12 -0
- data/docs/CisTasksGetSpec.md +9 -0
- data/docs/CisTasksListResult.md +8 -0
- data/docs/CisTasksListResultValue.md +9 -0
- data/docs/CisTasksResult.md +8 -0
- data/docs/FilterSpecTargets.md +9 -0
- data/docs/SessionApi.md +131 -0
- data/docs/TaggingCategoryApi.md +401 -0
- data/docs/TaggingTagApi.md +445 -0
- data/docs/TaggingTagAssociationApi.md +498 -0
- data/docs/TasksApi.md +159 -0
- data/docs/VapiStdDynamicID.md +9 -0
- data/docs/VapiStdErrorsAlreadyExists.md +9 -0
- data/docs/VapiStdErrorsAlreadyExistsError.md +9 -0
- data/docs/VapiStdErrorsError.md +9 -0
- data/docs/VapiStdErrorsErrorError.md +9 -0
- data/docs/VapiStdErrorsInvalidArgument.md +9 -0
- data/docs/VapiStdErrorsInvalidArgumentError.md +9 -0
- data/docs/VapiStdErrorsNotAllowedInCurrentState.md +9 -0
- data/docs/VapiStdErrorsNotAllowedInCurrentStateError.md +9 -0
- data/docs/VapiStdErrorsNotFound.md +9 -0
- data/docs/VapiStdErrorsNotFoundError.md +9 -0
- data/docs/VapiStdErrorsResourceInaccessible.md +9 -0
- data/docs/VapiStdErrorsResourceInaccessibleError.md +9 -0
- data/docs/VapiStdErrorsServiceUnavailable.md +9 -0
- data/docs/VapiStdErrorsServiceUnavailableError.md +9 -0
- data/docs/VapiStdErrorsUnauthenticated.md +9 -0
- data/docs/VapiStdErrorsUnauthenticatedError.md +9 -0
- data/docs/VapiStdErrorsUnauthorized.md +9 -0
- data/docs/VapiStdErrorsUnauthorizedError.md +9 -0
- data/docs/VapiStdErrorsUnsupported.md +9 -0
- data/docs/VapiStdErrorsUnsupportedError.md +9 -0
- data/docs/VapiStdLocalizableMessage.md +10 -0
- data/git_push.sh +55 -0
- data/lib/vsphere-automation-cis.rb +124 -0
- data/lib/vsphere-automation-cis/api/session_api.rb +172 -0
- data/lib/vsphere-automation-cis/api/tagging_category_api.rb +511 -0
- data/lib/vsphere-automation-cis/api/tagging_tag_api.rb +567 -0
- data/lib/vsphere-automation-cis/api/tagging_tag_association_api.rb +654 -0
- data/lib/vsphere-automation-cis/api/tasks_api.rb +212 -0
- data/lib/vsphere-automation-cis/api_client.rb +386 -0
- data/lib/vsphere-automation-cis/api_error.rb +36 -0
- data/lib/vsphere-automation-cis/configuration.rb +200 -0
- data/lib/vsphere-automation-cis/models/cis_session_create_result.rb +188 -0
- data/lib/vsphere-automation-cis/models/cis_session_info.rb +219 -0
- data/lib/vsphere-automation-cis/models/cis_session_result.rb +188 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_category_add_to_used_by.rb +189 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_category_create.rb +188 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_category_create_result.rb +188 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_category_create_spec.rb +245 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_category_list_result.rb +190 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_category_list_used_categories.rb +189 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_category_list_used_categories_result.rb +190 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_category_model.rb +267 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_category_model_cardinality.rb +30 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_category_remove_from_used_by.rb +189 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_category_result.rb +188 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_category_update.rb +188 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_category_update_spec.rb +215 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_add_to_used_by.rb +189 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_association_attach.rb +188 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_association_attach_multiple_tags_to_object.rb +205 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_association_attach_multiple_tags_to_object_result.rb +188 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_association_attach_tag_to_multiple_objects.rb +191 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_association_attach_tag_to_multiple_objects_result.rb +188 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_association_batch_result.rb +206 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_association_detach.rb +188 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_association_detach_multiple_tags_from_object.rb +205 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_association_detach_multiple_tags_from_object_result.rb +188 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_association_detach_tag_from_multiple_objects.rb +191 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_association_detach_tag_from_multiple_objects_result.rb +188 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_association_list_attachable_tags.rb +188 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_association_list_attachable_tags_result.rb +190 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_association_list_attached_objects_on_tags.rb +191 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_association_list_attached_objects_on_tags_result.rb +190 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_association_list_attached_objects_result.rb +190 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_association_list_attached_tags.rb +188 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_association_list_attached_tags_on_objects.rb +191 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_association_list_attached_tags_on_objects_result.rb +190 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_association_list_attached_tags_result.rb +190 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_association_object_to_tags.rb +205 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_association_tag_to_objects.rb +206 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_create.rb +188 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_create_result.rb +188 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_create_spec.rb +229 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_list_result.rb +190 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_list_tags_for_category_result.rb +190 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_list_used_tags.rb +189 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_list_used_tags_result.rb +190 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_model.rb +251 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_remove_from_used_by.rb +189 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_result.rb +188 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_update.rb +188 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_update_spec.rb +194 -0
- data/lib/vsphere-automation-cis/models/cis_task_info.rb +315 -0
- data/lib/vsphere-automation-cis/models/cis_task_progress.rb +218 -0
- data/lib/vsphere-automation-cis/models/cis_task_status.rb +33 -0
- data/lib/vsphere-automation-cis/models/cis_tasks_filter_spec.rb +234 -0
- data/lib/vsphere-automation-cis/models/cis_tasks_get_spec.rb +194 -0
- data/lib/vsphere-automation-cis/models/cis_tasks_list_result.rb +190 -0
- data/lib/vsphere-automation-cis/models/cis_tasks_list_result_value.rb +192 -0
- data/lib/vsphere-automation-cis/models/cis_tasks_result.rb +188 -0
- data/lib/vsphere-automation-cis/models/filter_spec_targets.rb +204 -0
- data/lib/vsphere-automation-cis/models/vapi_std_dynamic_id.rb +204 -0
- data/lib/vsphere-automation-cis/models/vapi_std_errors_already_exists.rb +201 -0
- data/lib/vsphere-automation-cis/models/vapi_std_errors_already_exists_error.rb +192 -0
- data/lib/vsphere-automation-cis/models/vapi_std_errors_error.rb +201 -0
- data/lib/vsphere-automation-cis/models/vapi_std_errors_error_error.rb +192 -0
- data/lib/vsphere-automation-cis/models/vapi_std_errors_invalid_argument.rb +201 -0
- data/lib/vsphere-automation-cis/models/vapi_std_errors_invalid_argument_error.rb +192 -0
- data/lib/vsphere-automation-cis/models/vapi_std_errors_not_allowed_in_current_state.rb +201 -0
- data/lib/vsphere-automation-cis/models/vapi_std_errors_not_allowed_in_current_state_error.rb +192 -0
- data/lib/vsphere-automation-cis/models/vapi_std_errors_not_found.rb +201 -0
- data/lib/vsphere-automation-cis/models/vapi_std_errors_not_found_error.rb +192 -0
- data/lib/vsphere-automation-cis/models/vapi_std_errors_resource_inaccessible.rb +201 -0
- data/lib/vsphere-automation-cis/models/vapi_std_errors_resource_inaccessible_error.rb +192 -0
- data/lib/vsphere-automation-cis/models/vapi_std_errors_service_unavailable.rb +201 -0
- data/lib/vsphere-automation-cis/models/vapi_std_errors_service_unavailable_error.rb +192 -0
- data/lib/vsphere-automation-cis/models/vapi_std_errors_unauthenticated.rb +201 -0
- data/lib/vsphere-automation-cis/models/vapi_std_errors_unauthenticated_error.rb +192 -0
- data/lib/vsphere-automation-cis/models/vapi_std_errors_unauthorized.rb +201 -0
- data/lib/vsphere-automation-cis/models/vapi_std_errors_unauthorized_error.rb +192 -0
- data/lib/vsphere-automation-cis/models/vapi_std_errors_unsupported.rb +201 -0
- data/lib/vsphere-automation-cis/models/vapi_std_errors_unsupported_error.rb +192 -0
- data/lib/vsphere-automation-cis/models/vapi_std_localizable_message.rb +221 -0
- data/lib/vsphere-automation-cis/version.rb +15 -0
- data/spec/api/session_api_spec.rb +64 -0
- data/spec/api/tagging_category_api_spec.rb +134 -0
- data/spec/api/tagging_tag_api_spec.rb +145 -0
- data/spec/api/tagging_tag_association_api_spec.rb +158 -0
- data/spec/api/tasks_api_spec.rb +74 -0
- data/spec/api_client_spec.rb +224 -0
- data/spec/configuration_spec.rb +40 -0
- data/spec/models/cis_session_create_result_spec.rb +39 -0
- data/spec/models/cis_session_info_spec.rb +51 -0
- data/spec/models/cis_session_result_spec.rb +39 -0
- data/spec/models/cis_tagging_category_add_to_used_by_spec.rb +39 -0
- data/spec/models/cis_tagging_category_create_result_spec.rb +39 -0
- data/spec/models/cis_tagging_category_create_spec.rb +39 -0
- data/spec/models/cis_tagging_category_create_spec_spec.rb +63 -0
- data/spec/models/cis_tagging_category_list_result_spec.rb +39 -0
- data/spec/models/cis_tagging_category_list_used_categories_result_spec.rb +39 -0
- data/spec/models/cis_tagging_category_list_used_categories_spec.rb +39 -0
- data/spec/models/cis_tagging_category_model_cardinality_spec.rb +33 -0
- data/spec/models/cis_tagging_category_model_spec.rb +69 -0
- data/spec/models/cis_tagging_category_remove_from_used_by_spec.rb +39 -0
- data/spec/models/cis_tagging_category_result_spec.rb +39 -0
- data/spec/models/cis_tagging_category_update_spec.rb +39 -0
- data/spec/models/cis_tagging_category_update_spec_spec.rb +57 -0
- data/spec/models/cis_tagging_tag_add_to_used_by_spec.rb +39 -0
- data/spec/models/cis_tagging_tag_association_attach_multiple_tags_to_object_result_spec.rb +39 -0
- data/spec/models/cis_tagging_tag_association_attach_multiple_tags_to_object_spec.rb +45 -0
- data/spec/models/cis_tagging_tag_association_attach_spec.rb +39 -0
- data/spec/models/cis_tagging_tag_association_attach_tag_to_multiple_objects_result_spec.rb +39 -0
- data/spec/models/cis_tagging_tag_association_attach_tag_to_multiple_objects_spec.rb +39 -0
- data/spec/models/cis_tagging_tag_association_batch_result_spec.rb +45 -0
- data/spec/models/cis_tagging_tag_association_detach_multiple_tags_from_object_result_spec.rb +39 -0
- data/spec/models/cis_tagging_tag_association_detach_multiple_tags_from_object_spec.rb +45 -0
- data/spec/models/cis_tagging_tag_association_detach_spec.rb +39 -0
- data/spec/models/cis_tagging_tag_association_detach_tag_from_multiple_objects_result_spec.rb +39 -0
- data/spec/models/cis_tagging_tag_association_detach_tag_from_multiple_objects_spec.rb +39 -0
- data/spec/models/cis_tagging_tag_association_list_attachable_tags_result_spec.rb +39 -0
- data/spec/models/cis_tagging_tag_association_list_attachable_tags_spec.rb +39 -0
- data/spec/models/cis_tagging_tag_association_list_attached_objects_on_tags_result_spec.rb +39 -0
- data/spec/models/cis_tagging_tag_association_list_attached_objects_on_tags_spec.rb +39 -0
- data/spec/models/cis_tagging_tag_association_list_attached_objects_result_spec.rb +39 -0
- data/spec/models/cis_tagging_tag_association_list_attached_tags_on_objects_result_spec.rb +39 -0
- data/spec/models/cis_tagging_tag_association_list_attached_tags_on_objects_spec.rb +39 -0
- data/spec/models/cis_tagging_tag_association_list_attached_tags_result_spec.rb +39 -0
- data/spec/models/cis_tagging_tag_association_list_attached_tags_spec.rb +39 -0
- data/spec/models/cis_tagging_tag_association_object_to_tags_spec.rb +45 -0
- data/spec/models/cis_tagging_tag_association_tag_to_objects_spec.rb +45 -0
- data/spec/models/cis_tagging_tag_create_result_spec.rb +39 -0
- data/spec/models/cis_tagging_tag_create_spec.rb +39 -0
- data/spec/models/cis_tagging_tag_create_spec_spec.rb +57 -0
- data/spec/models/cis_tagging_tag_list_result_spec.rb +39 -0
- data/spec/models/cis_tagging_tag_list_tags_for_category_result_spec.rb +39 -0
- data/spec/models/cis_tagging_tag_list_used_tags_result_spec.rb +39 -0
- data/spec/models/cis_tagging_tag_list_used_tags_spec.rb +39 -0
- data/spec/models/cis_tagging_tag_model_spec.rb +63 -0
- data/spec/models/cis_tagging_tag_remove_from_used_by_spec.rb +39 -0
- data/spec/models/cis_tagging_tag_result_spec.rb +39 -0
- data/spec/models/cis_tagging_tag_update_spec.rb +39 -0
- data/spec/models/cis_tagging_tag_update_spec_spec.rb +45 -0
- data/spec/models/cis_task_info_spec.rb +105 -0
- data/spec/models/cis_task_progress_spec.rb +51 -0
- data/spec/models/cis_task_status_spec.rb +33 -0
- data/spec/models/cis_tasks_filter_spec_spec.rb +63 -0
- data/spec/models/cis_tasks_get_spec_spec.rb +45 -0
- data/spec/models/cis_tasks_list_result_spec.rb +39 -0
- data/spec/models/cis_tasks_list_result_value_spec.rb +45 -0
- data/spec/models/cis_tasks_result_spec.rb +39 -0
- data/spec/models/filter_spec_targets_spec.rb +45 -0
- data/spec/models/vapi_std_dynamic_id_spec.rb +45 -0
- data/spec/models/vapi_std_errors_already_exists_error_spec.rb +45 -0
- data/spec/models/vapi_std_errors_already_exists_spec.rb +45 -0
- data/spec/models/vapi_std_errors_error_error_spec.rb +45 -0
- data/spec/models/vapi_std_errors_error_spec.rb +45 -0
- data/spec/models/vapi_std_errors_invalid_argument_error_spec.rb +45 -0
- data/spec/models/vapi_std_errors_invalid_argument_spec.rb +45 -0
- data/spec/models/vapi_std_errors_not_allowed_in_current_state_error_spec.rb +45 -0
- data/spec/models/vapi_std_errors_not_allowed_in_current_state_spec.rb +45 -0
- data/spec/models/vapi_std_errors_not_found_error_spec.rb +45 -0
- data/spec/models/vapi_std_errors_not_found_spec.rb +45 -0
- data/spec/models/vapi_std_errors_resource_inaccessible_error_spec.rb +45 -0
- data/spec/models/vapi_std_errors_resource_inaccessible_spec.rb +45 -0
- data/spec/models/vapi_std_errors_service_unavailable_error_spec.rb +45 -0
- data/spec/models/vapi_std_errors_service_unavailable_spec.rb +45 -0
- data/spec/models/vapi_std_errors_unauthenticated_error_spec.rb +45 -0
- data/spec/models/vapi_std_errors_unauthenticated_spec.rb +45 -0
- data/spec/models/vapi_std_errors_unauthorized_error_spec.rb +45 -0
- data/spec/models/vapi_std_errors_unauthorized_spec.rb +45 -0
- data/spec/models/vapi_std_errors_unsupported_error_spec.rb +45 -0
- data/spec/models/vapi_std_errors_unsupported_spec.rb +45 -0
- data/spec/models/vapi_std_localizable_message_spec.rb +51 -0
- data/spec/spec_helper.rb +109 -0
- data/vsphere-automation-cis.gemspec +43 -0
- metadata +535 -0
@@ -0,0 +1,445 @@
|
|
1
|
+
# VSphereAutomation::CIS::TaggingTagApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://<vcenter>/rest*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**add_to_used_by**](TaggingTagApi.md#add_to_used_by) | **POST** /com/vmware/cis/tagging/tag/id:{tag_id}?~action=add-to-used-by | Adds the {@param.name usedByEntity} to the {@link TagModel#usedBy} subscribers {@term set}. If the {@param.name usedByEntity} is already in the {@term set}, then this becomes a no-op. To invoke this {@term operation}, you need the modify {@link TagModel#usedBy} privilege on the tag.
|
8
|
+
[**create**](TaggingTagApi.md#create) | **POST** /com/vmware/cis/tagging/tag | Creates a tag. To invoke this {@term operation}, you need the create tag privilege on the input category.
|
9
|
+
[**delete**](TaggingTagApi.md#delete) | **DELETE** /com/vmware/cis/tagging/tag/id:{tag_id} | Deletes an existing tag. To invoke this {@term operation}, you need the delete privilege on the tag.
|
10
|
+
[**get**](TaggingTagApi.md#get) | **GET** /com/vmware/cis/tagging/tag/id:{tag_id} | Fetches the tag information for the given tag identifier. To invoke this {@term operation}, you need the read privilege on the tag in order to view the tag info.
|
11
|
+
[**list**](TaggingTagApi.md#list) | **GET** /com/vmware/cis/tagging/tag | Enumerates the tags in the system. To invoke this {@term operation}, you need read privilege on the individual tags. The {@term list} will only contain tags for which you have read privileges.
|
12
|
+
[**list_tags_for_category**](TaggingTagApi.md#list_tags_for_category) | **POST** /com/vmware/cis/tagging/tag/id:{category_id}?~action=list-tags-for-category | Enumerates all tags for the given category. To invoke this {@term operation}, you need the read privilege on the given category and the individual tags in that category.
|
13
|
+
[**list_used_tags**](TaggingTagApi.md#list_used_tags) | **POST** /com/vmware/cis/tagging/tag?~action=list-used-tags | Enumerates all tags for which the {@param.name usedByEntity} is part of the {@link TagModel#usedBy} subscribers {@term set}. To invoke this {@term operation}, you need the read privilege on the individual tags.
|
14
|
+
[**remove_from_used_by**](TaggingTagApi.md#remove_from_used_by) | **POST** /com/vmware/cis/tagging/tag/id:{tag_id}?~action=remove-from-used-by | Removes the {@param.name usedByEntity} from the {@link TagModel#usedBy} subscribers set. If the {@param.name usedByEntity} is not using this tag, then this becomes a no-op. To invoke this {@term operation}, you need modify {@link TagModel#usedBy} privilege on the tag.
|
15
|
+
[**revoke_propagating_permissions**](TaggingTagApi.md#revoke_propagating_permissions) | **POST** /com/vmware/cis/tagging/tag/id:{tag_id}?~action=revoke-propagating-permissions | Revokes all propagating permissions on the given tag. You should then attach a direct permission with tagging privileges on the given tag. To invoke this {@term operation}, you need tag related privileges (direct or propagating) on the concerned tag.
|
16
|
+
[**update**](TaggingTagApi.md#update) | **PATCH** /com/vmware/cis/tagging/tag/id:{tag_id} | Updates an existing tag. To invoke this {@term operation}, you need the edit privilege on the tag.
|
17
|
+
|
18
|
+
|
19
|
+
# **add_to_used_by**
|
20
|
+
> add_to_used_by(tag_id, cis_tagging_tag_add_to_used_by)
|
21
|
+
|
22
|
+
Adds the {@param.name usedByEntity} to the {@link TagModel#usedBy} subscribers {@term set}. If the {@param.name usedByEntity} is already in the {@term set}, then this becomes a no-op. To invoke this {@term operation}, you need the modify {@link TagModel#usedBy} privilege on the tag.
|
23
|
+
|
24
|
+
### Example
|
25
|
+
```ruby
|
26
|
+
# load the gem
|
27
|
+
require 'vsphere-automation-cis'
|
28
|
+
|
29
|
+
api_instance = VSphereAutomation::CIS::TaggingTagApi.new
|
30
|
+
tag_id = 'tag_id_example' # String | The identifier of the input tag.
|
31
|
+
cis_tagging_tag_add_to_used_by = VSphereAutomation::CisTaggingTagAddToUsedBy.new # CisTaggingTagAddToUsedBy |
|
32
|
+
|
33
|
+
begin
|
34
|
+
#Adds the {@param.name usedByEntity} to the {@link TagModel#usedBy} subscribers {@term set}. If the {@param.name usedByEntity} is already in the {@term set}, then this becomes a no-op. To invoke this {@term operation}, you need the modify {@link TagModel#usedBy} privilege on the tag.
|
35
|
+
api_instance.add_to_used_by(tag_id, cis_tagging_tag_add_to_used_by)
|
36
|
+
rescue VSphereAutomation::ApiError => e
|
37
|
+
puts "Exception when calling TaggingTagApi->add_to_used_by: #{e}"
|
38
|
+
end
|
39
|
+
```
|
40
|
+
|
41
|
+
### Parameters
|
42
|
+
|
43
|
+
Name | Type | Description | Notes
|
44
|
+
------------- | ------------- | ------------- | -------------
|
45
|
+
**tag_id** | **String**| The identifier of the input tag. |
|
46
|
+
**cis_tagging_tag_add_to_used_by** | [**CisTaggingTagAddToUsedBy**](CisTaggingTagAddToUsedBy.md)| |
|
47
|
+
|
48
|
+
### Return type
|
49
|
+
|
50
|
+
nil (empty response body)
|
51
|
+
|
52
|
+
### Authorization
|
53
|
+
|
54
|
+
No authorization required
|
55
|
+
|
56
|
+
### HTTP request headers
|
57
|
+
|
58
|
+
- **Content-Type**: application/json
|
59
|
+
- **Accept**: */*
|
60
|
+
|
61
|
+
|
62
|
+
|
63
|
+
# **create**
|
64
|
+
> CisTaggingTagCreateResult create(cis_tagging_tag_create)
|
65
|
+
|
66
|
+
Creates a tag. To invoke this {@term operation}, you need the create tag privilege on the input category.
|
67
|
+
|
68
|
+
### Example
|
69
|
+
```ruby
|
70
|
+
# load the gem
|
71
|
+
require 'vsphere-automation-cis'
|
72
|
+
|
73
|
+
api_instance = VSphereAutomation::CIS::TaggingTagApi.new
|
74
|
+
cis_tagging_tag_create = VSphereAutomation::CisTaggingTagCreate.new # CisTaggingTagCreate |
|
75
|
+
|
76
|
+
begin
|
77
|
+
#Creates a tag. To invoke this {@term operation}, you need the create tag privilege on the input category.
|
78
|
+
result = api_instance.create(cis_tagging_tag_create)
|
79
|
+
p result
|
80
|
+
rescue VSphereAutomation::ApiError => e
|
81
|
+
puts "Exception when calling TaggingTagApi->create: #{e}"
|
82
|
+
end
|
83
|
+
```
|
84
|
+
|
85
|
+
### Parameters
|
86
|
+
|
87
|
+
Name | Type | Description | Notes
|
88
|
+
------------- | ------------- | ------------- | -------------
|
89
|
+
**cis_tagging_tag_create** | [**CisTaggingTagCreate**](CisTaggingTagCreate.md)| |
|
90
|
+
|
91
|
+
### Return type
|
92
|
+
|
93
|
+
[**CisTaggingTagCreateResult**](CisTaggingTagCreateResult.md)
|
94
|
+
|
95
|
+
### Authorization
|
96
|
+
|
97
|
+
No authorization required
|
98
|
+
|
99
|
+
### HTTP request headers
|
100
|
+
|
101
|
+
- **Content-Type**: application/json
|
102
|
+
- **Accept**: */*
|
103
|
+
|
104
|
+
|
105
|
+
|
106
|
+
# **delete**
|
107
|
+
> delete(tag_id)
|
108
|
+
|
109
|
+
Deletes an existing tag. To invoke this {@term operation}, you need the delete privilege on the tag.
|
110
|
+
|
111
|
+
### Example
|
112
|
+
```ruby
|
113
|
+
# load the gem
|
114
|
+
require 'vsphere-automation-cis'
|
115
|
+
|
116
|
+
api_instance = VSphereAutomation::CIS::TaggingTagApi.new
|
117
|
+
tag_id = 'tag_id_example' # String | The identifier of the input tag.
|
118
|
+
|
119
|
+
begin
|
120
|
+
#Deletes an existing tag. To invoke this {@term operation}, you need the delete privilege on the tag.
|
121
|
+
api_instance.delete(tag_id)
|
122
|
+
rescue VSphereAutomation::ApiError => e
|
123
|
+
puts "Exception when calling TaggingTagApi->delete: #{e}"
|
124
|
+
end
|
125
|
+
```
|
126
|
+
|
127
|
+
### Parameters
|
128
|
+
|
129
|
+
Name | Type | Description | Notes
|
130
|
+
------------- | ------------- | ------------- | -------------
|
131
|
+
**tag_id** | **String**| The identifier of the input tag. |
|
132
|
+
|
133
|
+
### Return type
|
134
|
+
|
135
|
+
nil (empty response body)
|
136
|
+
|
137
|
+
### Authorization
|
138
|
+
|
139
|
+
No authorization required
|
140
|
+
|
141
|
+
### HTTP request headers
|
142
|
+
|
143
|
+
- **Content-Type**: Not defined
|
144
|
+
- **Accept**: */*
|
145
|
+
|
146
|
+
|
147
|
+
|
148
|
+
# **get**
|
149
|
+
> CisTaggingTagResult get(tag_id)
|
150
|
+
|
151
|
+
Fetches the tag information for the given tag identifier. To invoke this {@term operation}, you need the read privilege on the tag in order to view the tag info.
|
152
|
+
|
153
|
+
### Example
|
154
|
+
```ruby
|
155
|
+
# load the gem
|
156
|
+
require 'vsphere-automation-cis'
|
157
|
+
|
158
|
+
api_instance = VSphereAutomation::CIS::TaggingTagApi.new
|
159
|
+
tag_id = 'tag_id_example' # String | The identifier of the input tag.
|
160
|
+
|
161
|
+
begin
|
162
|
+
#Fetches the tag information for the given tag identifier. To invoke this {@term operation}, you need the read privilege on the tag in order to view the tag info.
|
163
|
+
result = api_instance.get(tag_id)
|
164
|
+
p result
|
165
|
+
rescue VSphereAutomation::ApiError => e
|
166
|
+
puts "Exception when calling TaggingTagApi->get: #{e}"
|
167
|
+
end
|
168
|
+
```
|
169
|
+
|
170
|
+
### Parameters
|
171
|
+
|
172
|
+
Name | Type | Description | Notes
|
173
|
+
------------- | ------------- | ------------- | -------------
|
174
|
+
**tag_id** | **String**| The identifier of the input tag. |
|
175
|
+
|
176
|
+
### Return type
|
177
|
+
|
178
|
+
[**CisTaggingTagResult**](CisTaggingTagResult.md)
|
179
|
+
|
180
|
+
### Authorization
|
181
|
+
|
182
|
+
No authorization required
|
183
|
+
|
184
|
+
### HTTP request headers
|
185
|
+
|
186
|
+
- **Content-Type**: Not defined
|
187
|
+
- **Accept**: */*
|
188
|
+
|
189
|
+
|
190
|
+
|
191
|
+
# **list**
|
192
|
+
> CisTaggingTagListResult list
|
193
|
+
|
194
|
+
Enumerates the tags in the system. To invoke this {@term operation}, you need read privilege on the individual tags. The {@term list} will only contain tags for which you have read privileges.
|
195
|
+
|
196
|
+
### Example
|
197
|
+
```ruby
|
198
|
+
# load the gem
|
199
|
+
require 'vsphere-automation-cis'
|
200
|
+
|
201
|
+
api_instance = VSphereAutomation::CIS::TaggingTagApi.new
|
202
|
+
|
203
|
+
begin
|
204
|
+
#Enumerates the tags in the system. To invoke this {@term operation}, you need read privilege on the individual tags. The {@term list} will only contain tags for which you have read privileges.
|
205
|
+
result = api_instance.list
|
206
|
+
p result
|
207
|
+
rescue VSphereAutomation::ApiError => e
|
208
|
+
puts "Exception when calling TaggingTagApi->list: #{e}"
|
209
|
+
end
|
210
|
+
```
|
211
|
+
|
212
|
+
### Parameters
|
213
|
+
This endpoint does not need any parameter.
|
214
|
+
|
215
|
+
### Return type
|
216
|
+
|
217
|
+
[**CisTaggingTagListResult**](CisTaggingTagListResult.md)
|
218
|
+
|
219
|
+
### Authorization
|
220
|
+
|
221
|
+
No authorization required
|
222
|
+
|
223
|
+
### HTTP request headers
|
224
|
+
|
225
|
+
- **Content-Type**: Not defined
|
226
|
+
- **Accept**: */*
|
227
|
+
|
228
|
+
|
229
|
+
|
230
|
+
# **list_tags_for_category**
|
231
|
+
> CisTaggingTagListTagsForCategoryResult list_tags_for_category(category_id)
|
232
|
+
|
233
|
+
Enumerates all tags for the given category. To invoke this {@term operation}, you need the read privilege on the given category and the individual tags in that category.
|
234
|
+
|
235
|
+
### Example
|
236
|
+
```ruby
|
237
|
+
# load the gem
|
238
|
+
require 'vsphere-automation-cis'
|
239
|
+
|
240
|
+
api_instance = VSphereAutomation::CIS::TaggingTagApi.new
|
241
|
+
category_id = 'category_id_example' # String | The identifier of the input category.
|
242
|
+
|
243
|
+
begin
|
244
|
+
#Enumerates all tags for the given category. To invoke this {@term operation}, you need the read privilege on the given category and the individual tags in that category.
|
245
|
+
result = api_instance.list_tags_for_category(category_id)
|
246
|
+
p result
|
247
|
+
rescue VSphereAutomation::ApiError => e
|
248
|
+
puts "Exception when calling TaggingTagApi->list_tags_for_category: #{e}"
|
249
|
+
end
|
250
|
+
```
|
251
|
+
|
252
|
+
### Parameters
|
253
|
+
|
254
|
+
Name | Type | Description | Notes
|
255
|
+
------------- | ------------- | ------------- | -------------
|
256
|
+
**category_id** | **String**| The identifier of the input category. |
|
257
|
+
|
258
|
+
### Return type
|
259
|
+
|
260
|
+
[**CisTaggingTagListTagsForCategoryResult**](CisTaggingTagListTagsForCategoryResult.md)
|
261
|
+
|
262
|
+
### Authorization
|
263
|
+
|
264
|
+
No authorization required
|
265
|
+
|
266
|
+
### HTTP request headers
|
267
|
+
|
268
|
+
- **Content-Type**: Not defined
|
269
|
+
- **Accept**: */*
|
270
|
+
|
271
|
+
|
272
|
+
|
273
|
+
# **list_used_tags**
|
274
|
+
> CisTaggingTagListUsedTagsResult list_used_tags(cis_tagging_tag_list_used_tags)
|
275
|
+
|
276
|
+
Enumerates all tags for which the {@param.name usedByEntity} is part of the {@link TagModel#usedBy} subscribers {@term set}. To invoke this {@term operation}, you need the read privilege on the individual tags.
|
277
|
+
|
278
|
+
### Example
|
279
|
+
```ruby
|
280
|
+
# load the gem
|
281
|
+
require 'vsphere-automation-cis'
|
282
|
+
|
283
|
+
api_instance = VSphereAutomation::CIS::TaggingTagApi.new
|
284
|
+
cis_tagging_tag_list_used_tags = VSphereAutomation::CisTaggingTagListUsedTags.new # CisTaggingTagListUsedTags |
|
285
|
+
|
286
|
+
begin
|
287
|
+
#Enumerates all tags for which the {@param.name usedByEntity} is part of the {@link TagModel#usedBy} subscribers {@term set}. To invoke this {@term operation}, you need the read privilege on the individual tags.
|
288
|
+
result = api_instance.list_used_tags(cis_tagging_tag_list_used_tags)
|
289
|
+
p result
|
290
|
+
rescue VSphereAutomation::ApiError => e
|
291
|
+
puts "Exception when calling TaggingTagApi->list_used_tags: #{e}"
|
292
|
+
end
|
293
|
+
```
|
294
|
+
|
295
|
+
### Parameters
|
296
|
+
|
297
|
+
Name | Type | Description | Notes
|
298
|
+
------------- | ------------- | ------------- | -------------
|
299
|
+
**cis_tagging_tag_list_used_tags** | [**CisTaggingTagListUsedTags**](CisTaggingTagListUsedTags.md)| |
|
300
|
+
|
301
|
+
### Return type
|
302
|
+
|
303
|
+
[**CisTaggingTagListUsedTagsResult**](CisTaggingTagListUsedTagsResult.md)
|
304
|
+
|
305
|
+
### Authorization
|
306
|
+
|
307
|
+
No authorization required
|
308
|
+
|
309
|
+
### HTTP request headers
|
310
|
+
|
311
|
+
- **Content-Type**: application/json
|
312
|
+
- **Accept**: */*
|
313
|
+
|
314
|
+
|
315
|
+
|
316
|
+
# **remove_from_used_by**
|
317
|
+
> remove_from_used_by(tag_id, cis_tagging_tag_remove_from_used_by)
|
318
|
+
|
319
|
+
Removes the {@param.name usedByEntity} from the {@link TagModel#usedBy} subscribers set. If the {@param.name usedByEntity} is not using this tag, then this becomes a no-op. To invoke this {@term operation}, you need modify {@link TagModel#usedBy} privilege on the tag.
|
320
|
+
|
321
|
+
### Example
|
322
|
+
```ruby
|
323
|
+
# load the gem
|
324
|
+
require 'vsphere-automation-cis'
|
325
|
+
|
326
|
+
api_instance = VSphereAutomation::CIS::TaggingTagApi.new
|
327
|
+
tag_id = 'tag_id_example' # String | The identifier of the input tag.
|
328
|
+
cis_tagging_tag_remove_from_used_by = VSphereAutomation::CisTaggingTagRemoveFromUsedBy.new # CisTaggingTagRemoveFromUsedBy |
|
329
|
+
|
330
|
+
begin
|
331
|
+
#Removes the {@param.name usedByEntity} from the {@link TagModel#usedBy} subscribers set. If the {@param.name usedByEntity} is not using this tag, then this becomes a no-op. To invoke this {@term operation}, you need modify {@link TagModel#usedBy} privilege on the tag.
|
332
|
+
api_instance.remove_from_used_by(tag_id, cis_tagging_tag_remove_from_used_by)
|
333
|
+
rescue VSphereAutomation::ApiError => e
|
334
|
+
puts "Exception when calling TaggingTagApi->remove_from_used_by: #{e}"
|
335
|
+
end
|
336
|
+
```
|
337
|
+
|
338
|
+
### Parameters
|
339
|
+
|
340
|
+
Name | Type | Description | Notes
|
341
|
+
------------- | ------------- | ------------- | -------------
|
342
|
+
**tag_id** | **String**| The identifier of the input tag. |
|
343
|
+
**cis_tagging_tag_remove_from_used_by** | [**CisTaggingTagRemoveFromUsedBy**](CisTaggingTagRemoveFromUsedBy.md)| |
|
344
|
+
|
345
|
+
### Return type
|
346
|
+
|
347
|
+
nil (empty response body)
|
348
|
+
|
349
|
+
### Authorization
|
350
|
+
|
351
|
+
No authorization required
|
352
|
+
|
353
|
+
### HTTP request headers
|
354
|
+
|
355
|
+
- **Content-Type**: application/json
|
356
|
+
- **Accept**: */*
|
357
|
+
|
358
|
+
|
359
|
+
|
360
|
+
# **revoke_propagating_permissions**
|
361
|
+
> revoke_propagating_permissions(tag_id)
|
362
|
+
|
363
|
+
Revokes all propagating permissions on the given tag. You should then attach a direct permission with tagging privileges on the given tag. To invoke this {@term operation}, you need tag related privileges (direct or propagating) on the concerned tag.
|
364
|
+
|
365
|
+
### Example
|
366
|
+
```ruby
|
367
|
+
# load the gem
|
368
|
+
require 'vsphere-automation-cis'
|
369
|
+
|
370
|
+
api_instance = VSphereAutomation::CIS::TaggingTagApi.new
|
371
|
+
tag_id = 'tag_id_example' # String | The identifier of the input tag.
|
372
|
+
|
373
|
+
begin
|
374
|
+
#Revokes all propagating permissions on the given tag. You should then attach a direct permission with tagging privileges on the given tag. To invoke this {@term operation}, you need tag related privileges (direct or propagating) on the concerned tag.
|
375
|
+
api_instance.revoke_propagating_permissions(tag_id)
|
376
|
+
rescue VSphereAutomation::ApiError => e
|
377
|
+
puts "Exception when calling TaggingTagApi->revoke_propagating_permissions: #{e}"
|
378
|
+
end
|
379
|
+
```
|
380
|
+
|
381
|
+
### Parameters
|
382
|
+
|
383
|
+
Name | Type | Description | Notes
|
384
|
+
------------- | ------------- | ------------- | -------------
|
385
|
+
**tag_id** | **String**| The identifier of the input tag. |
|
386
|
+
|
387
|
+
### Return type
|
388
|
+
|
389
|
+
nil (empty response body)
|
390
|
+
|
391
|
+
### Authorization
|
392
|
+
|
393
|
+
No authorization required
|
394
|
+
|
395
|
+
### HTTP request headers
|
396
|
+
|
397
|
+
- **Content-Type**: Not defined
|
398
|
+
- **Accept**: */*
|
399
|
+
|
400
|
+
|
401
|
+
|
402
|
+
# **update**
|
403
|
+
> update(tag_id, cis_tagging_tag_update)
|
404
|
+
|
405
|
+
Updates an existing tag. To invoke this {@term operation}, you need the edit privilege on the tag.
|
406
|
+
|
407
|
+
### Example
|
408
|
+
```ruby
|
409
|
+
# load the gem
|
410
|
+
require 'vsphere-automation-cis'
|
411
|
+
|
412
|
+
api_instance = VSphereAutomation::CIS::TaggingTagApi.new
|
413
|
+
tag_id = 'tag_id_example' # String | The identifier of the input tag.
|
414
|
+
cis_tagging_tag_update = VSphereAutomation::CisTaggingTagUpdate.new # CisTaggingTagUpdate |
|
415
|
+
|
416
|
+
begin
|
417
|
+
#Updates an existing tag. To invoke this {@term operation}, you need the edit privilege on the tag.
|
418
|
+
api_instance.update(tag_id, cis_tagging_tag_update)
|
419
|
+
rescue VSphereAutomation::ApiError => e
|
420
|
+
puts "Exception when calling TaggingTagApi->update: #{e}"
|
421
|
+
end
|
422
|
+
```
|
423
|
+
|
424
|
+
### Parameters
|
425
|
+
|
426
|
+
Name | Type | Description | Notes
|
427
|
+
------------- | ------------- | ------------- | -------------
|
428
|
+
**tag_id** | **String**| The identifier of the input tag. |
|
429
|
+
**cis_tagging_tag_update** | [**CisTaggingTagUpdate**](CisTaggingTagUpdate.md)| |
|
430
|
+
|
431
|
+
### Return type
|
432
|
+
|
433
|
+
nil (empty response body)
|
434
|
+
|
435
|
+
### Authorization
|
436
|
+
|
437
|
+
No authorization required
|
438
|
+
|
439
|
+
### HTTP request headers
|
440
|
+
|
441
|
+
- **Content-Type**: application/json
|
442
|
+
- **Accept**: */*
|
443
|
+
|
444
|
+
|
445
|
+
|
@@ -0,0 +1,498 @@
|
|
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, cis_tagging_tag_association_attach)
|
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
|
+
|
30
|
+
api_instance = VSphereAutomation::CIS::TaggingTagAssociationApi.new
|
31
|
+
tag_id = 'tag_id_example' # String | The identifier of the input tag.
|
32
|
+
cis_tagging_tag_association_attach = VSphereAutomation::CisTaggingTagAssociationAttach.new # CisTaggingTagAssociationAttach |
|
33
|
+
|
34
|
+
begin
|
35
|
+
#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.
|
36
|
+
api_instance.attach(tag_id, cis_tagging_tag_association_attach)
|
37
|
+
rescue VSphereAutomation::ApiError => e
|
38
|
+
puts "Exception when calling TaggingTagAssociationApi->attach: #{e}"
|
39
|
+
end
|
40
|
+
```
|
41
|
+
|
42
|
+
### Parameters
|
43
|
+
|
44
|
+
Name | Type | Description | Notes
|
45
|
+
------------- | ------------- | ------------- | -------------
|
46
|
+
**tag_id** | **String**| The identifier of the input tag. |
|
47
|
+
**cis_tagging_tag_association_attach** | [**CisTaggingTagAssociationAttach**](CisTaggingTagAssociationAttach.md)| |
|
48
|
+
|
49
|
+
### Return type
|
50
|
+
|
51
|
+
nil (empty response body)
|
52
|
+
|
53
|
+
### Authorization
|
54
|
+
|
55
|
+
No authorization required
|
56
|
+
|
57
|
+
### HTTP request headers
|
58
|
+
|
59
|
+
- **Content-Type**: application/json
|
60
|
+
- **Accept**: */*
|
61
|
+
|
62
|
+
|
63
|
+
|
64
|
+
# **attach_multiple_tags_to_object**
|
65
|
+
> CisTaggingTagAssociationAttachMultipleTagsToObjectResult attach_multiple_tags_to_object(cis_tagging_tag_association_attach_multiple_tags_to_object)
|
66
|
+
|
67
|
+
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.
|
68
|
+
|
69
|
+
### Example
|
70
|
+
```ruby
|
71
|
+
# load the gem
|
72
|
+
require 'vsphere-automation-cis'
|
73
|
+
|
74
|
+
api_instance = VSphereAutomation::CIS::TaggingTagAssociationApi.new
|
75
|
+
cis_tagging_tag_association_attach_multiple_tags_to_object = VSphereAutomation::CisTaggingTagAssociationAttachMultipleTagsToObject.new # CisTaggingTagAssociationAttachMultipleTagsToObject |
|
76
|
+
|
77
|
+
begin
|
78
|
+
#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.
|
79
|
+
result = api_instance.attach_multiple_tags_to_object(cis_tagging_tag_association_attach_multiple_tags_to_object)
|
80
|
+
p result
|
81
|
+
rescue VSphereAutomation::ApiError => e
|
82
|
+
puts "Exception when calling TaggingTagAssociationApi->attach_multiple_tags_to_object: #{e}"
|
83
|
+
end
|
84
|
+
```
|
85
|
+
|
86
|
+
### Parameters
|
87
|
+
|
88
|
+
Name | Type | Description | Notes
|
89
|
+
------------- | ------------- | ------------- | -------------
|
90
|
+
**cis_tagging_tag_association_attach_multiple_tags_to_object** | [**CisTaggingTagAssociationAttachMultipleTagsToObject**](CisTaggingTagAssociationAttachMultipleTagsToObject.md)| |
|
91
|
+
|
92
|
+
### Return type
|
93
|
+
|
94
|
+
[**CisTaggingTagAssociationAttachMultipleTagsToObjectResult**](CisTaggingTagAssociationAttachMultipleTagsToObjectResult.md)
|
95
|
+
|
96
|
+
### Authorization
|
97
|
+
|
98
|
+
No authorization required
|
99
|
+
|
100
|
+
### HTTP request headers
|
101
|
+
|
102
|
+
- **Content-Type**: application/json
|
103
|
+
- **Accept**: */*
|
104
|
+
|
105
|
+
|
106
|
+
|
107
|
+
# **attach_tag_to_multiple_objects**
|
108
|
+
> CisTaggingTagAssociationAttachTagToMultipleObjectsResult attach_tag_to_multiple_objects(tag_id, cis_tagging_tag_association_attach_tag_to_multiple_objects)
|
109
|
+
|
110
|
+
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.
|
111
|
+
|
112
|
+
### Example
|
113
|
+
```ruby
|
114
|
+
# load the gem
|
115
|
+
require 'vsphere-automation-cis'
|
116
|
+
|
117
|
+
api_instance = VSphereAutomation::CIS::TaggingTagAssociationApi.new
|
118
|
+
tag_id = 'tag_id_example' # String | The identifier of the input tag.
|
119
|
+
cis_tagging_tag_association_attach_tag_to_multiple_objects = VSphereAutomation::CisTaggingTagAssociationAttachTagToMultipleObjects.new # CisTaggingTagAssociationAttachTagToMultipleObjects |
|
120
|
+
|
121
|
+
begin
|
122
|
+
#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.
|
123
|
+
result = api_instance.attach_tag_to_multiple_objects(tag_id, cis_tagging_tag_association_attach_tag_to_multiple_objects)
|
124
|
+
p result
|
125
|
+
rescue VSphereAutomation::ApiError => e
|
126
|
+
puts "Exception when calling TaggingTagAssociationApi->attach_tag_to_multiple_objects: #{e}"
|
127
|
+
end
|
128
|
+
```
|
129
|
+
|
130
|
+
### Parameters
|
131
|
+
|
132
|
+
Name | Type | Description | Notes
|
133
|
+
------------- | ------------- | ------------- | -------------
|
134
|
+
**tag_id** | **String**| The identifier of the input tag. |
|
135
|
+
**cis_tagging_tag_association_attach_tag_to_multiple_objects** | [**CisTaggingTagAssociationAttachTagToMultipleObjects**](CisTaggingTagAssociationAttachTagToMultipleObjects.md)| |
|
136
|
+
|
137
|
+
### Return type
|
138
|
+
|
139
|
+
[**CisTaggingTagAssociationAttachTagToMultipleObjectsResult**](CisTaggingTagAssociationAttachTagToMultipleObjectsResult.md)
|
140
|
+
|
141
|
+
### Authorization
|
142
|
+
|
143
|
+
No authorization required
|
144
|
+
|
145
|
+
### HTTP request headers
|
146
|
+
|
147
|
+
- **Content-Type**: application/json
|
148
|
+
- **Accept**: */*
|
149
|
+
|
150
|
+
|
151
|
+
|
152
|
+
# **detach**
|
153
|
+
> detach(tag_id, cis_tagging_tag_association_detach)
|
154
|
+
|
155
|
+
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.
|
156
|
+
|
157
|
+
### Example
|
158
|
+
```ruby
|
159
|
+
# load the gem
|
160
|
+
require 'vsphere-automation-cis'
|
161
|
+
|
162
|
+
api_instance = VSphereAutomation::CIS::TaggingTagAssociationApi.new
|
163
|
+
tag_id = 'tag_id_example' # String | The identifier of the input tag.
|
164
|
+
cis_tagging_tag_association_detach = VSphereAutomation::CisTaggingTagAssociationDetach.new # CisTaggingTagAssociationDetach |
|
165
|
+
|
166
|
+
begin
|
167
|
+
#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.
|
168
|
+
api_instance.detach(tag_id, cis_tagging_tag_association_detach)
|
169
|
+
rescue VSphereAutomation::ApiError => e
|
170
|
+
puts "Exception when calling TaggingTagAssociationApi->detach: #{e}"
|
171
|
+
end
|
172
|
+
```
|
173
|
+
|
174
|
+
### Parameters
|
175
|
+
|
176
|
+
Name | Type | Description | Notes
|
177
|
+
------------- | ------------- | ------------- | -------------
|
178
|
+
**tag_id** | **String**| The identifier of the input tag. |
|
179
|
+
**cis_tagging_tag_association_detach** | [**CisTaggingTagAssociationDetach**](CisTaggingTagAssociationDetach.md)| |
|
180
|
+
|
181
|
+
### Return type
|
182
|
+
|
183
|
+
nil (empty response body)
|
184
|
+
|
185
|
+
### Authorization
|
186
|
+
|
187
|
+
No authorization required
|
188
|
+
|
189
|
+
### HTTP request headers
|
190
|
+
|
191
|
+
- **Content-Type**: application/json
|
192
|
+
- **Accept**: */*
|
193
|
+
|
194
|
+
|
195
|
+
|
196
|
+
# **detach_multiple_tags_from_object**
|
197
|
+
> CisTaggingTagAssociationDetachMultipleTagsFromObjectResult detach_multiple_tags_from_object(cis_tagging_tag_association_detach_multiple_tags_from_object)
|
198
|
+
|
199
|
+
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.
|
200
|
+
|
201
|
+
### Example
|
202
|
+
```ruby
|
203
|
+
# load the gem
|
204
|
+
require 'vsphere-automation-cis'
|
205
|
+
|
206
|
+
api_instance = VSphereAutomation::CIS::TaggingTagAssociationApi.new
|
207
|
+
cis_tagging_tag_association_detach_multiple_tags_from_object = VSphereAutomation::CisTaggingTagAssociationDetachMultipleTagsFromObject.new # CisTaggingTagAssociationDetachMultipleTagsFromObject |
|
208
|
+
|
209
|
+
begin
|
210
|
+
#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.
|
211
|
+
result = api_instance.detach_multiple_tags_from_object(cis_tagging_tag_association_detach_multiple_tags_from_object)
|
212
|
+
p result
|
213
|
+
rescue VSphereAutomation::ApiError => e
|
214
|
+
puts "Exception when calling TaggingTagAssociationApi->detach_multiple_tags_from_object: #{e}"
|
215
|
+
end
|
216
|
+
```
|
217
|
+
|
218
|
+
### Parameters
|
219
|
+
|
220
|
+
Name | Type | Description | Notes
|
221
|
+
------------- | ------------- | ------------- | -------------
|
222
|
+
**cis_tagging_tag_association_detach_multiple_tags_from_object** | [**CisTaggingTagAssociationDetachMultipleTagsFromObject**](CisTaggingTagAssociationDetachMultipleTagsFromObject.md)| |
|
223
|
+
|
224
|
+
### Return type
|
225
|
+
|
226
|
+
[**CisTaggingTagAssociationDetachMultipleTagsFromObjectResult**](CisTaggingTagAssociationDetachMultipleTagsFromObjectResult.md)
|
227
|
+
|
228
|
+
### Authorization
|
229
|
+
|
230
|
+
No authorization required
|
231
|
+
|
232
|
+
### HTTP request headers
|
233
|
+
|
234
|
+
- **Content-Type**: application/json
|
235
|
+
- **Accept**: */*
|
236
|
+
|
237
|
+
|
238
|
+
|
239
|
+
# **detach_tag_from_multiple_objects**
|
240
|
+
> CisTaggingTagAssociationDetachTagFromMultipleObjectsResult detach_tag_from_multiple_objects(tag_id, cis_tagging_tag_association_detach_tag_from_multiple_objects)
|
241
|
+
|
242
|
+
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.
|
243
|
+
|
244
|
+
### Example
|
245
|
+
```ruby
|
246
|
+
# load the gem
|
247
|
+
require 'vsphere-automation-cis'
|
248
|
+
|
249
|
+
api_instance = VSphereAutomation::CIS::TaggingTagAssociationApi.new
|
250
|
+
tag_id = 'tag_id_example' # String | The identifier of the input tag.
|
251
|
+
cis_tagging_tag_association_detach_tag_from_multiple_objects = VSphereAutomation::CisTaggingTagAssociationDetachTagFromMultipleObjects.new # CisTaggingTagAssociationDetachTagFromMultipleObjects |
|
252
|
+
|
253
|
+
begin
|
254
|
+
#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.
|
255
|
+
result = api_instance.detach_tag_from_multiple_objects(tag_id, cis_tagging_tag_association_detach_tag_from_multiple_objects)
|
256
|
+
p result
|
257
|
+
rescue VSphereAutomation::ApiError => e
|
258
|
+
puts "Exception when calling TaggingTagAssociationApi->detach_tag_from_multiple_objects: #{e}"
|
259
|
+
end
|
260
|
+
```
|
261
|
+
|
262
|
+
### Parameters
|
263
|
+
|
264
|
+
Name | Type | Description | Notes
|
265
|
+
------------- | ------------- | ------------- | -------------
|
266
|
+
**tag_id** | **String**| The identifier of the input tag. |
|
267
|
+
**cis_tagging_tag_association_detach_tag_from_multiple_objects** | [**CisTaggingTagAssociationDetachTagFromMultipleObjects**](CisTaggingTagAssociationDetachTagFromMultipleObjects.md)| |
|
268
|
+
|
269
|
+
### Return type
|
270
|
+
|
271
|
+
[**CisTaggingTagAssociationDetachTagFromMultipleObjectsResult**](CisTaggingTagAssociationDetachTagFromMultipleObjectsResult.md)
|
272
|
+
|
273
|
+
### Authorization
|
274
|
+
|
275
|
+
No authorization required
|
276
|
+
|
277
|
+
### HTTP request headers
|
278
|
+
|
279
|
+
- **Content-Type**: application/json
|
280
|
+
- **Accept**: */*
|
281
|
+
|
282
|
+
|
283
|
+
|
284
|
+
# **list_attachable_tags**
|
285
|
+
> CisTaggingTagAssociationListAttachableTagsResult list_attachable_tags(cis_tagging_tag_association_list_attachable_tags)
|
286
|
+
|
287
|
+
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.
|
288
|
+
|
289
|
+
### Example
|
290
|
+
```ruby
|
291
|
+
# load the gem
|
292
|
+
require 'vsphere-automation-cis'
|
293
|
+
|
294
|
+
api_instance = VSphereAutomation::CIS::TaggingTagAssociationApi.new
|
295
|
+
cis_tagging_tag_association_list_attachable_tags = VSphereAutomation::CisTaggingTagAssociationListAttachableTags.new # CisTaggingTagAssociationListAttachableTags |
|
296
|
+
|
297
|
+
begin
|
298
|
+
#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.
|
299
|
+
result = api_instance.list_attachable_tags(cis_tagging_tag_association_list_attachable_tags)
|
300
|
+
p result
|
301
|
+
rescue VSphereAutomation::ApiError => e
|
302
|
+
puts "Exception when calling TaggingTagAssociationApi->list_attachable_tags: #{e}"
|
303
|
+
end
|
304
|
+
```
|
305
|
+
|
306
|
+
### Parameters
|
307
|
+
|
308
|
+
Name | Type | Description | Notes
|
309
|
+
------------- | ------------- | ------------- | -------------
|
310
|
+
**cis_tagging_tag_association_list_attachable_tags** | [**CisTaggingTagAssociationListAttachableTags**](CisTaggingTagAssociationListAttachableTags.md)| |
|
311
|
+
|
312
|
+
### Return type
|
313
|
+
|
314
|
+
[**CisTaggingTagAssociationListAttachableTagsResult**](CisTaggingTagAssociationListAttachableTagsResult.md)
|
315
|
+
|
316
|
+
### Authorization
|
317
|
+
|
318
|
+
No authorization required
|
319
|
+
|
320
|
+
### HTTP request headers
|
321
|
+
|
322
|
+
- **Content-Type**: application/json
|
323
|
+
- **Accept**: */*
|
324
|
+
|
325
|
+
|
326
|
+
|
327
|
+
# **list_attached_objects**
|
328
|
+
> CisTaggingTagAssociationListAttachedObjectsResult list_attached_objects(tag_id)
|
329
|
+
|
330
|
+
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.
|
331
|
+
|
332
|
+
### Example
|
333
|
+
```ruby
|
334
|
+
# load the gem
|
335
|
+
require 'vsphere-automation-cis'
|
336
|
+
|
337
|
+
api_instance = VSphereAutomation::CIS::TaggingTagAssociationApi.new
|
338
|
+
tag_id = 'tag_id_example' # String | The identifier of the input tag.
|
339
|
+
|
340
|
+
begin
|
341
|
+
#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.
|
342
|
+
result = api_instance.list_attached_objects(tag_id)
|
343
|
+
p result
|
344
|
+
rescue VSphereAutomation::ApiError => e
|
345
|
+
puts "Exception when calling TaggingTagAssociationApi->list_attached_objects: #{e}"
|
346
|
+
end
|
347
|
+
```
|
348
|
+
|
349
|
+
### Parameters
|
350
|
+
|
351
|
+
Name | Type | Description | Notes
|
352
|
+
------------- | ------------- | ------------- | -------------
|
353
|
+
**tag_id** | **String**| The identifier of the input tag. |
|
354
|
+
|
355
|
+
### Return type
|
356
|
+
|
357
|
+
[**CisTaggingTagAssociationListAttachedObjectsResult**](CisTaggingTagAssociationListAttachedObjectsResult.md)
|
358
|
+
|
359
|
+
### Authorization
|
360
|
+
|
361
|
+
No authorization required
|
362
|
+
|
363
|
+
### HTTP request headers
|
364
|
+
|
365
|
+
- **Content-Type**: Not defined
|
366
|
+
- **Accept**: */*
|
367
|
+
|
368
|
+
|
369
|
+
|
370
|
+
# **list_attached_objects_on_tags**
|
371
|
+
> CisTaggingTagAssociationListAttachedObjectsOnTagsResult list_attached_objects_on_tags(cis_tagging_tag_association_list_attached_objects_on_tags)
|
372
|
+
|
373
|
+
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.
|
374
|
+
|
375
|
+
### Example
|
376
|
+
```ruby
|
377
|
+
# load the gem
|
378
|
+
require 'vsphere-automation-cis'
|
379
|
+
|
380
|
+
api_instance = VSphereAutomation::CIS::TaggingTagAssociationApi.new
|
381
|
+
cis_tagging_tag_association_list_attached_objects_on_tags = VSphereAutomation::CisTaggingTagAssociationListAttachedObjectsOnTags.new # CisTaggingTagAssociationListAttachedObjectsOnTags |
|
382
|
+
|
383
|
+
begin
|
384
|
+
#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.
|
385
|
+
result = api_instance.list_attached_objects_on_tags(cis_tagging_tag_association_list_attached_objects_on_tags)
|
386
|
+
p result
|
387
|
+
rescue VSphereAutomation::ApiError => e
|
388
|
+
puts "Exception when calling TaggingTagAssociationApi->list_attached_objects_on_tags: #{e}"
|
389
|
+
end
|
390
|
+
```
|
391
|
+
|
392
|
+
### Parameters
|
393
|
+
|
394
|
+
Name | Type | Description | Notes
|
395
|
+
------------- | ------------- | ------------- | -------------
|
396
|
+
**cis_tagging_tag_association_list_attached_objects_on_tags** | [**CisTaggingTagAssociationListAttachedObjectsOnTags**](CisTaggingTagAssociationListAttachedObjectsOnTags.md)| |
|
397
|
+
|
398
|
+
### Return type
|
399
|
+
|
400
|
+
[**CisTaggingTagAssociationListAttachedObjectsOnTagsResult**](CisTaggingTagAssociationListAttachedObjectsOnTagsResult.md)
|
401
|
+
|
402
|
+
### Authorization
|
403
|
+
|
404
|
+
No authorization required
|
405
|
+
|
406
|
+
### HTTP request headers
|
407
|
+
|
408
|
+
- **Content-Type**: application/json
|
409
|
+
- **Accept**: */*
|
410
|
+
|
411
|
+
|
412
|
+
|
413
|
+
# **list_attached_tags**
|
414
|
+
> CisTaggingTagAssociationListAttachedTagsResult list_attached_tags(cis_tagging_tag_association_list_attached_tags)
|
415
|
+
|
416
|
+
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.
|
417
|
+
|
418
|
+
### Example
|
419
|
+
```ruby
|
420
|
+
# load the gem
|
421
|
+
require 'vsphere-automation-cis'
|
422
|
+
|
423
|
+
api_instance = VSphereAutomation::CIS::TaggingTagAssociationApi.new
|
424
|
+
cis_tagging_tag_association_list_attached_tags = VSphereAutomation::CisTaggingTagAssociationListAttachedTags.new # CisTaggingTagAssociationListAttachedTags |
|
425
|
+
|
426
|
+
begin
|
427
|
+
#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.
|
428
|
+
result = api_instance.list_attached_tags(cis_tagging_tag_association_list_attached_tags)
|
429
|
+
p result
|
430
|
+
rescue VSphereAutomation::ApiError => e
|
431
|
+
puts "Exception when calling TaggingTagAssociationApi->list_attached_tags: #{e}"
|
432
|
+
end
|
433
|
+
```
|
434
|
+
|
435
|
+
### Parameters
|
436
|
+
|
437
|
+
Name | Type | Description | Notes
|
438
|
+
------------- | ------------- | ------------- | -------------
|
439
|
+
**cis_tagging_tag_association_list_attached_tags** | [**CisTaggingTagAssociationListAttachedTags**](CisTaggingTagAssociationListAttachedTags.md)| |
|
440
|
+
|
441
|
+
### Return type
|
442
|
+
|
443
|
+
[**CisTaggingTagAssociationListAttachedTagsResult**](CisTaggingTagAssociationListAttachedTagsResult.md)
|
444
|
+
|
445
|
+
### Authorization
|
446
|
+
|
447
|
+
No authorization required
|
448
|
+
|
449
|
+
### HTTP request headers
|
450
|
+
|
451
|
+
- **Content-Type**: application/json
|
452
|
+
- **Accept**: */*
|
453
|
+
|
454
|
+
|
455
|
+
|
456
|
+
# **list_attached_tags_on_objects**
|
457
|
+
> CisTaggingTagAssociationListAttachedTagsOnObjectsResult list_attached_tags_on_objects(cis_tagging_tag_association_list_attached_tags_on_objects)
|
458
|
+
|
459
|
+
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.
|
460
|
+
|
461
|
+
### Example
|
462
|
+
```ruby
|
463
|
+
# load the gem
|
464
|
+
require 'vsphere-automation-cis'
|
465
|
+
|
466
|
+
api_instance = VSphereAutomation::CIS::TaggingTagAssociationApi.new
|
467
|
+
cis_tagging_tag_association_list_attached_tags_on_objects = VSphereAutomation::CisTaggingTagAssociationListAttachedTagsOnObjects.new # CisTaggingTagAssociationListAttachedTagsOnObjects |
|
468
|
+
|
469
|
+
begin
|
470
|
+
#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.
|
471
|
+
result = api_instance.list_attached_tags_on_objects(cis_tagging_tag_association_list_attached_tags_on_objects)
|
472
|
+
p result
|
473
|
+
rescue VSphereAutomation::ApiError => e
|
474
|
+
puts "Exception when calling TaggingTagAssociationApi->list_attached_tags_on_objects: #{e}"
|
475
|
+
end
|
476
|
+
```
|
477
|
+
|
478
|
+
### Parameters
|
479
|
+
|
480
|
+
Name | Type | Description | Notes
|
481
|
+
------------- | ------------- | ------------- | -------------
|
482
|
+
**cis_tagging_tag_association_list_attached_tags_on_objects** | [**CisTaggingTagAssociationListAttachedTagsOnObjects**](CisTaggingTagAssociationListAttachedTagsOnObjects.md)| |
|
483
|
+
|
484
|
+
### Return type
|
485
|
+
|
486
|
+
[**CisTaggingTagAssociationListAttachedTagsOnObjectsResult**](CisTaggingTagAssociationListAttachedTagsOnObjectsResult.md)
|
487
|
+
|
488
|
+
### Authorization
|
489
|
+
|
490
|
+
No authorization required
|
491
|
+
|
492
|
+
### HTTP request headers
|
493
|
+
|
494
|
+
- **Content-Type**: application/json
|
495
|
+
- **Accept**: */*
|
496
|
+
|
497
|
+
|
498
|
+
|