VMware vSphere Automation SDK for .NET 7.0.0.1
vmware::vcenter::identity::Providers Interface Reference

The Providers interface provides methods to list, read and modify vCenter Server identity providers. More...

Inherited by vmware::vcenter::identity::ProvidersStub.

List of all members.

Public Member Functions

global::System.Collections.Generic.List
< vmware.vcenter.identity.ProvidersTypes.Summary
List ()
 Retrieve all identity providers.
global::System.Collections.Generic.List
< vmware.vcenter.identity.ProvidersTypes.Summary
List (global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Retrieve all identity providers.
global::System.Threading.Tasks.Task
< global::System.Collections.Generic.List
< vmware.vcenter.identity.ProvidersTypes.Summary > > 
ListAsync ()
 Retrieve all identity providers.
global::System.Threading.Tasks.Task
< global::System.Collections.Generic.List
< vmware.vcenter.identity.ProvidersTypes.Summary > > 
ListAsync (global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Retrieve all identity providers.
vmware.vcenter.identity.ProvidersTypes.Info Get (string provider)
 Retrieve detailed information of the specified identity provider.
vmware.vcenter.identity.ProvidersTypes.Info Get (string provider, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Retrieve detailed information of the specified identity provider.
global::System.Threading.Tasks.Task
< vmware.vcenter.identity.ProvidersTypes.Info
GetAsync (string provider)
 Retrieve detailed information of the specified identity provider.
global::System.Threading.Tasks.Task
< vmware.vcenter.identity.ProvidersTypes.Info
GetAsync (string provider, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Retrieve detailed information of the specified identity provider.
string Create (vmware.vcenter.identity.ProvidersTypes.CreateSpec spec)
 Create a vCenter Server identity provider.
string Create (vmware.vcenter.identity.ProvidersTypes.CreateSpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Create a vCenter Server identity provider.
global::System.Threading.Tasks.Task
< string > 
CreateAsync (vmware.vcenter.identity.ProvidersTypes.CreateSpec spec)
 Create a vCenter Server identity provider.
global::System.Threading.Tasks.Task
< string > 
CreateAsync (vmware.vcenter.identity.ProvidersTypes.CreateSpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Create a vCenter Server identity provider.
void Update (string provider, vmware.vcenter.identity.ProvidersTypes.UpdateSpec spec)
 Update a vCenter Server identity provider.
void Update (string provider, vmware.vcenter.identity.ProvidersTypes.UpdateSpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Update a vCenter Server identity provider.
global::System.Threading.Tasks.Task UpdateAsync (string provider, vmware.vcenter.identity.ProvidersTypes.UpdateSpec spec)
 Update a vCenter Server identity provider.
global::System.Threading.Tasks.Task UpdateAsync (string provider, vmware.vcenter.identity.ProvidersTypes.UpdateSpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Update a vCenter Server identity provider.
void Delete (string provider)
 Delete a vCenter Server identity provider.
void Delete (string provider, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Delete a vCenter Server identity provider.
global::System.Threading.Tasks.Task DeleteAsync (string provider)
 Delete a vCenter Server identity provider.
global::System.Threading.Tasks.Task DeleteAsync (string provider, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Delete a vCenter Server identity provider.

Detailed Description

The Providers interface provides methods to list, read and modify vCenter Server identity providers.

This interface was added in vSphere API 7.0.0.


Member Function Documentation

string vmware::vcenter::identity::Providers::Create ( vmware.vcenter.identity.ProvidersTypes.CreateSpec  spec)

Create a vCenter Server identity provider.

This method was added in vSphere API 7.0.0.

Exceptions:
vmware.vapi.std.errors.Unauthorizedif authorization is not given to caller.
vmware.vapi.std.errors.InvalidArgumentif invalid arguments are provided in createSpec.
Parameters:
specthe CreateSpec contains the information used to create the provider
Returns:
The identifier of the created identity provider. The result will be an identifier for the resource type: com.vmware.vcenter.identity.Providers .

Implemented in vmware::vcenter::identity::ProvidersStub.

string vmware::vcenter::identity::Providers::Create ( vmware.vcenter.identity.ProvidersTypes.CreateSpec  spec,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Create a vCenter Server identity provider.

This method was added in vSphere API 7.0.0.

Exceptions:
vmware.vapi.std.errors.Unauthorizedif authorization is not given to caller.
vmware.vapi.std.errors.InvalidArgumentif invalid arguments are provided in createSpec.
Parameters:
specthe CreateSpec contains the information used to create the provider
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation
Returns:
The identifier of the created identity provider. The result will be an identifier for the resource type: com.vmware.vcenter.identity.Providers .

Implemented in vmware::vcenter::identity::ProvidersStub.

global::System.Threading.Tasks.Task<string> vmware::vcenter::identity::Providers::CreateAsync ( vmware.vcenter.identity.ProvidersTypes.CreateSpec  spec)

Create a vCenter Server identity provider.

This method was added in vSphere API 7.0.0.

Exceptions:
vmware.vapi.std.errors.Unauthorizedif authorization is not given to caller.
vmware.vapi.std.errors.InvalidArgumentif invalid arguments are provided in createSpec.
Parameters:
specthe CreateSpec contains the information used to create the provider
Returns:
The identifier of the created identity provider. The result will be an identifier for the resource type: com.vmware.vcenter.identity.Providers .

Implemented in vmware::vcenter::identity::ProvidersStub.

global::System.Threading.Tasks.Task<string> vmware::vcenter::identity::Providers::CreateAsync ( vmware.vcenter.identity.ProvidersTypes.CreateSpec  spec,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Create a vCenter Server identity provider.

This method was added in vSphere API 7.0.0.

Exceptions:
vmware.vapi.std.errors.Unauthorizedif authorization is not given to caller.
vmware.vapi.std.errors.InvalidArgumentif invalid arguments are provided in createSpec.
Parameters:
specthe CreateSpec contains the information used to create the provider
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation
Returns:
The identifier of the created identity provider. The result will be an identifier for the resource type: com.vmware.vcenter.identity.Providers .

Implemented in vmware::vcenter::identity::ProvidersStub.

void vmware::vcenter::identity::Providers::Delete ( string  provider)

Delete a vCenter Server identity provider.

This method was added in vSphere API 7.0.0.

Exceptions:
vmware.vapi.std.errors.Unauthorizedif authorization is not given to caller.
vmware.vapi.std.errors.NotFoundif no provider found with the given provider identifier.
Parameters:
providerthe identifier of the provider to delete The parameter must be an identifier for the resource type: com.vmware.vcenter.identity.Providers .

Implemented in vmware::vcenter::identity::ProvidersStub.

void vmware::vcenter::identity::Providers::Delete ( string  provider,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Delete a vCenter Server identity provider.

This method was added in vSphere API 7.0.0.

Exceptions:
vmware.vapi.std.errors.Unauthorizedif authorization is not given to caller.
vmware.vapi.std.errors.NotFoundif no provider found with the given provider identifier.
Parameters:
providerthe identifier of the provider to delete The parameter must be an identifier for the resource type: com.vmware.vcenter.identity.Providers .
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation

Implemented in vmware::vcenter::identity::ProvidersStub.

global::System.Threading.Tasks.Task vmware::vcenter::identity::Providers::DeleteAsync ( string  provider)

Delete a vCenter Server identity provider.

This method was added in vSphere API 7.0.0.

Exceptions:
vmware.vapi.std.errors.Unauthorizedif authorization is not given to caller.
vmware.vapi.std.errors.NotFoundif no provider found with the given provider identifier.
Parameters:
providerthe identifier of the provider to delete The parameter must be an identifier for the resource type: com.vmware.vcenter.identity.Providers .

Implemented in vmware::vcenter::identity::ProvidersStub.

global::System.Threading.Tasks.Task vmware::vcenter::identity::Providers::DeleteAsync ( string  provider,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Delete a vCenter Server identity provider.

This method was added in vSphere API 7.0.0.

Exceptions:
vmware.vapi.std.errors.Unauthorizedif authorization is not given to caller.
vmware.vapi.std.errors.NotFoundif no provider found with the given provider identifier.
Parameters:
providerthe identifier of the provider to delete The parameter must be an identifier for the resource type: com.vmware.vcenter.identity.Providers .
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation

Implemented in vmware::vcenter::identity::ProvidersStub.

vmware.vcenter.identity.ProvidersTypes.Info vmware::vcenter::identity::Providers::Get ( string  provider)

Retrieve detailed information of the specified identity provider.

This method was added in vSphere API 7.0.0.

Exceptions:
vmware.vapi.std.errors.Unauthorizedif authorization is not given to caller.
vmware.vapi.std.errors.NotFoundif no provider found with the given provider identifier.
Parameters:
providerthe identifier of the provider The parameter must be an identifier for the resource type: com.vmware.vcenter.identity.Providers .
Returns:
Detailed information of the specified identity provider.

Implemented in vmware::vcenter::identity::ProvidersStub.

vmware.vcenter.identity.ProvidersTypes.Info vmware::vcenter::identity::Providers::Get ( string  provider,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Retrieve detailed information of the specified identity provider.

This method was added in vSphere API 7.0.0.

Exceptions:
vmware.vapi.std.errors.Unauthorizedif authorization is not given to caller.
vmware.vapi.std.errors.NotFoundif no provider found with the given provider identifier.
Parameters:
providerthe identifier of the provider The parameter must be an identifier for the resource type: com.vmware.vcenter.identity.Providers .
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation
Returns:
Detailed information of the specified identity provider.

Implemented in vmware::vcenter::identity::ProvidersStub.

global::System.Threading.Tasks.Task<vmware.vcenter.identity.ProvidersTypes.Info> vmware::vcenter::identity::Providers::GetAsync ( string  provider,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Retrieve detailed information of the specified identity provider.

This method was added in vSphere API 7.0.0.

Exceptions:
vmware.vapi.std.errors.Unauthorizedif authorization is not given to caller.
vmware.vapi.std.errors.NotFoundif no provider found with the given provider identifier.
Parameters:
providerthe identifier of the provider The parameter must be an identifier for the resource type: com.vmware.vcenter.identity.Providers .
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation
Returns:
Detailed information of the specified identity provider.

Implemented in vmware::vcenter::identity::ProvidersStub.

global::System.Threading.Tasks.Task<vmware.vcenter.identity.ProvidersTypes.Info> vmware::vcenter::identity::Providers::GetAsync ( string  provider)

Retrieve detailed information of the specified identity provider.

This method was added in vSphere API 7.0.0.

Exceptions:
vmware.vapi.std.errors.Unauthorizedif authorization is not given to caller.
vmware.vapi.std.errors.NotFoundif no provider found with the given provider identifier.
Parameters:
providerthe identifier of the provider The parameter must be an identifier for the resource type: com.vmware.vcenter.identity.Providers .
Returns:
Detailed information of the specified identity provider.

Implemented in vmware::vcenter::identity::ProvidersStub.

global::System.Collections.Generic.List<vmware.vcenter.identity.ProvidersTypes.Summary> vmware::vcenter::identity::Providers::List ( global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Retrieve all identity providers.

This method was added in vSphere API 7.0.0.

Exceptions:
vmware.vapi.std.errors.Unauthorizedif authorization is not given to caller.
Returns:
Commonly used information about the identity providers.

Implemented in vmware::vcenter::identity::ProvidersStub.

global::System.Collections.Generic.List<vmware.vcenter.identity.ProvidersTypes.Summary> vmware::vcenter::identity::Providers::List ( )

Retrieve all identity providers.

This method was added in vSphere API 7.0.0.

Exceptions:
vmware.vapi.std.errors.Unauthorizedif authorization is not given to caller.
Returns:
Commonly used information about the identity providers.

Implemented in vmware::vcenter::identity::ProvidersStub.

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

Retrieve all identity providers.

This method was added in vSphere API 7.0.0.

Exceptions:
vmware.vapi.std.errors.Unauthorizedif authorization is not given to caller.
Returns:
Commonly used information about the identity providers.

Implemented in vmware::vcenter::identity::ProvidersStub.

global::System.Threading.Tasks.Task<global::System.Collections.Generic.List<vmware.vcenter.identity.ProvidersTypes.Summary> > vmware::vcenter::identity::Providers::ListAsync ( )

Retrieve all identity providers.

This method was added in vSphere API 7.0.0.

Exceptions:
vmware.vapi.std.errors.Unauthorizedif authorization is not given to caller.
Returns:
Commonly used information about the identity providers.

Implemented in vmware::vcenter::identity::ProvidersStub.

void vmware::vcenter::identity::Providers::Update ( string  provider,
vmware.vcenter.identity.ProvidersTypes.UpdateSpec  spec,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Update a vCenter Server identity provider.

This method was added in vSphere API 7.0.0.

Exceptions:
vmware.vapi.std.errors.Unauthorizedif authorization is not given to caller.
vmware.vapi.std.errors.InvalidArgumentif invalid arguments are provided in updateSpec.
vmware.vapi.std.errors.NotFoundif no provider found with the given provider identifier.
Parameters:
providerthe identifier of the provider to update The parameter must be an identifier for the resource type: com.vmware.vcenter.identity.Providers .
specthe UpdateSpec contains the information used to update the provider
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation

Implemented in vmware::vcenter::identity::ProvidersStub.

void vmware::vcenter::identity::Providers::Update ( string  provider,
vmware.vcenter.identity.ProvidersTypes.UpdateSpec  spec 
)

Update a vCenter Server identity provider.

This method was added in vSphere API 7.0.0.

Exceptions:
vmware.vapi.std.errors.Unauthorizedif authorization is not given to caller.
vmware.vapi.std.errors.InvalidArgumentif invalid arguments are provided in updateSpec.
vmware.vapi.std.errors.NotFoundif no provider found with the given provider identifier.
Parameters:
providerthe identifier of the provider to update The parameter must be an identifier for the resource type: com.vmware.vcenter.identity.Providers .
specthe UpdateSpec contains the information used to update the provider

Implemented in vmware::vcenter::identity::ProvidersStub.

global::System.Threading.Tasks.Task vmware::vcenter::identity::Providers::UpdateAsync ( string  provider,
vmware.vcenter.identity.ProvidersTypes.UpdateSpec  spec 
)

Update a vCenter Server identity provider.

This method was added in vSphere API 7.0.0.

Exceptions:
vmware.vapi.std.errors.Unauthorizedif authorization is not given to caller.
vmware.vapi.std.errors.InvalidArgumentif invalid arguments are provided in updateSpec.
vmware.vapi.std.errors.NotFoundif no provider found with the given provider identifier.
Parameters:
providerthe identifier of the provider to update The parameter must be an identifier for the resource type: com.vmware.vcenter.identity.Providers .
specthe UpdateSpec contains the information used to update the provider

Implemented in vmware::vcenter::identity::ProvidersStub.

global::System.Threading.Tasks.Task vmware::vcenter::identity::Providers::UpdateAsync ( string  provider,
vmware.vcenter.identity.ProvidersTypes.UpdateSpec  spec,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Update a vCenter Server identity provider.

This method was added in vSphere API 7.0.0.

Exceptions:
vmware.vapi.std.errors.Unauthorizedif authorization is not given to caller.
vmware.vapi.std.errors.InvalidArgumentif invalid arguments are provided in updateSpec.
vmware.vapi.std.errors.NotFoundif no provider found with the given provider identifier.
Parameters:
providerthe identifier of the provider to update The parameter must be an identifier for the resource type: com.vmware.vcenter.identity.Providers .
specthe UpdateSpec contains the information used to update the provider
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation

Implemented in vmware::vcenter::identity::ProvidersStub.


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