com.azure.core.annotations

Annotation Type HEAD

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

HTTP HEAD method annotation describing the parameterized relative path to a REST endpoint.

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

  @HEAD("subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}")
  boolean checkNameAvailability(@PathParam("resourceGroupName") String rgName, @PathParam("vmName") String vmName, @PathParam("subscriptionId") String subscriptionId);

Example 2: Absolute path segment

  @HEAD(https://management.azure.com/{storageAccountId})
  boolean checkNameAvailability(@PathParam("nextLink") String storageAccountId);

Required Element Summary

Required Elements

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

Element Detail

value

public abstract String value

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

Returns:

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