ApiOperation

class ApiOperation : KotlinCustomResource

Manages an API Operation within an API Management Service.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const example = azure.apimanagement.getApi({
name: "search-api",
apiManagementName: "search-api-management",
resourceGroupName: "search-service",
revision: "2",
});
const exampleApiOperation = new azure.apimanagement.ApiOperation("example", {
operationId: "user-delete",
apiName: example.then(example => example.name),
apiManagementName: example.then(example => example.apiManagementName),
resourceGroupName: example.then(example => example.resourceGroupName),
displayName: "Delete User Operation",
method: "DELETE",
urlTemplate: "/users/{id}/delete",
description: "This can only be done by the logged in user.",
templateParameters: [{
name: "id",
type: "number",
required: true,
}],
responses: [{
statusCode: 200,
}],
});
import pulumi
import pulumi_azure as azure
example = azure.apimanagement.get_api(name="search-api",
api_management_name="search-api-management",
resource_group_name="search-service",
revision="2")
example_api_operation = azure.apimanagement.ApiOperation("example",
operation_id="user-delete",
api_name=example.name,
api_management_name=example.api_management_name,
resource_group_name=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.",
template_parameters=[{
"name": "id",
"type": "number",
"required": True,
}],
responses=[{
"status_code": 200,
}])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
var example = Azure.ApiManagement.GetApi.Invoke(new()
{
Name = "search-api",
ApiManagementName = "search-api-management",
ResourceGroupName = "search-service",
Revision = "2",
});
var exampleApiOperation = new Azure.ApiManagement.ApiOperation("example", new()
{
OperationId = "user-delete",
ApiName = example.Apply(getApiResult => getApiResult.Name),
ApiManagementName = example.Apply(getApiResult => getApiResult.ApiManagementName),
ResourceGroupName = example.Apply(getApiResult => getApiResult.ResourceGroupName),
DisplayName = "Delete User Operation",
Method = "DELETE",
UrlTemplate = "/users/{id}/delete",
Description = "This can only be done by the logged in user.",
TemplateParameters = new[]
{
new Azure.ApiManagement.Inputs.ApiOperationTemplateParameterArgs
{
Name = "id",
Type = "number",
Required = true,
},
},
Responses = new[]
{
new Azure.ApiManagement.Inputs.ApiOperationResponseArgs
{
StatusCode = 200,
},
},
});
});
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/apimanagement"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := apimanagement.LookupApi(ctx, &apimanagement.LookupApiArgs{
Name: "search-api",
ApiManagementName: "search-api-management",
ResourceGroupName: "search-service",
Revision: "2",
}, nil)
if err != nil {
return err
}
_, err = apimanagement.NewApiOperation(ctx, "example", &apimanagement.ApiOperationArgs{
OperationId: pulumi.String("user-delete"),
ApiName: pulumi.String(example.Name),
ApiManagementName: pulumi.String(example.ApiManagementName),
ResourceGroupName: pulumi.String(example.ResourceGroupName),
DisplayName: pulumi.String("Delete User Operation"),
Method: pulumi.String("DELETE"),
UrlTemplate: pulumi.String("/users/{id}/delete"),
Description: pulumi.String("This can only be done by the logged in user."),
TemplateParameters: apimanagement.ApiOperationTemplateParameterArray{
&apimanagement.ApiOperationTemplateParameterArgs{
Name: pulumi.String("id"),
Type: pulumi.String("number"),
Required: pulumi.Bool(true),
},
},
Responses: apimanagement.ApiOperationResponseArray{
&apimanagement.ApiOperationResponseArgs{
StatusCode: pulumi.Int(200),
},
},
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.apimanagement.ApimanagementFunctions;
import com.pulumi.azure.apimanagement.inputs.GetApiArgs;
import com.pulumi.azure.apimanagement.ApiOperation;
import com.pulumi.azure.apimanagement.ApiOperationArgs;
import com.pulumi.azure.apimanagement.inputs.ApiOperationTemplateParameterArgs;
import com.pulumi.azure.apimanagement.inputs.ApiOperationResponseArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var example = ApimanagementFunctions.getApi(GetApiArgs.builder()
.name("search-api")
.apiManagementName("search-api-management")
.resourceGroupName("search-service")
.revision("2")
.build());
var exampleApiOperation = new ApiOperation("exampleApiOperation", ApiOperationArgs.builder()
.operationId("user-delete")
.apiName(example.name())
.apiManagementName(example.apiManagementName())
.resourceGroupName(example.resourceGroupName())
.displayName("Delete User Operation")
.method("DELETE")
.urlTemplate("/users/{id}/delete")
.description("This can only be done by the logged in user.")
.templateParameters(ApiOperationTemplateParameterArgs.builder()
.name("id")
.type("number")
.required(true)
.build())
.responses(ApiOperationResponseArgs.builder()
.statusCode(200)
.build())
.build());
}
}
resources:
exampleApiOperation:
type: azure:apimanagement:ApiOperation
name: example
properties:
operationId: user-delete
apiName: ${example.name}
apiManagementName: ${example.apiManagementName}
resourceGroupName: ${example.resourceGroupName}
displayName: Delete User Operation
method: DELETE
urlTemplate: /users/{id}/delete
description: This can only be done by the logged in user.
templateParameters:
- name: id
type: number
required: true
responses:
- statusCode: 200
variables:
example:
fn::invoke:
function: azure:apimanagement:getApi
arguments:
name: search-api
apiManagementName: search-api-management
resourceGroupName: search-service
revision: '2'

API Providers

This resource uses the following Azure API Providers:

  • Microsoft.ApiManagement: 2022-08-01

Import

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

$ pulumi import azure:apimanagement/apiOperation:ApiOperation example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.ApiManagement/service/instance1/apis/api1/operations/operation1

Properties

Link copied to clipboard

The Name of the API Management Service where the API exists. Changing this forces a new resource to be created.

Link copied to clipboard
val apiName: Output<String>

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.

Link copied to clipboard
val description: Output<String>?

A description for this API Operation, which may include HTML formatting tags.

Link copied to clipboard
val displayName: Output<String>

The Display Name for this API Management Operation.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val method: Output<String>

The HTTP Method used for this API Management Operation, like GET, DELETE, PUT or POST - but not limited to these values.

Link copied to clipboard
val operationId: Output<String>

A unique identifier for this API Operation. Changing this forces a new resource to be created.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

A request block as defined below.

Link copied to clipboard

The Name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.

Link copied to clipboard

One or more response blocks as defined below.

Link copied to clipboard

One or more template_parameter blocks as defined below. Required if url_template contains one or more parameters.

Link copied to clipboard
val urlTemplate: Output<String>

The relative URL Template identifying the target resource for this operation, which may include parameters.

Link copied to clipboard
val urn: Output<String>