Share via


FabricClient.PropertyManagementClient.PutPropertyAsync Method

Definition

Overloads

PutPropertyAsync(Uri, String, Byte[])

Creates or updates the specified Service Fabric property of type Byte array under a given name.

PutPropertyAsync(Uri, String, Double)

Creates or updates the specified Service Fabric property of type Double under a given name.

PutPropertyAsync(Uri, String, Guid)

Creates or updates the specified Service Fabric property of type Guid under a given name.

PutPropertyAsync(Uri, String, Int64)

Creates or updates the specified Service Fabric property of type Int64 under a given name.

PutPropertyAsync(Uri, String, String)

Creates or updates the specified Service Fabric property of type String under a given name.

PutPropertyAsync(Uri, String, Byte[], TimeSpan, CancellationToken)

Creates or updates the specified Service Fabric property of type Byte array under a given name.

PutPropertyAsync(Uri, String, Double, TimeSpan, CancellationToken)

Creates or updates the specified Service Fabric property of type Double under a given name.

PutPropertyAsync(Uri, String, Guid, TimeSpan, CancellationToken)

Creates or updates the specified Service Fabric property of type Guid under a given name.

PutPropertyAsync(Uri, String, Int64, TimeSpan, CancellationToken)

Creates or updates the specified Service Fabric property of type Int64 under a given name.

PutPropertyAsync(Uri, String, String, TimeSpan, CancellationToken)

Creates or updates the specified Service Fabric property of type String under a given name.

PutPropertyAsync(Uri, String, Byte[])

Creates or updates the specified Service Fabric property of type Byte array under a given name.

public System.Threading.Tasks.Task PutPropertyAsync (Uri parentName, string propertyName, byte[] value);
member this.PutPropertyAsync : Uri * string * byte[] -> System.Threading.Tasks.Task
Public Function PutPropertyAsync (parentName As Uri, propertyName As String, value As Byte()) As Task

Parameters

parentName
Uri

The parent Service Fabric name.

propertyName
String

The name of the Service Fabric property.

value
Byte[]

The value of the property.

Returns

A task that represents the asynchronous put operation.

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 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 value is larger than 1MB.

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

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

Applies to

PutPropertyAsync(Uri, String, Double)

Creates or updates the specified Service Fabric property of type Double under a given name.

public System.Threading.Tasks.Task PutPropertyAsync (Uri parentName, string propertyName, double value);
member this.PutPropertyAsync : Uri * string * double -> System.Threading.Tasks.Task
Public Function PutPropertyAsync (parentName As Uri, propertyName As String, value As Double) As Task

Parameters

parentName
Uri

The parent Service Fabric name.

propertyName
String

The name of the Service Fabric property.

value
Double

The value of the property.

Returns

A task that represents the asynchronous put operation.

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 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 value is larger than 1MB.

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

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

Applies to

PutPropertyAsync(Uri, String, Guid)

Creates or updates the specified Service Fabric property of type Guid under a given name.

public System.Threading.Tasks.Task PutPropertyAsync (Uri parentName, string propertyName, Guid value);
member this.PutPropertyAsync : Uri * string * Guid -> System.Threading.Tasks.Task
Public Function PutPropertyAsync (parentName As Uri, propertyName As String, value As Guid) As Task

Parameters

parentName
Uri

The parent Service Fabric name.

propertyName
String

The name of the Service Fabric property.

value
Guid

The value of the property.

Returns

A task that represents the asynchronous put operation.

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 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 value is larger than 1MB.

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

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

Applies to

PutPropertyAsync(Uri, String, Int64)

Creates or updates the specified Service Fabric property of type Int64 under a given name.

public System.Threading.Tasks.Task PutPropertyAsync (Uri parentName, string propertyName, long value);
member this.PutPropertyAsync : Uri * string * int64 -> System.Threading.Tasks.Task
Public Function PutPropertyAsync (parentName As Uri, propertyName As String, value As Long) As Task

Parameters

parentName
Uri

The parent Service Fabric name.

propertyName
String

The name of the Service Fabric property.

value
Int64

The value of the property.

Returns

A task that represents the asynchronous put operation.

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 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 value is larger than 1MB.

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

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

Applies to

PutPropertyAsync(Uri, String, String)

Creates or updates the specified Service Fabric property of type String under a given name.

