» azurerm_api_management_api_operation

Manages an API Operation within an API Management Service.

» Example Usage

data "azurerm_api_management_api" "example" {
  name                = "search-api"
  api_management_name = "search-api-management"
  resource_group_name = "search-service"
  revision            = "2"
}

resource "azurerm_api_management_api_operation" "example" {
  operation_id        = "user-delete"
  api_name            = "${data.azurerm_api_management_api.example.name}"
  api_management_name = "${data.azurerm_api_management_api.example.api_management_name}"
  resource_group_name = "${data.azurerm_api_management_api.example.resource_group_name}"
  display_name        = "Delete User Operation"
  method              = "DELETE"
  url_template        = "/users/{id}/delete"
  description         = "This can only be done by the logged in user."

  response {
    status_code = 200
  }
}

» Argument Reference

The following arguments are supported:

operation_id - (Required) A unique identifier for this API Operation. Changing this forces a new resource to be created.
api_name - (Required) The name of the API within the API Management Service where this API Operation should be created. Changing this forces a new resource to be created.
api_management_name - (Required) The Name of the API Management Service where the API exists. Changing this forces a new resource to be created.
resource_group_name - (Required) The Name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
display_name - (Required) The Display Name for this API Management Operation.
method - (Required) The HTTP Method used for this API Management Operation, like GET, DELETE, PUT or POST - but not limited to these values.
url_template - (Required) The relative URL Template identifying the target resource for this operation, which may include parameters.

description - (Optional) A description for this API Operation, which may include HTML formatting tags.
request - (Optional) A request block as defined below.
response - (Optional) One or more response blocks as defined below.
template_parameter - (Optional) One or more template_parameter blocks as defined below.

A form_parameter block supports the following:

name - (Required) The Name of this Form Parameter.
required - (Required) Is this Form Parameter Required?
type - (Required) The Type of this Form Parameter, such as a string.
description - (Optional) A description of this Form Parameter.
default_value - (Optional) The default value for this Form Parameter.
values - (Optional) One or more acceptable values for this Form Parameter.

A header block supports the following:

name - (Required) The Name of this Header.
required - (Required) Is this Header Required?
type - (Required) The Type of this Header, such as a string.
description - (Optional) A description of this Header.
default_value - (Optional) The default value for this Header.
values - (Optional) One or more acceptable values for this Header.

A query_parameter block supports the following:

name - (Required) The Name of this Query Parameter.
required - (Required) Is this Query Parameter Required?
type - (Required) The Type of this Query Parameter, such as a string.
description - (Optional) A description of this Query Parameter.
default_value - (Optional) The default value for this Query Parameter.
values - (Optional) One or more acceptable values for this Query Parameter.

A request block supports the following:

description - (Required) A description of the HTTP Request, which may include HTML tags.
header - (Optional) One or more header blocks as defined above.
query_parameter - (Optional) One or more query_parameter blocks as defined above.
representation - (Optional) One or more representation blocks as defined below.

A representation block supports the following:

content_type - (Required) The Content Type of this representation, such as application/json.
form_parameter - (Optional) One or more form_parameter block as defined above.

NOTE: This is Required when content_type is set to application/x-www-form-urlencoded or multipart/form-data.

sample - (Optional) An example of this representation.
schema_id - (Optional) The ID of an API Management Schema which represents this Response.

NOTE: This can only be specified when content_type is not set to application/x-www-form-urlencoded or multipart/form-data.

type_name - (Optional) The Type Name defined by the Schema.

NOTE: This can only be specified when content_type is not set to application/x-www-form-urlencoded or multipart/form-data.

A response block supports the following:

status_code - (Required) The HTTP Status Code.
description - (Required) A description of the HTTP Response, which may include HTML tags.
header - (Optional) One or more header blocks as defined above.
representation - (Optional) One or more representation blocks as defined below.

A template_parameter block supports the following:

name - (Required) The Name of this Template Parameter.
required - (Required) Is this Template Parameter Required?
type - (Required) The Type of this Template Parameter, such as a string.
description - (Optional) A description of this Template Parameter.
default_value - (Optional) The default value for this Template Parameter.
values - (Optional) One or more acceptable values for this Template Parameter.

» Attributes Reference

In addition to all arguments above, the following attributes are exported:

id - The ID of the API Management API Operation.

» Import

API Management API Operation's can be imported using the resource id, e.g.

terraform import azurerm_api_management_api_operation.test /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.ApiManagement/service/instance1/operations/operation1