com.azure.core.annotation

Annotation Type Post

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

HTTP POST method annotation describing the parameterized relative path to a REST endpoint for an action.

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

  @Post("subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft
 .Compute/virtualMachines/{vmName}/restart")
  void restart(@PathParam("resourceGroupName") String rgName, @PathParam("vmName") String vmName, @PathParam
  ("subscriptionId") String subscriptionId);

Example 2: Absolute path segment

  @Post(https://{functionApp}.azurewebsites.net/admin/functions/{name}/keys/{keyName})
  NameValuePair generateFunctionKey(@PathParam("functionApp") String functionApp, @PathParam("name") String
  function, @PathParam("keyName") String keyName);

Required Element Summary

Required Elements

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

Element Detail

value

public abstract String value

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

Returns:

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