VMware vSphere Automation SDK for .NET 7.0.0.1
vmware::vcenter::compute::Policies Interface Reference

The Policies interface provides methods to manage compute policies in VMware Cloud on AWS. More...

Inherited by vmware::vcenter::compute::PoliciesStub.

List of all members.

Public Member Functions

string Create (vmware.vapi.bindings.IStructure spec)
 Creates a new compute policy in VMware Cloud on AWS.
string Create (vmware.vapi.bindings.IStructure spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Creates a new compute policy in VMware Cloud on AWS.
global::System.Threading.Tasks.Task
< string > 
CreateAsync (vmware.vapi.bindings.IStructure spec)
 Creates a new compute policy in VMware Cloud on AWS.
global::System.Threading.Tasks.Task
< string > 
CreateAsync (vmware.vapi.bindings.IStructure spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Creates a new compute policy in VMware Cloud on AWS.
global::System.Collections.Generic.List
< vmware.vcenter.compute.PoliciesTypes.Summary
List ()
 Returns information about the compute policies available in this vCenter server in VMware Cloud on AWS.
global::System.Collections.Generic.List
< vmware.vcenter.compute.PoliciesTypes.Summary
List (global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Returns information about the compute policies available in this vCenter server in VMware Cloud on AWS.
global::System.Threading.Tasks.Task
< global::System.Collections.Generic.List
< vmware.vcenter.compute.PoliciesTypes.Summary > > 
ListAsync ()
 Returns information about the compute policies available in this vCenter server in VMware Cloud on AWS.
global::System.Threading.Tasks.Task
< global::System.Collections.Generic.List
< vmware.vcenter.compute.PoliciesTypes.Summary > > 
ListAsync (global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Returns information about the compute policies available in this vCenter server in VMware Cloud on AWS.
vmware.vapi.bindings.IStructure Get (string policy)
 Returns information about a specific compute policy in VMware Cloud on AWS.
vmware.vapi.bindings.IStructure Get (string policy, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Returns information about a specific compute policy in VMware Cloud on AWS.
global::System.Threading.Tasks.Task
< vmware.vapi.bindings.IStructure > 
GetAsync (string policy)
 Returns information about a specific compute policy in VMware Cloud on AWS.
global::System.Threading.Tasks.Task
< vmware.vapi.bindings.IStructure > 
GetAsync (string policy, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Returns information about a specific compute policy in VMware Cloud on AWS.
void Delete (string policy)
 Deletes a specific compute policy in VMware Cloud on AWS.
void Delete (string policy, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Deletes a specific compute policy in VMware Cloud on AWS.
global::System.Threading.Tasks.Task DeleteAsync (string policy)
 Deletes a specific compute policy in VMware Cloud on AWS.
global::System.Threading.Tasks.Task DeleteAsync (string policy, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Deletes a specific compute policy in VMware Cloud on AWS.

Detailed Description

The Policies interface provides methods to manage compute policies in VMware Cloud on AWS.

Usage beyond VMware Cloud on AWS is not supported. A compute policy defines the intended behavior for a collection of vSphere objects identified by a tag. A compute policy is an instance of a capability. It is created by providing a value for the creation type specified by the capability. See policies.Capabilities.Info.createSpecType . Warning: This interface is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.


Member Function Documentation

string vmware::vcenter::compute::Policies::Create ( vmware.vapi.bindings.IStructure  spec)

Creates a new compute policy in VMware Cloud on AWS.

Usage beyond VMware Cloud on AWS is not supported. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Exceptions:
vmware.vapi.std.errors.AlreadyExistsif a policy with the same name is already present on this vCenter server.
vmware.vapi.std.errors.InvalidArgumentif a parameter passed in the spec is invalid.
vmware.vapi.std.errors.UnableToAllocateResourceif more than 100 policies are created.
vmware.vapi.std.errors.Unauthorizedif the user doesn't have the required privileges.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • Method execution requires ComputePolicy.Manage .
Parameters:
specSpecification for the new policy to be created. The new policy will be an instance of the capability that has the creation type (see policies.Capabilities.Info.createSpecType ) equal to the type of the specified value (see spec ). The parameter must contain all the attributes defined in policies.CreateSpec .
Returns:
The identifier of the newly created policy. Use this identifier to get or destroy the policy. The result will be an identifier for the resource type: com.vmware.vcenter.compute.Policy .

Implemented in vmware::vcenter::compute::PoliciesStub.

string vmware::vcenter::compute::Policies::Create ( vmware.vapi.bindings.IStructure  spec,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Creates a new compute policy in VMware Cloud on AWS.

Usage beyond VMware Cloud on AWS is not supported. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Exceptions:
vmware.vapi.std.errors.AlreadyExistsif a policy with the same name is already present on this vCenter server.
vmware.vapi.std.errors.InvalidArgumentif a parameter passed in the spec is invalid.
vmware.vapi.std.errors.UnableToAllocateResourceif more than 100 policies are created.
vmware.vapi.std.errors.Unauthorizedif the user doesn't have the required privileges.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • Method execution requires ComputePolicy.Manage .
Parameters:
specSpecification for the new policy to be created. The new policy will be an instance of the capability that has the creation type (see policies.Capabilities.Info.createSpecType ) equal to the type of the specified value (see spec ). The parameter must contain all the attributes defined in policies.CreateSpec .
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation
Returns:
The identifier of the newly created policy. Use this identifier to get or destroy the policy. The result will be an identifier for the resource type: com.vmware.vcenter.compute.Policy .

Implemented in vmware::vcenter::compute::PoliciesStub.

global::System.Threading.Tasks.Task<string> vmware::vcenter::compute::Policies::CreateAsync ( vmware.vapi.bindings.IStructure  spec,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Creates a new compute policy in VMware Cloud on AWS.

Usage beyond VMware Cloud on AWS is not supported. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Exceptions:
vmware.vapi.std.errors.AlreadyExistsif a policy with the same name is already present on this vCenter server.
vmware.vapi.std.errors.InvalidArgumentif a parameter passed in the spec is invalid.
vmware.vapi.std.errors.UnableToAllocateResourceif more than 100 policies are created.
vmware.vapi.std.errors.Unauthorizedif the user doesn't have the required privileges.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • Method execution requires ComputePolicy.Manage .
Parameters:
specSpecification for the new policy to be created. The new policy will be an instance of the capability that has the creation type (see policies.Capabilities.Info.createSpecType ) equal to the type of the specified value (see spec ). The parameter must contain all the attributes defined in policies.CreateSpec .
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation
Returns:
The identifier of the newly created policy. Use this identifier to get or destroy the policy. The result will be an identifier for the resource type: com.vmware.vcenter.compute.Policy .

Implemented in vmware::vcenter::compute::PoliciesStub.

global::System.Threading.Tasks.Task<string> vmware::vcenter::compute::Policies::CreateAsync ( vmware.vapi.bindings.IStructure  spec)

Creates a new compute policy in VMware Cloud on AWS.

Usage beyond VMware Cloud on AWS is not supported. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Exceptions:
vmware.vapi.std.errors.AlreadyExistsif a policy with the same name is already present on this vCenter server.
vmware.vapi.std.errors.InvalidArgumentif a parameter passed in the spec is invalid.
vmware.vapi.std.errors.UnableToAllocateResourceif more than 100 policies are created.
vmware.vapi.std.errors.Unauthorizedif the user doesn't have the required privileges.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • Method execution requires ComputePolicy.Manage .
Parameters:
specSpecification for the new policy to be created. The new policy will be an instance of the capability that has the creation type (see policies.Capabilities.Info.createSpecType ) equal to the type of the specified value (see spec ). The parameter must contain all the attributes defined in policies.CreateSpec .
Returns:
The identifier of the newly created policy. Use this identifier to get or destroy the policy. The result will be an identifier for the resource type: com.vmware.vcenter.compute.Policy .

Implemented in vmware::vcenter::compute::PoliciesStub.

void vmware::vcenter::compute::Policies::Delete ( string  policy)

Deletes a specific compute policy in VMware Cloud on AWS.

Usage beyond VMware Cloud on AWS is not supported. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Exceptions:
vmware.vapi.std.errors.NotFoundif a policy with this identifier does not exist.
vmware.vapi.std.errors.Unauthorizedif the user doesn't have the required privileges.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • Method execution requires ComputePolicy.Manage .
Parameters:
policyIdentifier of the policy to be deleted. The parameter must be an identifier for the resource type: com.vmware.vcenter.compute.Policy .

Implemented in vmware::vcenter::compute::PoliciesStub.

void vmware::vcenter::compute::Policies::Delete ( string  policy,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Deletes a specific compute policy in VMware Cloud on AWS.

Usage beyond VMware Cloud on AWS is not supported. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Exceptions:
vmware.vapi.std.errors.NotFoundif a policy with this identifier does not exist.
vmware.vapi.std.errors.Unauthorizedif the user doesn't have the required privileges.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • Method execution requires ComputePolicy.Manage .
Parameters:
policyIdentifier of the policy to be deleted. The parameter must be an identifier for the resource type: com.vmware.vcenter.compute.Policy .
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation

Implemented in vmware::vcenter::compute::PoliciesStub.

global::System.Threading.Tasks.Task vmware::vcenter::compute::Policies::DeleteAsync ( string  policy)

Deletes a specific compute policy in VMware Cloud on AWS.

Usage beyond VMware Cloud on AWS is not supported. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Exceptions:
vmware.vapi.std.errors.NotFoundif a policy with this identifier does not exist.
vmware.vapi.std.errors.Unauthorizedif the user doesn't have the required privileges.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • Method execution requires ComputePolicy.Manage .
Parameters:
policyIdentifier of the policy to be deleted. The parameter must be an identifier for the resource type: com.vmware.vcenter.compute.Policy .

Implemented in vmware::vcenter::compute::PoliciesStub.

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

Deletes a specific compute policy in VMware Cloud on AWS.

Usage beyond VMware Cloud on AWS is not supported. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Exceptions:
vmware.vapi.std.errors.NotFoundif a policy with this identifier does not exist.
vmware.vapi.std.errors.Unauthorizedif the user doesn't have the required privileges.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • Method execution requires ComputePolicy.Manage .
Parameters:
policyIdentifier of the policy to be deleted. The parameter must be an identifier for the resource type: com.vmware.vcenter.compute.Policy .
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation

Implemented in vmware::vcenter::compute::PoliciesStub.

vmware.vapi.bindings.IStructure vmware::vcenter::compute::Policies::Get ( string  policy)

Returns information about a specific compute policy in VMware Cloud on AWS.

Usage beyond VMware Cloud on AWS is not supported. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Exceptions:
vmware.vapi.std.errors.NotFoundif a policy with this identifier does not exist.
vmware.vapi.std.errors.Unauthorizedif the user doesn't have the required privileges.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • Method execution requires System.Read .
Parameters:
policyIdentifier of the policy for which information should be retrieved. The parameter must be an identifier for the resource type: com.vmware.vcenter.compute.Policy .
Returns:
Detailed information about the specified compute policy. The returned value can be converted to the information type of the capability that this policy is based on. See policies.Capabilities.Info.infoType . The result will contain all the attributes defined in policies.Info .

Implemented in vmware::vcenter::compute::PoliciesStub.

vmware.vapi.bindings.IStructure vmware::vcenter::compute::Policies::Get ( string  policy,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Returns information about a specific compute policy in VMware Cloud on AWS.

Usage beyond VMware Cloud on AWS is not supported. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Exceptions:
vmware.vapi.std.errors.NotFoundif a policy with this identifier does not exist.
vmware.vapi.std.errors.Unauthorizedif the user doesn't have the required privileges.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • Method execution requires System.Read .
Parameters:
policyIdentifier of the policy for which information should be retrieved. The parameter must be an identifier for the resource type: com.vmware.vcenter.compute.Policy .
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation
Returns:
Detailed information about the specified compute policy. The returned value can be converted to the information type of the capability that this policy is based on. See policies.Capabilities.Info.infoType . The result will contain all the attributes defined in policies.Info .

Implemented in vmware::vcenter::compute::PoliciesStub.

global::System.Threading.Tasks.Task<vmware.vapi.bindings.IStructure> vmware::vcenter::compute::Policies::GetAsync ( string  policy)

Returns information about a specific compute policy in VMware Cloud on AWS.

Usage beyond VMware Cloud on AWS is not supported. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Exceptions:
vmware.vapi.std.errors.NotFoundif a policy with this identifier does not exist.
vmware.vapi.std.errors.Unauthorizedif the user doesn't have the required privileges.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • Method execution requires System.Read .
Parameters:
policyIdentifier of the policy for which information should be retrieved. The parameter must be an identifier for the resource type: com.vmware.vcenter.compute.Policy .
Returns:
Detailed information about the specified compute policy. The returned value can be converted to the information type of the capability that this policy is based on. See policies.Capabilities.Info.infoType . The result will contain all the attributes defined in policies.Info .

Implemented in vmware::vcenter::compute::PoliciesStub.

global::System.Threading.Tasks.Task<vmware.vapi.bindings.IStructure> vmware::vcenter::compute::Policies::GetAsync ( string  policy,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Returns information about a specific compute policy in VMware Cloud on AWS.

Usage beyond VMware Cloud on AWS is not supported. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Exceptions:
vmware.vapi.std.errors.NotFoundif a policy with this identifier does not exist.
vmware.vapi.std.errors.Unauthorizedif the user doesn't have the required privileges.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • Method execution requires System.Read .
Parameters:
policyIdentifier of the policy for which information should be retrieved. The parameter must be an identifier for the resource type: com.vmware.vcenter.compute.Policy .
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation
Returns:
Detailed information about the specified compute policy. The returned value can be converted to the information type of the capability that this policy is based on. See policies.Capabilities.Info.infoType . The result will contain all the attributes defined in policies.Info .

Implemented in vmware::vcenter::compute::PoliciesStub.

global::System.Collections.Generic.List<vmware.vcenter.compute.PoliciesTypes.Summary> vmware::vcenter::compute::Policies::List ( )

Returns information about the compute policies available in this vCenter server in VMware Cloud on AWS.

Usage beyond VMware Cloud on AWS is not supported. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Exceptions:
vmware.vapi.std.errors.Unauthorizedif the user doesn't have the required privileges.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • Method execution requires System.Read .
Returns:
The list of compute policies available on this vCenter server.

Implemented in vmware::vcenter::compute::PoliciesStub.

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

Returns information about the compute policies available in this vCenter server in VMware Cloud on AWS.

Usage beyond VMware Cloud on AWS is not supported. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Exceptions:
vmware.vapi.std.errors.Unauthorizedif the user doesn't have the required privileges.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • Method execution requires System.Read .
Returns:
The list of compute policies available on this vCenter server.

Implemented in vmware::vcenter::compute::PoliciesStub.

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

Returns information about the compute policies available in this vCenter server in VMware Cloud on AWS.

Usage beyond VMware Cloud on AWS is not supported. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Exceptions:
vmware.vapi.std.errors.Unauthorizedif the user doesn't have the required privileges.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • Method execution requires System.Read .
Returns:
The list of compute policies available on this vCenter server.

Implemented in vmware::vcenter::compute::PoliciesStub.

global::System.Threading.Tasks.Task<global::System.Collections.Generic.List<vmware.vcenter.compute.PoliciesTypes.Summary> > vmware::vcenter::compute::Policies::ListAsync ( )

Returns information about the compute policies available in this vCenter server in VMware Cloud on AWS.

Usage beyond VMware Cloud on AWS is not supported. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Exceptions:
vmware.vapi.std.errors.Unauthorizedif the user doesn't have the required privileges.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • Method execution requires System.Read .
Returns:
The list of compute policies available on this vCenter server.

Implemented in vmware::vcenter::compute::PoliciesStub.


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