VMware vSphere Automation SDK for .NET 7.0.0.1
vmware::content::library::Subscriptions Interface Reference

The Subscriptions interface provides methods for managing the subscription information of the subscribers of a published library. More...

Inherited by vmware::content::library::SubscriptionsStub.

List of all members.

Public Member Functions

string Create (string clientToken, string library, vmware.content.library.SubscriptionsTypes.CreateSpec spec)
 Creates a subscription of the published library.
string Create (string clientToken, string library, vmware.content.library.SubscriptionsTypes.CreateSpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Creates a subscription of the published library.
global::System.Threading.Tasks.Task
< string > 
CreateAsync (string clientToken, string library, vmware.content.library.SubscriptionsTypes.CreateSpec spec)
 Creates a subscription of the published library.
global::System.Threading.Tasks.Task
< string > 
CreateAsync (string clientToken, string library, vmware.content.library.SubscriptionsTypes.CreateSpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Creates a subscription of the published library.
void Delete (string library, string subscription)
 Deletes the specified subscription of the published library.
void Delete (string library, string subscription, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Deletes the specified subscription of the published library.
global::System.Threading.Tasks.Task DeleteAsync (string library, string subscription)
 Deletes the specified subscription of the published library.
global::System.Threading.Tasks.Task DeleteAsync (string library, string subscription, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Deletes the specified subscription of the published library.
global::System.Collections.Generic.List
< vmware.content.library.SubscriptionsTypes.Summary
List (string library)
 Lists the subscriptions of the published library.
global::System.Collections.Generic.List
< vmware.content.library.SubscriptionsTypes.Summary
List (string library, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Lists the subscriptions of the published library.
global::System.Threading.Tasks.Task
< global::System.Collections.Generic.List
< vmware.content.library.SubscriptionsTypes.Summary > > 
ListAsync (string library)
 Lists the subscriptions of the published library.
global::System.Threading.Tasks.Task
< global::System.Collections.Generic.List
< vmware.content.library.SubscriptionsTypes.Summary > > 
ListAsync (string library, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Lists the subscriptions of the published library.
void Update (string library, string subscription, vmware.content.library.SubscriptionsTypes.UpdateSpec spec)
 Updates the specified subscription of the published library.
void Update (string library, string subscription, vmware.content.library.SubscriptionsTypes.UpdateSpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Updates the specified subscription of the published library.
global::System.Threading.Tasks.Task UpdateAsync (string library, string subscription, vmware.content.library.SubscriptionsTypes.UpdateSpec spec)
 Updates the specified subscription of the published library.
global::System.Threading.Tasks.Task UpdateAsync (string library, string subscription, vmware.content.library.SubscriptionsTypes.UpdateSpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Updates the specified subscription of the published library.
vmware.content.library.SubscriptionsTypes.Info Get (string library, string subscription)
 Returns information about the specified subscription of the published library.
vmware.content.library.SubscriptionsTypes.Info Get (string library, string subscription, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Returns information about the specified subscription of the published library.
global::System.Threading.Tasks.Task
< vmware.content.library.SubscriptionsTypes.Info
GetAsync (string library, string subscription)
 Returns information about the specified subscription of the published library.
global::System.Threading.Tasks.Task
< vmware.content.library.SubscriptionsTypes.Info
GetAsync (string library, string subscription, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Returns information about the specified subscription of the published library.

Detailed Description

The Subscriptions interface provides methods for managing the subscription information of the subscribers of a published library.

This interface was added in vSphere API 6.7.2.


Member Function Documentation

string vmware::content::library::Subscriptions::Create ( string  clientToken,
string  library,
vmware.content.library.SubscriptionsTypes.CreateSpec  spec 
)

Creates a subscription of the published library.

This method was added in vSphere API 6.7.2.

Exceptions:
vmware.vapi.std.errors.AlreadyExistsIf a subscription of the published library to the specified subscribed library already exists. This is only applicable when {@param.name subscribedLibrary#subscribedLibrary} is specified.
vmware.vapi.std.errors.ErrorIf the system reports an error while responding to the request.
vmware.vapi.std.errors.NotFoundIf the library specified by library does not exist.
vmware.vapi.std.errors.NotFoundIf the subscribed library specified by {@param.name subscribedLibrary#subscribedLibrary} does not exist at the vCenter instance specified by {@param.name subscribedLibrary#vcenter} .
vmware.vapi.std.errors.ResourceInaccessibleIf the vCenter instance specified by {@param.name subscribedLibrary#vcenter} cannot be contacted or found.
vmware.vapi.std.errors.InvalidArgumentIf Subscriptions.CreateSpec contains invalid arguments.
vmware.vapi.std.errors.InvalidElementTypeIf the library specified by library is a subscribed library.
vmware.vapi.std.errors.NotAllowedInCurrentStateIf the library specified by library is not a published library.
vmware.vapi.std.errors.UnauthenticatedIf the user that requested the method cannot be authenticated.
vmware.vapi.std.errors.UnauthorizedIf the user that requested the method is not authorized to perform the method.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • The resource com.vmware.content.Library referenced by the parameter library requires ContentLibrary.AddSubscription .
Parameters:
clientTokenA unique token generated on the client for each creation request. The token should be a universally unique identifier (UUID), for example: b8a2a2e3-2314-43cd-a871-6ede0f429751 . This token can be used to guarantee idempotent creation. If not specified, creation is not idempotent.
libraryIdentifier of the published library. The parameter must be an identifier for the resource type: com.vmware.content.Library .
specSpecification for the subscription.
Returns:
Subscription identifier. The result will be an identifier for the resource type: com.vmware.content.library.Subscriptions .

Implemented in vmware::content::library::SubscriptionsStub.

string vmware::content::library::Subscriptions::Create ( string  clientToken,
string  library,
vmware.content.library.SubscriptionsTypes.CreateSpec  spec,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Creates a subscription of the published library.

This method was added in vSphere API 6.7.2.

Exceptions:
vmware.vapi.std.errors.AlreadyExistsIf a subscription of the published library to the specified subscribed library already exists. This is only applicable when {@param.name subscribedLibrary#subscribedLibrary} is specified.
vmware.vapi.std.errors.ErrorIf the system reports an error while responding to the request.
vmware.vapi.std.errors.NotFoundIf the library specified by library does not exist.
vmware.vapi.std.errors.NotFoundIf the subscribed library specified by {@param.name subscribedLibrary#subscribedLibrary} does not exist at the vCenter instance specified by {@param.name subscribedLibrary#vcenter} .
vmware.vapi.std.errors.ResourceInaccessibleIf the vCenter instance specified by {@param.name subscribedLibrary#vcenter} cannot be contacted or found.
vmware.vapi.std.errors.InvalidArgumentIf Subscriptions.CreateSpec contains invalid arguments.
vmware.vapi.std.errors.InvalidElementTypeIf the library specified by library is a subscribed library.
vmware.vapi.std.errors.NotAllowedInCurrentStateIf the library specified by library is not a published library.
vmware.vapi.std.errors.UnauthenticatedIf the user that requested the method cannot be authenticated.
vmware.vapi.std.errors.UnauthorizedIf the user that requested the method is not authorized to perform the method.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • The resource com.vmware.content.Library referenced by the parameter library requires ContentLibrary.AddSubscription .
Parameters:
clientTokenA unique token generated on the client for each creation request. The token should be a universally unique identifier (UUID), for example: b8a2a2e3-2314-43cd-a871-6ede0f429751 . This token can be used to guarantee idempotent creation. If not specified, creation is not idempotent.
libraryIdentifier of the published library. The parameter must be an identifier for the resource type: com.vmware.content.Library .
specSpecification for the subscription.
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation
Returns:
Subscription identifier. The result will be an identifier for the resource type: com.vmware.content.library.Subscriptions .

Implemented in vmware::content::library::SubscriptionsStub.

global::System.Threading.Tasks.Task<string> vmware::content::library::Subscriptions::CreateAsync ( string  clientToken,
string  library,
vmware.content.library.SubscriptionsTypes.CreateSpec  spec,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Creates a subscription of the published library.

This method was added in vSphere API 6.7.2.

Exceptions:
vmware.vapi.std.errors.AlreadyExistsIf a subscription of the published library to the specified subscribed library already exists. This is only applicable when {@param.name subscribedLibrary#subscribedLibrary} is specified.
vmware.vapi.std.errors.ErrorIf the system reports an error while responding to the request.
vmware.vapi.std.errors.NotFoundIf the library specified by library does not exist.
vmware.vapi.std.errors.NotFoundIf the subscribed library specified by {@param.name subscribedLibrary#subscribedLibrary} does not exist at the vCenter instance specified by {@param.name subscribedLibrary#vcenter} .
vmware.vapi.std.errors.ResourceInaccessibleIf the vCenter instance specified by {@param.name subscribedLibrary#vcenter} cannot be contacted or found.
vmware.vapi.std.errors.InvalidArgumentIf Subscriptions.CreateSpec contains invalid arguments.
vmware.vapi.std.errors.InvalidElementTypeIf the library specified by library is a subscribed library.
vmware.vapi.std.errors.NotAllowedInCurrentStateIf the library specified by library is not a published library.
vmware.vapi.std.errors.UnauthenticatedIf the user that requested the method cannot be authenticated.
vmware.vapi.std.errors.UnauthorizedIf the user that requested the method is not authorized to perform the method.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • The resource com.vmware.content.Library referenced by the parameter library requires ContentLibrary.AddSubscription .
Parameters:
clientTokenA unique token generated on the client for each creation request. The token should be a universally unique identifier (UUID), for example: b8a2a2e3-2314-43cd-a871-6ede0f429751 . This token can be used to guarantee idempotent creation. If not specified, creation is not idempotent.
libraryIdentifier of the published library. The parameter must be an identifier for the resource type: com.vmware.content.Library .
specSpecification for the subscription.
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation
Returns:
Subscription identifier. The result will be an identifier for the resource type: com.vmware.content.library.Subscriptions .

Implemented in vmware::content::library::SubscriptionsStub.

global::System.Threading.Tasks.Task<string> vmware::content::library::Subscriptions::CreateAsync ( string  clientToken,
string  library,
vmware.content.library.SubscriptionsTypes.CreateSpec  spec 
)

Creates a subscription of the published library.

This method was added in vSphere API 6.7.2.

Exceptions:
vmware.vapi.std.errors.AlreadyExistsIf a subscription of the published library to the specified subscribed library already exists. This is only applicable when {@param.name subscribedLibrary#subscribedLibrary} is specified.
vmware.vapi.std.errors.ErrorIf the system reports an error while responding to the request.
vmware.vapi.std.errors.NotFoundIf the library specified by library does not exist.
vmware.vapi.std.errors.NotFoundIf the subscribed library specified by {@param.name subscribedLibrary#subscribedLibrary} does not exist at the vCenter instance specified by {@param.name subscribedLibrary#vcenter} .
vmware.vapi.std.errors.ResourceInaccessibleIf the vCenter instance specified by {@param.name subscribedLibrary#vcenter} cannot be contacted or found.
vmware.vapi.std.errors.InvalidArgumentIf Subscriptions.CreateSpec contains invalid arguments.
vmware.vapi.std.errors.InvalidElementTypeIf the library specified by library is a subscribed library.
vmware.vapi.std.errors.NotAllowedInCurrentStateIf the library specified by library is not a published library.
vmware.vapi.std.errors.UnauthenticatedIf the user that requested the method cannot be authenticated.
vmware.vapi.std.errors.UnauthorizedIf the user that requested the method is not authorized to perform the method.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • The resource com.vmware.content.Library referenced by the parameter library requires ContentLibrary.AddSubscription .
Parameters:
clientTokenA unique token generated on the client for each creation request. The token should be a universally unique identifier (UUID), for example: b8a2a2e3-2314-43cd-a871-6ede0f429751 . This token can be used to guarantee idempotent creation. If not specified, creation is not idempotent.
libraryIdentifier of the published library. The parameter must be an identifier for the resource type: com.vmware.content.Library .
specSpecification for the subscription.
Returns:
Subscription identifier. The result will be an identifier for the resource type: com.vmware.content.library.Subscriptions .

Implemented in vmware::content::library::SubscriptionsStub.

void vmware::content::library::Subscriptions::Delete ( string  library,
string  subscription 
)

Deletes the specified subscription of the published library.

The subscribed library associated with the subscription will not be deleted. This method was added in vSphere API 6.7.2.

Exceptions:
vmware.vapi.std.errors.ErrorIf the system reports an error while responding to the request.
vmware.vapi.std.errors.InvalidElementTypeIf the library specified by library is a subscribed library.
vmware.vapi.std.errors.NotAllowedInCurrentStateIf the library specified by library is not a published library.
vmware.vapi.std.errors.NotFoundIf the library specified by library does not exist.
vmware.vapi.std.errors.NotFoundIf the subscription specified by subscription does not exist for the library specified by library .
vmware.vapi.std.errors.UnauthenticatedIf the user that requested the method cannot be authenticated.
vmware.vapi.std.errors.UnauthorizedIf the user that requested the method is not authorized to perform the method.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • The resource com.vmware.content.Library referenced by the parameter library requires ContentLibrary.DeleteSubscription .
Parameters:
libraryIdentifier of the published library. The parameter must be an identifier for the resource type: com.vmware.content.Library .
subscriptionSubscription identifier. The parameter must be an identifier for the resource type: com.vmware.content.library.Subscriptions .

Implemented in vmware::content::library::SubscriptionsStub.

void vmware::content::library::Subscriptions::Delete ( string  library,
string  subscription,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Deletes the specified subscription of the published library.

The subscribed library associated with the subscription will not be deleted. This method was added in vSphere API 6.7.2.

Exceptions:
vmware.vapi.std.errors.ErrorIf the system reports an error while responding to the request.
vmware.vapi.std.errors.InvalidElementTypeIf the library specified by library is a subscribed library.
vmware.vapi.std.errors.NotAllowedInCurrentStateIf the library specified by library is not a published library.
vmware.vapi.std.errors.NotFoundIf the library specified by library does not exist.
vmware.vapi.std.errors.NotFoundIf the subscription specified by subscription does not exist for the library specified by library .
vmware.vapi.std.errors.UnauthenticatedIf the user that requested the method cannot be authenticated.
vmware.vapi.std.errors.UnauthorizedIf the user that requested the method is not authorized to perform the method.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • The resource com.vmware.content.Library referenced by the parameter library requires ContentLibrary.DeleteSubscription .
Parameters:
libraryIdentifier of the published library. The parameter must be an identifier for the resource type: com.vmware.content.Library .
subscriptionSubscription identifier. The parameter must be an identifier for the resource type: com.vmware.content.library.Subscriptions .
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation

Implemented in vmware::content::library::SubscriptionsStub.

global::System.Threading.Tasks.Task vmware::content::library::Subscriptions::DeleteAsync ( string  library,
string  subscription,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Deletes the specified subscription of the published library.

The subscribed library associated with the subscription will not be deleted. This method was added in vSphere API 6.7.2.

Exceptions:
vmware.vapi.std.errors.ErrorIf the system reports an error while responding to the request.
vmware.vapi.std.errors.InvalidElementTypeIf the library specified by library is a subscribed library.
vmware.vapi.std.errors.NotAllowedInCurrentStateIf the library specified by library is not a published library.
vmware.vapi.std.errors.NotFoundIf the library specified by library does not exist.
vmware.vapi.std.errors.NotFoundIf the subscription specified by subscription does not exist for the library specified by library .
vmware.vapi.std.errors.UnauthenticatedIf the user that requested the method cannot be authenticated.
vmware.vapi.std.errors.UnauthorizedIf the user that requested the method is not authorized to perform the method.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • The resource com.vmware.content.Library referenced by the parameter library requires ContentLibrary.DeleteSubscription .
Parameters:
libraryIdentifier of the published library. The parameter must be an identifier for the resource type: com.vmware.content.Library .
subscriptionSubscription identifier. The parameter must be an identifier for the resource type: com.vmware.content.library.Subscriptions .
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation

Implemented in vmware::content::library::SubscriptionsStub.

global::System.Threading.Tasks.Task vmware::content::library::Subscriptions::DeleteAsync ( string  library,
string  subscription 
)

Deletes the specified subscription of the published library.

The subscribed library associated with the subscription will not be deleted. This method was added in vSphere API 6.7.2.

Exceptions:
vmware.vapi.std.errors.ErrorIf the system reports an error while responding to the request.
vmware.vapi.std.errors.InvalidElementTypeIf the library specified by library is a subscribed library.
vmware.vapi.std.errors.NotAllowedInCurrentStateIf the library specified by library is not a published library.
vmware.vapi.std.errors.NotFoundIf the library specified by library does not exist.
vmware.vapi.std.errors.NotFoundIf the subscription specified by subscription does not exist for the library specified by library .
vmware.vapi.std.errors.UnauthenticatedIf the user that requested the method cannot be authenticated.
vmware.vapi.std.errors.UnauthorizedIf the user that requested the method is not authorized to perform the method.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • The resource com.vmware.content.Library referenced by the parameter library requires ContentLibrary.DeleteSubscription .
Parameters:
libraryIdentifier of the published library. The parameter must be an identifier for the resource type: com.vmware.content.Library .
subscriptionSubscription identifier. The parameter must be an identifier for the resource type: com.vmware.content.library.Subscriptions .

Implemented in vmware::content::library::SubscriptionsStub.

vmware.content.library.SubscriptionsTypes.Info vmware::content::library::Subscriptions::Get ( string  library,
string  subscription 
)

Returns information about the specified subscription of the published library.

This method was added in vSphere API 6.7.2.

Exceptions:
vmware.vapi.std.errors.ErrorIf the system reports an error while responding to the request.
vmware.vapi.std.errors.NotFoundIf the library specified by library does not exist.
vmware.vapi.std.errors.InvalidArgumentIf the subscription is not valid.
vmware.vapi.std.errors.InvalidElementTypeIf the library specified by library is a subscribed library.
vmware.vapi.std.errors.NotAllowedInCurrentStateIf the library specified by library is not a published library.
vmware.vapi.std.errors.UnauthenticatedIf the user that requested the method cannot be authenticated.
vmware.vapi.std.errors.UnauthorizedIf the user that requested the method is not authorized to perform the method.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • The resource com.vmware.content.Library referenced by the parameter library requires System.Read .
Parameters:
libraryIdentifier of the published library. The parameter must be an identifier for the resource type: com.vmware.content.Library .
subscriptionIdentifier of the subscription. The parameter must be an identifier for the resource type: com.vmware.content.library.Subscriptions .
Returns:
Information about the subscription.

Implemented in vmware::content::library::SubscriptionsStub.

vmware.content.library.SubscriptionsTypes.Info vmware::content::library::Subscriptions::Get ( string  library,
string  subscription,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Returns information about the specified subscription of the published library.

This method was added in vSphere API 6.7.2.

Exceptions:
vmware.vapi.std.errors.ErrorIf the system reports an error while responding to the request.
vmware.vapi.std.errors.NotFoundIf the library specified by library does not exist.
vmware.vapi.std.errors.InvalidArgumentIf the subscription is not valid.
vmware.vapi.std.errors.InvalidElementTypeIf the library specified by library is a subscribed library.
vmware.vapi.std.errors.NotAllowedInCurrentStateIf the library specified by library is not a published library.
vmware.vapi.std.errors.UnauthenticatedIf the user that requested the method cannot be authenticated.
vmware.vapi.std.errors.UnauthorizedIf the user that requested the method is not authorized to perform the method.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • The resource com.vmware.content.Library referenced by the parameter library requires System.Read .
Parameters:
libraryIdentifier of the published library. The parameter must be an identifier for the resource type: com.vmware.content.Library .
subscriptionIdentifier of the subscription. The parameter must be an identifier for the resource type: com.vmware.content.library.Subscriptions .
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation
Returns:
Information about the subscription.

Implemented in vmware::content::library::SubscriptionsStub.

global::System.Threading.Tasks.Task<vmware.content.library.SubscriptionsTypes.Info> vmware::content::library::Subscriptions::GetAsync ( string  library,
string  subscription 
)

Returns information about the specified subscription of the published library.

This method was added in vSphere API 6.7.2.

Exceptions:
vmware.vapi.std.errors.ErrorIf the system reports an error while responding to the request.
vmware.vapi.std.errors.NotFoundIf the library specified by library does not exist.
vmware.vapi.std.errors.InvalidArgumentIf the subscription is not valid.
vmware.vapi.std.errors.InvalidElementTypeIf the library specified by library is a subscribed library.
vmware.vapi.std.errors.NotAllowedInCurrentStateIf the library specified by library is not a published library.
vmware.vapi.std.errors.UnauthenticatedIf the user that requested the method cannot be authenticated.
vmware.vapi.std.errors.UnauthorizedIf the user that requested the method is not authorized to perform the method.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • The resource com.vmware.content.Library referenced by the parameter library requires System.Read .
Parameters:
libraryIdentifier of the published library. The parameter must be an identifier for the resource type: com.vmware.content.Library .
subscriptionIdentifier of the subscription. The parameter must be an identifier for the resource type: com.vmware.content.library.Subscriptions .
Returns:
Information about the subscription.

Implemented in vmware::content::library::SubscriptionsStub.

global::System.Threading.Tasks.Task<vmware.content.library.SubscriptionsTypes.Info> vmware::content::library::Subscriptions::GetAsync ( string  library,
string  subscription,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Returns information about the specified subscription of the published library.

This method was added in vSphere API 6.7.2.

Exceptions:
vmware.vapi.std.errors.ErrorIf the system reports an error while responding to the request.
vmware.vapi.std.errors.NotFoundIf the library specified by library does not exist.
vmware.vapi.std.errors.InvalidArgumentIf the subscription is not valid.
vmware.vapi.std.errors.InvalidElementTypeIf the library specified by library is a subscribed library.
vmware.vapi.std.errors.NotAllowedInCurrentStateIf the library specified by library is not a published library.
vmware.vapi.std.errors.UnauthenticatedIf the user that requested the method cannot be authenticated.
vmware.vapi.std.errors.UnauthorizedIf the user that requested the method is not authorized to perform the method.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • The resource com.vmware.content.Library referenced by the parameter library requires System.Read .
Parameters:
libraryIdentifier of the published library. The parameter must be an identifier for the resource type: com.vmware.content.Library .
subscriptionIdentifier of the subscription. The parameter must be an identifier for the resource type: com.vmware.content.library.Subscriptions .
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation
Returns:
Information about the subscription.

Implemented in vmware::content::library::SubscriptionsStub.

global::System.Collections.Generic.List<vmware.content.library.SubscriptionsTypes.Summary> vmware::content::library::Subscriptions::List ( string  library,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Lists the subscriptions of the published library.

This method was added in vSphere API 6.7.2.

Exceptions:
vmware.vapi.std.errors.ErrorIf the system reports an error while responding to the request.
vmware.vapi.std.errors.InvalidElementTypeIf the library specified by library is a subscribed library.
vmware.vapi.std.errors.NotFoundIf the library specified by library does not exist.
vmware.vapi.std.errors.NotAllowedInCurrentStateIf the library specified by library is not a published library.
vmware.vapi.std.errors.UnauthenticatedIf the user that requested the method cannot be authenticated.
vmware.vapi.std.errors.UnauthorizedIf the user that requested the method is not authorized to perform the method.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • The resource com.vmware.content.Library referenced by the parameter library requires System.Read .
Parameters:
libraryIdentifier of the published library. The parameter must be an identifier for the resource type: com.vmware.content.Library .
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation
Returns:
List of commonly used information about subscriptions of the published library.

Implemented in vmware::content::library::SubscriptionsStub.

global::System.Collections.Generic.List<vmware.content.library.SubscriptionsTypes.Summary> vmware::content::library::Subscriptions::List ( string  library)

Lists the subscriptions of the published library.

This method was added in vSphere API 6.7.2.

Exceptions:
vmware.vapi.std.errors.ErrorIf the system reports an error while responding to the request.
vmware.vapi.std.errors.InvalidElementTypeIf the library specified by library is a subscribed library.
vmware.vapi.std.errors.NotFoundIf the library specified by library does not exist.
vmware.vapi.std.errors.NotAllowedInCurrentStateIf the library specified by library is not a published library.
vmware.vapi.std.errors.UnauthenticatedIf the user that requested the method cannot be authenticated.
vmware.vapi.std.errors.UnauthorizedIf the user that requested the method is not authorized to perform the method.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • The resource com.vmware.content.Library referenced by the parameter library requires System.Read .
Parameters:
libraryIdentifier of the published library. The parameter must be an identifier for the resource type: com.vmware.content.Library .
Returns:
List of commonly used information about subscriptions of the published library.

Implemented in vmware::content::library::SubscriptionsStub.

global::System.Threading.Tasks.Task<global::System.Collections.Generic.List<vmware.content.library.SubscriptionsTypes.Summary> > vmware::content::library::Subscriptions::ListAsync ( string  library)

Lists the subscriptions of the published library.

This method was added in vSphere API 6.7.2.

Exceptions:
vmware.vapi.std.errors.ErrorIf the system reports an error while responding to the request.
vmware.vapi.std.errors.InvalidElementTypeIf the library specified by library is a subscribed library.
vmware.vapi.std.errors.NotFoundIf the library specified by library does not exist.
vmware.vapi.std.errors.NotAllowedInCurrentStateIf the library specified by library is not a published library.
vmware.vapi.std.errors.UnauthenticatedIf the user that requested the method cannot be authenticated.
vmware.vapi.std.errors.UnauthorizedIf the user that requested the method is not authorized to perform the method.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • The resource com.vmware.content.Library referenced by the parameter library requires System.Read .
Parameters:
libraryIdentifier of the published library. The parameter must be an identifier for the resource type: com.vmware.content.Library .
Returns:
List of commonly used information about subscriptions of the published library.

Implemented in vmware::content::library::SubscriptionsStub.

global::System.Threading.Tasks.Task<global::System.Collections.Generic.List<vmware.content.library.SubscriptionsTypes.Summary> > vmware::content::library::Subscriptions::ListAsync ( string  library,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Lists the subscriptions of the published library.

This method was added in vSphere API 6.7.2.

Exceptions:
vmware.vapi.std.errors.ErrorIf the system reports an error while responding to the request.
vmware.vapi.std.errors.InvalidElementTypeIf the library specified by library is a subscribed library.
vmware.vapi.std.errors.NotFoundIf the library specified by library does not exist.
vmware.vapi.std.errors.NotAllowedInCurrentStateIf the library specified by library is not a published library.
vmware.vapi.std.errors.UnauthenticatedIf the user that requested the method cannot be authenticated.
vmware.vapi.std.errors.UnauthorizedIf the user that requested the method is not authorized to perform the method.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • The resource com.vmware.content.Library referenced by the parameter library requires System.Read .
Parameters:
libraryIdentifier of the published library. The parameter must be an identifier for the resource type: com.vmware.content.Library .
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation
Returns:
List of commonly used information about subscriptions of the published library.

Implemented in vmware::content::library::SubscriptionsStub.

void vmware::content::library::Subscriptions::Update ( string  library,
string  subscription,
vmware.content.library.SubscriptionsTypes.UpdateSpec  spec,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Updates the specified subscription of the published library.

This is an incremental update to the subscription. Except for the Subscriptions.UpdateSpecPlacement class, fields that are null in the update specification will be left unchanged. If {@param.name spec#subscribedLibraryPlacement} is specified, all fields of the current subscribed library placement will be replaced by this placement.. This method was added in vSphere API 6.7.2.

Exceptions:
vmware.vapi.std.errors.ErrorIf the system reports an error while responding to the request.
vmware.vapi.std.errors.NotFoundIf the library specified by library does not exist.
vmware.vapi.std.errors.NotFoundIf the subscription specified by subscription does not exist for the library specified by library .
vmware.vapi.std.errors.ResourceInaccessibleIf the subscribed library cannot be contacted or found.
vmware.vapi.std.errors.InvalidArgumentIf Subscriptions.UpdateSpec contains invalid arguments.
vmware.vapi.std.errors.InvalidElementTypeIf the library specified by library is a subscribed library.
vmware.vapi.std.errors.NotAllowedInCurrentStateIf the library specified by library is not a published library.
vmware.vapi.std.errors.UnauthenticatedIf the user that requested the method cannot be authenticated.
vmware.vapi.std.errors.UnauthorizedIf the user that requested the method is not authorized to perform the method.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • The resource com.vmware.content.Library referenced by the parameter library requires ContentLibrary.UpdateSubscription .
Parameters:
libraryIdentifier of the published library. The parameter must be an identifier for the resource type: com.vmware.content.Library .
subscriptionsubscription identifier. The parameter must be an identifier for the resource type: com.vmware.content.library.Subscriptions .
specSpecification of the new property values to set on the subscription.
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation

Implemented in vmware::content::library::SubscriptionsStub.

void vmware::content::library::Subscriptions::Update ( string  library,
string  subscription,
vmware.content.library.SubscriptionsTypes.UpdateSpec  spec 
)

Updates the specified subscription of the published library.

This is an incremental update to the subscription. Except for the Subscriptions.UpdateSpecPlacement class, fields that are null in the update specification will be left unchanged. If {@param.name spec#subscribedLibraryPlacement} is specified, all fields of the current subscribed library placement will be replaced by this placement.. This method was added in vSphere API 6.7.2.

Exceptions:
vmware.vapi.std.errors.ErrorIf the system reports an error while responding to the request.
vmware.vapi.std.errors.NotFoundIf the library specified by library does not exist.
vmware.vapi.std.errors.NotFoundIf the subscription specified by subscription does not exist for the library specified by library .
vmware.vapi.std.errors.ResourceInaccessibleIf the subscribed library cannot be contacted or found.
vmware.vapi.std.errors.InvalidArgumentIf Subscriptions.UpdateSpec contains invalid arguments.
vmware.vapi.std.errors.InvalidElementTypeIf the library specified by library is a subscribed library.
vmware.vapi.std.errors.NotAllowedInCurrentStateIf the library specified by library is not a published library.
vmware.vapi.std.errors.UnauthenticatedIf the user that requested the method cannot be authenticated.
vmware.vapi.std.errors.UnauthorizedIf the user that requested the method is not authorized to perform the method.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • The resource com.vmware.content.Library referenced by the parameter library requires ContentLibrary.UpdateSubscription .
Parameters:
libraryIdentifier of the published library. The parameter must be an identifier for the resource type: com.vmware.content.Library .
subscriptionsubscription identifier. The parameter must be an identifier for the resource type: com.vmware.content.library.Subscriptions .
specSpecification of the new property values to set on the subscription.

Implemented in vmware::content::library::SubscriptionsStub.

global::System.Threading.Tasks.Task vmware::content::library::Subscriptions::UpdateAsync ( string  library,
string  subscription,
vmware.content.library.SubscriptionsTypes.UpdateSpec  spec,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Updates the specified subscription of the published library.

This is an incremental update to the subscription. Except for the Subscriptions.UpdateSpecPlacement class, fields that are null in the update specification will be left unchanged. If {@param.name spec#subscribedLibraryPlacement} is specified, all fields of the current subscribed library placement will be replaced by this placement.. This method was added in vSphere API 6.7.2.

Exceptions:
vmware.vapi.std.errors.ErrorIf the system reports an error while responding to the request.
vmware.vapi.std.errors.NotFoundIf the library specified by library does not exist.
vmware.vapi.std.errors.NotFoundIf the subscription specified by subscription does not exist for the library specified by library .
vmware.vapi.std.errors.ResourceInaccessibleIf the subscribed library cannot be contacted or found.
vmware.vapi.std.errors.InvalidArgumentIf Subscriptions.UpdateSpec contains invalid arguments.
vmware.vapi.std.errors.InvalidElementTypeIf the library specified by library is a subscribed library.
vmware.vapi.std.errors.NotAllowedInCurrentStateIf the library specified by library is not a published library.
vmware.vapi.std.errors.UnauthenticatedIf the user that requested the method cannot be authenticated.
vmware.vapi.std.errors.UnauthorizedIf the user that requested the method is not authorized to perform the method.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • The resource com.vmware.content.Library referenced by the parameter library requires ContentLibrary.UpdateSubscription .
Parameters:
libraryIdentifier of the published library. The parameter must be an identifier for the resource type: com.vmware.content.Library .
subscriptionsubscription identifier. The parameter must be an identifier for the resource type: com.vmware.content.library.Subscriptions .
specSpecification of the new property values to set on the subscription.
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation

Implemented in vmware::content::library::SubscriptionsStub.

global::System.Threading.Tasks.Task vmware::content::library::Subscriptions::UpdateAsync ( string  library,
string  subscription,
vmware.content.library.SubscriptionsTypes.UpdateSpec  spec 
)

Updates the specified subscription of the published library.

This is an incremental update to the subscription. Except for the Subscriptions.UpdateSpecPlacement class, fields that are null in the update specification will be left unchanged. If {@param.name spec#subscribedLibraryPlacement} is specified, all fields of the current subscribed library placement will be replaced by this placement.. This method was added in vSphere API 6.7.2.

Exceptions:
vmware.vapi.std.errors.ErrorIf the system reports an error while responding to the request.
vmware.vapi.std.errors.NotFoundIf the library specified by library does not exist.
vmware.vapi.std.errors.NotFoundIf the subscription specified by subscription does not exist for the library specified by library .
vmware.vapi.std.errors.ResourceInaccessibleIf the subscribed library cannot be contacted or found.
vmware.vapi.std.errors.InvalidArgumentIf Subscriptions.UpdateSpec contains invalid arguments.
vmware.vapi.std.errors.InvalidElementTypeIf the library specified by library is a subscribed library.
vmware.vapi.std.errors.NotAllowedInCurrentStateIf the library specified by library is not a published library.
vmware.vapi.std.errors.UnauthenticatedIf the user that requested the method cannot be authenticated.
vmware.vapi.std.errors.UnauthorizedIf the user that requested the method is not authorized to perform the method.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • The resource com.vmware.content.Library referenced by the parameter library requires ContentLibrary.UpdateSubscription .
Parameters:
libraryIdentifier of the published library. The parameter must be an identifier for the resource type: com.vmware.content.Library .
subscriptionsubscription identifier. The parameter must be an identifier for the resource type: com.vmware.content.library.Subscriptions .
specSpecification of the new property values to set on the subscription.

Implemented in vmware::content::library::SubscriptionsStub.


The documentation for this interface was generated from the following file: