com.azure.core.annotations

Annotation Type PUT

@Target(value=METHOD)
 @Retention(value=RUNTIME)
public @interface PUT

HTTP PUT method annotation describing the parameterized relative path to a REST endpoint for resource creation or 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

  @PUT("subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}")
  VirtualMachine createOrUpdate(@PathParam("resourceGroupName") String rgName, @PathParam("vmName") String vmName, @PathParam("subscriptionId") String subscriptionId, @BodyParam VirtualMachine vm);

Example 2: Absolute path segment

  @PUT({vaultBaseUrl}/secrets/{secretName})
  Secret createOrUpdate(@PathParam("vaultBaseUrl" encoded = true) String vaultBaseUrl, @PathParam("secretName") String secretName, @BodyParam SecretCreateParameters secret);

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	value Get the relative path of the annotated method's PUT URL.

Element Detail

value

public abstract String value

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

Returns:

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