Share via


FabricClient.PropertyManagementClient.SubmitPropertyBatchAsync Method

Definition

Overloads

SubmitPropertyBatchAsync(Uri, ICollection<PropertyBatchOperation>)

Submits a batch of PropertyBatchOperation.

SubmitPropertyBatchAsync(Uri, ICollection<PropertyBatchOperation>, TimeSpan, CancellationToken)

Submits a batch of PropertyBatchOperations. Either all or none of the operations in the batch will be committed.

SubmitPropertyBatchAsync(Uri, ICollection<PropertyBatchOperation>)

Submits a batch of PropertyBatchOperation.

public System.Threading.Tasks.Task<System.Fabric.PropertyBatchResult> SubmitPropertyBatchAsync (Uri parentName, System.Collections.Generic.ICollection<System.Fabric.PropertyBatchOperation> operations);
member this.SubmitPropertyBatchAsync : Uri * System.Collections.Generic.ICollection<System.Fabric.PropertyBatchOperation> -> System.Threading.Tasks.Task<System.Fabric.PropertyBatchResult>
Public Function SubmitPropertyBatchAsync (parentName As Uri, operations As ICollection(Of PropertyBatchOperation)) As Task(Of PropertyBatchResult)

Parameters

parentName
Uri

The parent Service Fabric name under which the Property batch operations will be executed.

operations
ICollection<PropertyBatchOperation>

The batch property operations.

Returns

A task that represents the asynchronous get operation.

See PropertyBatchResult.

Exceptions

Caused by one of the following:

E_INVALIDARG is returned when one or more arguments are not valid.

Caused by one of the following:

E_POINTER is returned when a null reference is passed to a method that does not accept it as a valid argument.

Caused by one of the following:

NameNotFound is returned when the user provided parentName does not exist.

Caused by one of the following:

WriteConflict is returned when this write operation conflicts with another write operation.

Caused by one of the following:

E_ABORT is returned when operation was aborted.

Caused by one of the following:

InvalidNameUri is returned when parentName is not a valid Service Fabric name.

ValueTooLarge is returned when property value is larger than 1MB.

PropertyCheckFailed is returned when at least one check operation in the user provided operations has failed.

See also https://docs.microsoft.com/azure/service-fabric/service-fabric-errors-and-exceptions for handling common FabricClient failures.

This exception is thrown when an internal error has occurred.

Remarks

Either all or none of the operations in the batch will be committed.

Timeout for the operation will be set to default timeout (1 minute).

Applies to

SubmitPropertyBatchAsync(Uri, ICollection<PropertyBatchOperation>, TimeSpan, CancellationToken)

Submits a batch of PropertyBatchOperations. Either all or none of the operations in the batch will be committed.

public System.Threading.Tasks.Task<System.Fabric.PropertyBatchResult> SubmitPropertyBatchAsync (Uri parentName, System.Collections.Generic.ICollection<System.Fabric.PropertyBatchOperation> operations, TimeSpan timeout, System.Threading.CancellationToken cancellationToken);
member this.SubmitPropertyBatchAsync : Uri * System.Collections.Generic.ICollection<System.Fabric.PropertyBatchOperation> * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Fabric.PropertyBatchResult>
Public Function SubmitPropertyBatchAsync (parentName As Uri, operations As ICollection(Of PropertyBatchOperation), timeout As TimeSpan, cancellationToken As CancellationToken) As Task(Of PropertyBatchResult)

Parameters

parentName
Uri

The parent Service Fabric name under which the Property batch operations will be executed.

operations
ICollection<PropertyBatchOperation>

The batch property operations.

timeout
TimeSpan

The maximum amount of time the system will allow this operation to continue before returning TimeoutException.

cancellationToken
CancellationToken

The CancellationToken that the operation is observing. It can be used to propagate notification that the operation should be canceled.

Returns

A task that represents the asynchronous get operation.

See PropertyBatchResult.

Exceptions

Caused by one of the following:

E_INVALIDARG is returned when one or more arguments are not valid.

Caused by one of the following:

E_POINTER is returned when a null reference is passed to a method that does not accept it as a valid argument.

Caused by one of the following:

NameNotFound is returned when the user provided parentName does not exist.

Caused by one of the following:

WriteConflict is returned when this write operation conflicts with another write operation.

Caused by one of the following:

E_ABORT is returned when operation was aborted.

Caused by one of the following:

InvalidNameUri is returned when parentName is not a valid Service Fabric name.

ValueTooLarge is returned when property value is larger than 1MB.

PropertyCheckFailed is returned when at least one check operation in the user provided operations has failed.

See also https://docs.microsoft.com/azure/service-fabric/service-fabric-errors-and-exceptions for handling common FabricClient failures.

This exception is thrown when an internal error has occurred.

Remarks

Either all or none of the operations in the batch will be committed.

Timeout for the operation will be set to default timeout (1 minute).

Applies to