VMware vSphere Automation SDK for .NET 7.0.0.1
vmware::vcenter::content::registries::Harbor Interface Reference

The Harbor interface provides methods to manage the lifecycle of an integrated Harbor container registry in vCenter. More...

Inherited by vmware::vcenter::content::registries::HarborStub.

List of all members.

Public Member Functions

string Create (string clientToken, vmware.vcenter.content.registries.HarborTypes.CreateSpec spec)
 Creates a Harbor registry in the cluster.
string Create (string clientToken, vmware.vcenter.content.registries.HarborTypes.CreateSpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Creates a Harbor registry in the cluster.
global::System.Threading.Tasks.Task
< string > 
CreateAsync (string clientToken, vmware.vcenter.content.registries.HarborTypes.CreateSpec spec)
 Creates a Harbor registry in the cluster.
global::System.Threading.Tasks.Task
< string > 
CreateAsync (string clientToken, vmware.vcenter.content.registries.HarborTypes.CreateSpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Creates a Harbor registry in the cluster.
void Delete (string registry)
 Delete the Harbor registry in the cluster.
void Delete (string registry, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Delete the Harbor registry in the cluster.
global::System.Threading.Tasks.Task DeleteAsync (string registry)
 Delete the Harbor registry in the cluster.
global::System.Threading.Tasks.Task DeleteAsync (string registry, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Delete the Harbor registry in the cluster.
vmware.vcenter.content.registries.HarborTypes.Info Get (string registry)
 Get detailed information of the Harbor registry.
vmware.vcenter.content.registries.HarborTypes.Info Get (string registry, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Get detailed information of the Harbor registry.
global::System.Threading.Tasks.Task
< vmware.vcenter.content.registries.HarborTypes.Info
GetAsync (string registry)
 Get detailed information of the Harbor registry.
global::System.Threading.Tasks.Task
< vmware.vcenter.content.registries.HarborTypes.Info
GetAsync (string registry, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Get detailed information of the Harbor registry.
global::System.Collections.Generic.List
< vmware.vcenter.content.registries.HarborTypes.Summary
List ()
 Returns basic information of all Harbor registries.
global::System.Collections.Generic.List
< vmware.vcenter.content.registries.HarborTypes.Summary
List (global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Returns basic information of all Harbor registries.
global::System.Threading.Tasks.Task
< global::System.Collections.Generic.List
< vmware.vcenter.content.registries.HarborTypes.Summary > > 
ListAsync ()
 Returns basic information of all Harbor registries.
global::System.Threading.Tasks.Task
< global::System.Collections.Generic.List
< vmware.vcenter.content.registries.HarborTypes.Summary > > 
ListAsync (global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Returns basic information of all Harbor registries.

Detailed Description

The Harbor interface provides methods to manage the lifecycle of an integrated Harbor container registry in vCenter.


Member Function Documentation

string vmware::vcenter::content::registries::Harbor::Create ( string  clientToken,
vmware.vcenter.content.registries.HarborTypes.CreateSpec  spec 
)

Creates a Harbor registry in the cluster.

Exceptions:
vmware.vapi.std.errors.AlreadyExistsif a Harbor already exists in the associated cluster.
vmware.vapi.std.errors.NotFoundif resources/objects could not be located.
vmware.vapi.std.errors.Unsupportedif Harbor.CreateSpec.cluster does not have vSphere namespace enabled.
vmware.vapi.std.errors.InvalidArgumentif spec contains any errors.
vmware.vapi.std.errors.Errorif the system reports an error while responding to the request.
vmware.vapi.std.errors.Unauthenticatedif the user can not be authenticated.
vmware.vapi.std.errors.Unauthorizedif the user does not have ContentLibrary.ManageRegistry and/or CertificateAuthority.Manage privilege, or user does not have ContentLibrary.ManageClusterRegistryResource privilege on Harbor.CreateSpec.cluster .
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.
specSpecification for creating the Harbor registry.
Returns:
Identifier of the deployed registry. The result will be an identifier for the resource type: com.vmware.vcenter.content.Registry .

Implemented in vmware::vcenter::content::registries::HarborStub.

string vmware::vcenter::content::registries::Harbor::Create ( string  clientToken,
vmware.vcenter.content.registries.HarborTypes.CreateSpec  spec,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Creates a Harbor registry in the cluster.

Exceptions:
vmware.vapi.std.errors.AlreadyExistsif a Harbor already exists in the associated cluster.
vmware.vapi.std.errors.NotFoundif resources/objects could not be located.
vmware.vapi.std.errors.Unsupportedif Harbor.CreateSpec.cluster does not have vSphere namespace enabled.
vmware.vapi.std.errors.InvalidArgumentif spec contains any errors.
vmware.vapi.std.errors.Errorif the system reports an error while responding to the request.
vmware.vapi.std.errors.Unauthenticatedif the user can not be authenticated.
vmware.vapi.std.errors.Unauthorizedif the user does not have ContentLibrary.ManageRegistry and/or CertificateAuthority.Manage privilege, or user does not have ContentLibrary.ManageClusterRegistryResource privilege on Harbor.CreateSpec.cluster .
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.
specSpecification for creating the Harbor registry.
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation
Returns:
Identifier of the deployed registry. The result will be an identifier for the resource type: com.vmware.vcenter.content.Registry .

Implemented in vmware::vcenter::content::registries::HarborStub.

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

Creates a Harbor registry in the cluster.

Exceptions:
vmware.vapi.std.errors.AlreadyExistsif a Harbor already exists in the associated cluster.
vmware.vapi.std.errors.NotFoundif resources/objects could not be located.
vmware.vapi.std.errors.Unsupportedif Harbor.CreateSpec.cluster does not have vSphere namespace enabled.
vmware.vapi.std.errors.InvalidArgumentif spec contains any errors.
vmware.vapi.std.errors.Errorif the system reports an error while responding to the request.
vmware.vapi.std.errors.Unauthenticatedif the user can not be authenticated.
vmware.vapi.std.errors.Unauthorizedif the user does not have ContentLibrary.ManageRegistry and/or CertificateAuthority.Manage privilege, or user does not have ContentLibrary.ManageClusterRegistryResource privilege on Harbor.CreateSpec.cluster .
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.
specSpecification for creating the Harbor registry.
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation
Returns:
Identifier of the deployed registry. The result will be an identifier for the resource type: com.vmware.vcenter.content.Registry .

Implemented in vmware::vcenter::content::registries::HarborStub.

global::System.Threading.Tasks.Task<string> vmware::vcenter::content::registries::Harbor::CreateAsync ( string  clientToken,
vmware.vcenter.content.registries.HarborTypes.CreateSpec  spec 
)

Creates a Harbor registry in the cluster.

Exceptions:
vmware.vapi.std.errors.AlreadyExistsif a Harbor already exists in the associated cluster.
vmware.vapi.std.errors.NotFoundif resources/objects could not be located.
vmware.vapi.std.errors.Unsupportedif Harbor.CreateSpec.cluster does not have vSphere namespace enabled.
vmware.vapi.std.errors.InvalidArgumentif spec contains any errors.
vmware.vapi.std.errors.Errorif the system reports an error while responding to the request.
vmware.vapi.std.errors.Unauthenticatedif the user can not be authenticated.
vmware.vapi.std.errors.Unauthorizedif the user does not have ContentLibrary.ManageRegistry and/or CertificateAuthority.Manage privilege, or user does not have ContentLibrary.ManageClusterRegistryResource privilege on Harbor.CreateSpec.cluster .
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.
specSpecification for creating the Harbor registry.
Returns:
Identifier of the deployed registry. The result will be an identifier for the resource type: com.vmware.vcenter.content.Registry .

Implemented in vmware::vcenter::content::registries::HarborStub.

void vmware::vcenter::content::registries::Harbor::Delete ( string  registry)

Delete the Harbor registry in the cluster.

All Harbor projects, repositories and images will be deleted upon Harbor registry deletion.

Exceptions:
vmware.vapi.std.errors.NotFoundif a registry specified by registry could not be found.
vmware.vapi.std.errors.Errorif the system reports an error while responding to the request.
vmware.vapi.std.errors.Unauthenticatedif the user can not be authenticated.
vmware.vapi.std.errors.Unauthorizedif the user does not have ContentLibrary.ManageRegistry privilege.
Parameters:
registryIdentifier of the registry. The parameter must be an identifier for the resource type: com.vmware.vcenter.content.Registry .

Implemented in vmware::vcenter::content::registries::HarborStub.

void vmware::vcenter::content::registries::Harbor::Delete ( string  registry,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Delete the Harbor registry in the cluster.

All Harbor projects, repositories and images will be deleted upon Harbor registry deletion.

Exceptions:
vmware.vapi.std.errors.NotFoundif a registry specified by registry could not be found.
vmware.vapi.std.errors.Errorif the system reports an error while responding to the request.
vmware.vapi.std.errors.Unauthenticatedif the user can not be authenticated.
vmware.vapi.std.errors.Unauthorizedif the user does not have ContentLibrary.ManageRegistry privilege.
Parameters:
registryIdentifier of the registry. The parameter must be an identifier for the resource type: com.vmware.vcenter.content.Registry .
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation

Implemented in vmware::vcenter::content::registries::HarborStub.

global::System.Threading.Tasks.Task vmware::vcenter::content::registries::Harbor::DeleteAsync ( string  registry,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Delete the Harbor registry in the cluster.

All Harbor projects, repositories and images will be deleted upon Harbor registry deletion.

Exceptions:
vmware.vapi.std.errors.NotFoundif a registry specified by registry could not be found.
vmware.vapi.std.errors.Errorif the system reports an error while responding to the request.
vmware.vapi.std.errors.Unauthenticatedif the user can not be authenticated.
vmware.vapi.std.errors.Unauthorizedif the user does not have ContentLibrary.ManageRegistry privilege.
Parameters:
registryIdentifier of the registry. The parameter must be an identifier for the resource type: com.vmware.vcenter.content.Registry .
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation

Implemented in vmware::vcenter::content::registries::HarborStub.

global::System.Threading.Tasks.Task vmware::vcenter::content::registries::Harbor::DeleteAsync ( string  registry)

Delete the Harbor registry in the cluster.

All Harbor projects, repositories and images will be deleted upon Harbor registry deletion.

Exceptions:
vmware.vapi.std.errors.NotFoundif a registry specified by registry could not be found.
vmware.vapi.std.errors.Errorif the system reports an error while responding to the request.
vmware.vapi.std.errors.Unauthenticatedif the user can not be authenticated.
vmware.vapi.std.errors.Unauthorizedif the user does not have ContentLibrary.ManageRegistry privilege.
Parameters:
registryIdentifier of the registry. The parameter must be an identifier for the resource type: com.vmware.vcenter.content.Registry .

Implemented in vmware::vcenter::content::registries::HarborStub.

vmware.vcenter.content.registries.HarborTypes.Info vmware::vcenter::content::registries::Harbor::Get ( string  registry)

Get detailed information of the Harbor registry.

Exceptions:
vmware.vapi.std.errors.NotFoundif a Harbor registry specified by registry could not be found.
vmware.vapi.std.errors.Errorif the system reports an error while responding to the request.
vmware.vapi.std.errors.Unauthenticatedif the user can not be authenticated.
vmware.vapi.std.errors.Unauthorizedif the user does not have System.Read privilege.
Parameters:
registryIdentifier of the registry. The parameter must be an identifier for the resource type: com.vmware.vcenter.content.Registry .
Returns:
Information about the registry.

Implemented in vmware::vcenter::content::registries::HarborStub.

vmware.vcenter.content.registries.HarborTypes.Info vmware::vcenter::content::registries::Harbor::Get ( string  registry,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Get detailed information of the Harbor registry.

Exceptions:
vmware.vapi.std.errors.NotFoundif a Harbor registry specified by registry could not be found.
vmware.vapi.std.errors.Errorif the system reports an error while responding to the request.
vmware.vapi.std.errors.Unauthenticatedif the user can not be authenticated.
vmware.vapi.std.errors.Unauthorizedif the user does not have System.Read privilege.
Parameters:
registryIdentifier of the registry. The parameter must be an identifier for the resource type: com.vmware.vcenter.content.Registry .
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation
Returns:
Information about the registry.

Implemented in vmware::vcenter::content::registries::HarborStub.

global::System.Threading.Tasks.Task<vmware.vcenter.content.registries.HarborTypes.Info> vmware::vcenter::content::registries::Harbor::GetAsync ( string  registry)

Get detailed information of the Harbor registry.

Exceptions:
vmware.vapi.std.errors.NotFoundif a Harbor registry specified by registry could not be found.
vmware.vapi.std.errors.Errorif the system reports an error while responding to the request.
vmware.vapi.std.errors.Unauthenticatedif the user can not be authenticated.
vmware.vapi.std.errors.Unauthorizedif the user does not have System.Read privilege.
Parameters:
registryIdentifier of the registry. The parameter must be an identifier for the resource type: com.vmware.vcenter.content.Registry .
Returns:
Information about the registry.

Implemented in vmware::vcenter::content::registries::HarborStub.

global::System.Threading.Tasks.Task<vmware.vcenter.content.registries.HarborTypes.Info> vmware::vcenter::content::registries::Harbor::GetAsync ( string  registry,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Get detailed information of the Harbor registry.

Exceptions:
vmware.vapi.std.errors.NotFoundif a Harbor registry specified by registry could not be found.
vmware.vapi.std.errors.Errorif the system reports an error while responding to the request.
vmware.vapi.std.errors.Unauthenticatedif the user can not be authenticated.
vmware.vapi.std.errors.Unauthorizedif the user does not have System.Read privilege.
Parameters:
registryIdentifier of the registry. The parameter must be an identifier for the resource type: com.vmware.vcenter.content.Registry .
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation
Returns:
Information about the registry.

Implemented in vmware::vcenter::content::registries::HarborStub.

global::System.Collections.Generic.List<vmware.vcenter.content.registries.HarborTypes.Summary> vmware::vcenter::content::registries::Harbor::List ( )

Returns basic information of all Harbor registries.

Exceptions:
vmware.vapi.std.errors.Errorif the system reports an error while responding to the request.
vmware.vapi.std.errors.Unauthenticatedif the user can not be authenticated.
vmware.vapi.std.errors.Unauthorizedif the user does not have System.Read privilege.
Returns:
The list of basic information of all Harbor registries.

Implemented in vmware::vcenter::content::registries::HarborStub.

global::System.Collections.Generic.List<vmware.vcenter.content.registries.HarborTypes.Summary> vmware::vcenter::content::registries::Harbor::List ( global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Returns basic information of all Harbor registries.

Exceptions:
vmware.vapi.std.errors.Errorif the system reports an error while responding to the request.
vmware.vapi.std.errors.Unauthenticatedif the user can not be authenticated.
vmware.vapi.std.errors.Unauthorizedif the user does not have System.Read privilege.
Returns:
The list of basic information of all Harbor registries.

Implemented in vmware::vcenter::content::registries::HarborStub.

global::System.Threading.Tasks.Task<global::System.Collections.Generic.List<vmware.vcenter.content.registries.HarborTypes.Summary> > vmware::vcenter::content::registries::Harbor::ListAsync ( )

Returns basic information of all Harbor registries.

Exceptions:
vmware.vapi.std.errors.Errorif the system reports an error while responding to the request.
vmware.vapi.std.errors.Unauthenticatedif the user can not be authenticated.
vmware.vapi.std.errors.Unauthorizedif the user does not have System.Read privilege.
Returns:
The list of basic information of all Harbor registries.

Implemented in vmware::vcenter::content::registries::HarborStub.

global::System.Threading.Tasks.Task<global::System.Collections.Generic.List<vmware.vcenter.content.registries.HarborTypes.Summary> > vmware::vcenter::content::registries::Harbor::ListAsync ( global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Returns basic information of all Harbor registries.

Exceptions:
vmware.vapi.std.errors.Errorif the system reports an error while responding to the request.
vmware.vapi.std.errors.Unauthenticatedif the user can not be authenticated.
vmware.vapi.std.errors.Unauthorizedif the user does not have System.Read privilege.
Returns:
The list of basic information of all Harbor registries.

Implemented in vmware::vcenter::content::registries::HarborStub.


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