Patch Interface

Implements

public interface Patch
implements Annotation

HTTP PATCH method annotation describing the parameterized relative path to a REST endpoint for resource update.

The required value can be either a relative path or an absolute path. When it's an absolute path, it must start with a protocol or a parameterized segment (Otherwise the parse cannot tell if it's absolute or relative).

Example 1: Relative path segments

@Patch("subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/
 Microsoft.Compute/virtualMachines/{vmName}")
 VirtualMachine patch(@PathParam("resourceGroupName") String rgName, @PathParam("vmName") String
 vmName, @PathParam("subscriptionId") String subscriptionId, @BodyParam VirtualMachineUpdateParameters
 updateParameters);

Example 2: Absolute path segment

@Patch({vaultBaseUrl}/secrets/{secretName})
 Secret patch(@PathParam("vaultBaseUrl" encoded = true) String vaultBaseUrl, @PathParam("secretName") String
 secretName, @BodyParam SecretUpdateParameters updateParameters);

Method Summary

Modifier and Type Method and Description
abstract String value()

Get the relative path of the annotated method's PATCH URL.

Method Details

value

public abstract String value()

Get the relative path of the annotated method's PATCH URL.

Returns:

The relative path of the annotated method's PATCH URL.

Applies to