public System.Threading.Tasks.Task PutPropertyAsync (Uri parentName, string propertyName, string value);
member this.PutPropertyAsync : Uri * string * string -> System.Threading.Tasks.Task
Public Function PutPropertyAsync (parentName As Uri, propertyName As String, value As String) As Task

Parameters

parentName
Uri

The parent Service Fabric name.

propertyName
String

The name of the Service Fabric property.

value
String

The value of the property.

Returns

A task that represents the asynchronous put operation.

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 value is larger than 1MB.

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

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

Applies to

PutPropertyAsync(Uri, String, Byte[], TimeSpan, CancellationToken)

Creates or updates the specified Service Fabric property of type Byte array under a given name.

public System.Threading.Tasks.Task PutPropertyAsync (Uri parentName, string propertyName, byte[] value, TimeSpan timeout, System.Threading.CancellationToken cancellationToken);
member this.PutPropertyAsync : Uri * string * byte[] * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task
Public Function PutPropertyAsync (parentName As Uri, propertyName As String, value As Byte(), timeout As TimeSpan, cancellationToken As CancellationToken) As Task

Parameters

parentName
Uri

The parent Service Fabric name.

propertyName
String

The name of the Service Fabric property.

value
Byte[]

The value of the property.

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 put operation.

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 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 value is larger than 1MB.

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

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

Applies to

PutPropertyAsync(Uri, String, Double, TimeSpan, CancellationToken)

Creates or updates the specified Service Fabric property of type Double under a given name.

public System.Threading.Tasks.Task PutPropertyAsync (Uri parentName, string propertyName, double value, TimeSpan timeout, System.Threading.CancellationToken cancellationToken);
member this.PutPropertyAsync : Uri * string * double * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task
Public Function PutPropertyAsync (parentName As Uri, propertyName As String, value As Double, timeout As TimeSpan, cancellationToken As CancellationToken) As Task

Parameters

parentName
Uri

The parent Service Fabric name.

propertyName
String

The name of the Service Fabric property.

value
Double

The value of the property.

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 put operation.

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 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 value is larger than 1MB.

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

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

Applies to

PutPropertyAsync(Uri, String, Guid, TimeSpan, CancellationToken)

Creates or updates the specified Service Fabric property of type Guid under a given name.

public System.Threading.Tasks.Task PutPropertyAsync (Uri parentName, string propertyName, Guid value, TimeSpan timeout, System.Threading.CancellationToken cancellationToken);
member this.PutPropertyAsync : Uri * string * Guid * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task
Public Function PutPropertyAsync (parentName As Uri, propertyName As String, value As Guid, timeout As TimeSpan, cancellationToken As CancellationToken) As Task

Parameters

parentName
Uri

The parent Service Fabric name.

propertyName
String

The name of the Service Fabric property.

value
Guid

The value of the property.

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 put operation.

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 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 value is larger than 1MB.

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

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

Applies to

PutPropertyAsync(Uri, String, Int64, TimeSpan, CancellationToken)

Creates or updates the specified Service Fabric property of type Int64 under a given name.

public System.Threading.Tasks.Task PutPropertyAsync (Uri parentName, string propertyName, long value, TimeSpan timeout, System.Threading.CancellationToken cancellationToken);
member this.PutPropertyAsync : Uri * string * int64 * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task
Public Function PutPropertyAsync (parentName As Uri, propertyName As String, value As Long, timeout As TimeSpan, cancellationToken As CancellationToken) As Task

Parameters

parentName
Uri

The parent Service Fabric name.

propertyName
String

The name of the Service Fabric property.

value
Int64

The value of the property.

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 put operation.

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 value is larger than 1MB.

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

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

Applies to

PutPropertyAsync(Uri, String, String, TimeSpan, CancellationToken)

Creates or updates the specified Service Fabric property of type String under a given name.

public System.Threading.Tasks.Task PutPropertyAsync (Uri parentName, string propertyName, string value, TimeSpan timeout, System.Threading.CancellationToken cancellationToken);
member this.PutPropertyAsync : Uri * string * string * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task
Public Function PutPropertyAsync (parentName As Uri, propertyName As String, value As String, timeout As TimeSpan, cancellationToken As CancellationToken) As Task

Parameters

parentName
Uri

The parent Service Fabric name.

propertyName
String

The name of the Service Fabric property.

value
String

The value of the property.

timeout
TimeSpan

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

cancellationToken
CancellationToken

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

Returns

A task that represents the asynchronous put operation.

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 value is larger than 1MB.

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

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

Applies to