Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Azure Classic
  4. API Docs
  5. apimanagement
  6. ApiOperation

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-azure

azure.apimanagement.ApiOperation

azure logo

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-azure

    Manages an API Operation within an API Management Service.

    Example Usage

    using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleApi = Output.Create(Azure.ApiManagement.GetApi.InvokeAsync(new Azure.ApiManagement.GetApiArgs
        {
            Name = "search-api",
            ApiManagementName = "search-api-management",
            ResourceGroupName = "search-service",
            Revision = "2",
        }));
        var exampleApiOperation = new Azure.ApiManagement.ApiOperation("exampleApiOperation", new Azure.ApiManagement.ApiOperationArgs
        {
            OperationId = "user-delete",
            ApiName = exampleApi.Apply(exampleApi => exampleApi.Name),
            ApiManagementName = exampleApi.Apply(exampleApi => exampleApi.ApiManagementName),
            ResourceGroupName = exampleApi.Apply(exampleApi => exampleApi.ResourceGroupName),
            DisplayName = "Delete User Operation",
            Method = "DELETE",
            UrlTemplate = "/users/{id}/delete",
            Description = "This can only be done by the logged in user.",
            Responses = 
            {
                new Azure.ApiManagement.Inputs.ApiOperationResponseArgs
                {
                    StatusCode = 200,
                },
            },
        });
    }

}

    package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/apimanagement"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleApi, 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, "exampleApiOperation", &apimanagement.ApiOperationArgs{
			OperationId:       pulumi.String("user-delete"),
			ApiName:           pulumi.String(exampleApi.Name),
			ApiManagementName: pulumi.String(exampleApi.ApiManagementName),
			ResourceGroupName: pulumi.String(exampleApi.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."),
			Responses: apimanagement.ApiOperationResponseArray{
				&apimanagement.ApiOperationResponseArgs{
					StatusCode: pulumi.Int(200),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    Example coming soon!

    import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleApi = azure.apimanagement.getApi({
    name: "search-api",
    apiManagementName: "search-api-management",
    resourceGroupName: "search-service",
    revision: "2",
});
const exampleApiOperation = new azure.apimanagement.ApiOperation("exampleApiOperation", {
    operationId: "user-delete",
    apiName: exampleApi.then(exampleApi => exampleApi.name),
    apiManagementName: exampleApi.then(exampleApi => exampleApi.apiManagementName),
    resourceGroupName: exampleApi.then(exampleApi => exampleApi.resourceGroupName),
    displayName: "Delete User Operation",
    method: "DELETE",
    urlTemplate: "/users/{id}/delete",
    description: "This can only be done by the logged in user.",
    responses: [{
        statusCode: 200,
    }],
});

    import pulumi
import pulumi_azure as azure

example_api = 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("exampleApiOperation",
    operation_id="user-delete",
    api_name=example_api.name,
    api_management_name=example_api.api_management_name,
    resource_group_name=example_api.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.",
    responses=[azure.apimanagement.ApiOperationResponseArgs(
        status_code=200,
    )])

    Example coming soon!

    Create ApiOperation Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ApiOperation(name: string, args: ApiOperationArgs, opts?: CustomResourceOptions);
    @overload
def ApiOperation(resource_name: str,
                 args: ApiOperationArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def ApiOperation(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 api_management_name: Optional[str] = None,
                 api_name: Optional[str] = None,
                 display_name: Optional[str] = None,
                 method: Optional[str] = None,
                 operation_id: Optional[str] = None,
                 resource_group_name: Optional[str] = None,
                 url_template: Optional[str] = None,
                 description: Optional[str] = None,
                 request: Optional[ApiOperationRequestArgs] = None,
                 responses: Optional[Sequence[ApiOperationResponseArgs]] = None,
                 template_parameters: Optional[Sequence[ApiOperationTemplateParameterArgs]] = None)
    func NewApiOperation(ctx *Context, name string, args ApiOperationArgs, opts ...ResourceOption) (*ApiOperation, error)
    public ApiOperation(string name, ApiOperationArgs args, CustomResourceOptions? opts = null)
    public ApiOperation(String name, ApiOperationArgs args)
public ApiOperation(String name, ApiOperationArgs args, CustomResourceOptions options)

    type: azure:apimanagement:ApiOperation
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ApiOperationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ApiOperationArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ApiOperationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApiOperationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApiOperationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var apiOperationResource = new Azure.ApiManagement.ApiOperation("apiOperationResource", new()
{
    ApiManagementName = "string",
    ApiName = "string",
    DisplayName = "string",
    Method = "string",
    OperationId = "string",
    ResourceGroupName = "string",
    UrlTemplate = "string",
    Description = "string",
    Request = new Azure.ApiManagement.Inputs.ApiOperationRequestArgs
    {
        Description = "string",
        Headers = new[]
        {
            new Azure.ApiManagement.Inputs.ApiOperationRequestHeaderArgs
            {
                Name = "string",
                Required = false,
                Type = "string",
                DefaultValue = "string",
                Description = "string",
                Values = new[]
                {
                    "string",
                },
            },
        },
        QueryParameters = new[]
        {
            new Azure.ApiManagement.Inputs.ApiOperationRequestQueryParameterArgs
            {
                Name = "string",
                Required = false,
                Type = "string",
                DefaultValue = "string",
                Description = "string",
                Values = new[]
                {
                    "string",
                },
            },
        },
        Representations = new[]
        {
            new Azure.ApiManagement.Inputs.ApiOperationRequestRepresentationArgs
            {
                ContentType = "string",
                Examples = new[]
                {
                    new Azure.ApiManagement.Inputs.ApiOperationRequestRepresentationExampleArgs
                    {
                        Name = "string",
                        Description = "string",
                        ExternalValue = "string",
                        Summary = "string",
                        Value = "string",
                    },
                },
                FormParameters = new[]
                {
                    new Azure.ApiManagement.Inputs.ApiOperationRequestRepresentationFormParameterArgs
                    {
                        Name = "string",
                        Required = false,
                        Type = "string",
                        DefaultValue = "string",
                        Description = "string",
                        Values = new[]
                        {
                            "string",
                        },
                    },
                },
                SchemaId = "string",
                TypeName = "string",
            },
        },
    },
    Responses = new[]
    {
        new Azure.ApiManagement.Inputs.ApiOperationResponseArgs
        {
            StatusCode = 0,
            Description = "string",
            Headers = new[]
            {
                new Azure.ApiManagement.Inputs.ApiOperationResponseHeaderArgs
                {
                    Name = "string",
                    Required = false,
                    Type = "string",
                    DefaultValue = "string",
                    Description = "string",
                    Values = new[]
                    {
                        "string",
                    },
                },
            },
            Representations = new[]
            {
                new Azure.ApiManagement.Inputs.ApiOperationResponseRepresentationArgs
                {
                    ContentType = "string",
                    Examples = new[]
                    {
                        new Azure.ApiManagement.Inputs.ApiOperationResponseRepresentationExampleArgs
                        {
                            Name = "string",
                            Description = "string",
                            ExternalValue = "string",
                            Summary = "string",
                            Value = "string",
                        },
                    },
                    FormParameters = new[]
                    {
                        new Azure.ApiManagement.Inputs.ApiOperationResponseRepresentationFormParameterArgs
                        {
                            Name = "string",
                            Required = false,
                            Type = "string",
                            DefaultValue = "string",
                            Description = "string",
                            Values = new[]
                            {
                                "string",
                            },
                        },
                    },
                    SchemaId = "string",
                    TypeName = "string",
                },
            },
        },
    },
    TemplateParameters = new[]
    {
        new Azure.ApiManagement.Inputs.ApiOperationTemplateParameterArgs
        {
            Name = "string",
            Required = false,
            Type = "string",
            DefaultValue = "string",
            Description = "string",
            Values = new[]
            {
                "string",
            },
        },
    },
});

    example, err := apimanagement.NewApiOperation(ctx, "apiOperationResource", &apimanagement.ApiOperationArgs{
	ApiManagementName: pulumi.String("string"),
	ApiName:           pulumi.String("string"),
	DisplayName:       pulumi.String("string"),
	Method:            pulumi.String("string"),
	OperationId:       pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	UrlTemplate:       pulumi.String("string"),
	Description:       pulumi.String("string"),
	Request: &apimanagement.ApiOperationRequestArgs{
		Description: pulumi.String("string"),
		Headers: apimanagement.ApiOperationRequestHeaderArray{
			&apimanagement.ApiOperationRequestHeaderArgs{
				Name:         pulumi.String("string"),
				Required:     pulumi.Bool(false),
				Type:         pulumi.String("string"),
				DefaultValue: pulumi.String("string"),
				Description:  pulumi.String("string"),
				Values: pulumi.StringArray{
					pulumi.String("string"),
				},
			},
		},
		QueryParameters: apimanagement.ApiOperationRequestQueryParameterArray{
			&apimanagement.ApiOperationRequestQueryParameterArgs{
				Name:         pulumi.String("string"),
				Required:     pulumi.Bool(false),
				Type:         pulumi.String("string"),
				DefaultValue: pulumi.String("string"),
				Description:  pulumi.String("string"),
				Values: pulumi.StringArray{
					pulumi.String("string"),
				},
			},
		},
		Representations: apimanagement.ApiOperationRequestRepresentationArray{
			&apimanagement.ApiOperationRequestRepresentationArgs{
				ContentType: pulumi.String("string"),
				Examples: apimanagement.ApiOperationRequestRepresentationExampleArray{
					&apimanagement.ApiOperationRequestRepresentationExampleArgs{
						Name:          pulumi.String("string"),
						Description:   pulumi.String("string"),
						ExternalValue: pulumi.String("string"),
						Summary:       pulumi.String("string"),
						Value:         pulumi.String("string"),
					},
				},
				FormParameters: apimanagement.ApiOperationRequestRepresentationFormParameterArray{
					&apimanagement.ApiOperationRequestRepresentationFormParameterArgs{
						Name:         pulumi.String("string"),
						Required:     pulumi.Bool(false),
						Type:         pulumi.String("string"),
						DefaultValue: pulumi.String("string"),
						Description:  pulumi.String("string"),
						Values: pulumi.StringArray{
							pulumi.String("string"),
						},
					},
				},
				SchemaId: pulumi.String("string"),
				TypeName: pulumi.String("string"),
			},
		},
	},
	Responses: apimanagement.ApiOperationResponseArray{
		&apimanagement.ApiOperationResponseArgs{
			StatusCode:  pulumi.Int(0),
			Description: pulumi.String("string"),
			Headers: apimanagement.ApiOperationResponseHeaderArray{
				&apimanagement.ApiOperationResponseHeaderArgs{
					Name:         pulumi.String("string"),
					Required:     pulumi.Bool(false),
					Type:         pulumi.String("string"),
					DefaultValue: pulumi.String("string"),
					Description:  pulumi.String("string"),
					Values: pulumi.StringArray{
						pulumi.String("string"),
					},
				},
			},
			Representations: apimanagement.ApiOperationResponseRepresentationArray{
				&apimanagement.ApiOperationResponseRepresentationArgs{
					ContentType: pulumi.String("string"),
					Examples: apimanagement.ApiOperationResponseRepresentationExampleArray{
						&apimanagement.ApiOperationResponseRepresentationExampleArgs{
							Name:          pulumi.String("string"),
							Description:   pulumi.String("string"),
							ExternalValue: pulumi.String("string"),
							Summary:       pulumi.String("string"),
							Value:         pulumi.String("string"),
						},
					},
					FormParameters: apimanagement.ApiOperationResponseRepresentationFormParameterArray{
						&apimanagement.ApiOperationResponseRepresentationFormParameterArgs{
							Name:         pulumi.String("string"),
							Required:     pulumi.Bool(false),
							Type:         pulumi.String("string"),
							DefaultValue: pulumi.String("string"),
							Description:  pulumi.String("string"),
							Values: pulumi.StringArray{
								pulumi.String("string"),
							},
						},
					},
					SchemaId: pulumi.String("string"),
					TypeName: pulumi.String("string"),
				},
			},
		},
	},
	TemplateParameters: apimanagement.ApiOperationTemplateParameterArray{
		&apimanagement.ApiOperationTemplateParameterArgs{
			Name:         pulumi.String("string"),
			Required:     pulumi.Bool(false),
			Type:         pulumi.String("string"),
			DefaultValue: pulumi.String("string"),
			Description:  pulumi.String("string"),
			Values: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
})

    var apiOperationResource = new ApiOperation("apiOperationResource", ApiOperationArgs.builder()
    .apiManagementName("string")
    .apiName("string")
    .displayName("string")
    .method("string")
    .operationId("string")
    .resourceGroupName("string")
    .urlTemplate("string")
    .description("string")
    .request(ApiOperationRequestArgs.builder()
        .description("string")
        .headers(ApiOperationRequestHeaderArgs.builder()
            .name("string")
            .required(false)
            .type("string")
            .defaultValue("string")
            .description("string")
            .values("string")
            .build())
        .queryParameters(ApiOperationRequestQueryParameterArgs.builder()
            .name("string")
            .required(false)
            .type("string")
            .defaultValue("string")
            .description("string")
            .values("string")
            .build())
        .representations(ApiOperationRequestRepresentationArgs.builder()
            .contentType("string")
            .examples(ApiOperationRequestRepresentationExampleArgs.builder()
                .name("string")
                .description("string")
                .externalValue("string")
                .summary("string")
                .value("string")
                .build())
            .formParameters(ApiOperationRequestRepresentationFormParameterArgs.builder()
                .name("string")
                .required(false)
                .type("string")
                .defaultValue("string")
                .description("string")
                .values("string")
                .build())
            .schemaId("string")
            .typeName("string")
            .build())
        .build())
    .responses(ApiOperationResponseArgs.builder()
        .statusCode(0)
        .description("string")
        .headers(ApiOperationResponseHeaderArgs.builder()
            .name("string")
            .required(false)
            .type("string")
            .defaultValue("string")
            .description("string")
            .values("string")
            .build())
        .representations(ApiOperationResponseRepresentationArgs.builder()
            .contentType("string")
            .examples(ApiOperationResponseRepresentationExampleArgs.builder()
                .name("string")
                .description("string")
                .externalValue("string")
                .summary("string")
                .value("string")
                .build())
            .formParameters(ApiOperationResponseRepresentationFormParameterArgs.builder()
                .name("string")
                .required(false)
                .type("string")
                .defaultValue("string")
                .description("string")
                .values("string")
                .build())
            .schemaId("string")
            .typeName("string")
            .build())
        .build())
    .templateParameters(ApiOperationTemplateParameterArgs.builder()
        .name("string")
        .required(false)
        .type("string")
        .defaultValue("string")
        .description("string")
        .values("string")
        .build())
    .build());

    api_operation_resource = azure.apimanagement.ApiOperation("apiOperationResource",
    api_management_name="string",
    api_name="string",
    display_name="string",
    method="string",
    operation_id="string",
    resource_group_name="string",
    url_template="string",
    description="string",
    request={
        "description": "string",
        "headers": [{
            "name": "string",
            "required": False,
            "type": "string",
            "default_value": "string",
            "description": "string",
            "values": ["string"],
        }],
        "query_parameters": [{
            "name": "string",
            "required": False,
            "type": "string",
            "default_value": "string",
            "description": "string",
            "values": ["string"],
        }],
        "representations": [{
            "content_type": "string",
            "examples": [{
                "name": "string",
                "description": "string",
                "external_value": "string",
                "summary": "string",
                "value": "string",
            }],
            "form_parameters": [{
                "name": "string",
                "required": False,
                "type": "string",
                "default_value": "string",
                "description": "string",
                "values": ["string"],
            }],
            "schema_id": "string",
            "type_name": "string",
        }],
    },
    responses=[{
        "status_code": 0,
        "description": "string",
        "headers": [{
            "name": "string",
            "required": False,
            "type": "string",
            "default_value": "string",
            "description": "string",
            "values": ["string"],
        }],
        "representations": [{
            "content_type": "string",
            "examples": [{
                "name": "string",
                "description": "string",
                "external_value": "string",
                "summary": "string",
                "value": "string",
            }],
            "form_parameters": [{
                "name": "string",
                "required": False,
                "type": "string",
                "default_value": "string",
                "description": "string",
                "values": ["string"],
            }],
            "schema_id": "string",
            "type_name": "string",
        }],
    }],
    template_parameters=[{
        "name": "string",
        "required": False,
        "type": "string",
        "default_value": "string",
        "description": "string",
        "values": ["string"],
    }])

    const apiOperationResource = new azure.apimanagement.ApiOperation("apiOperationResource", {
    apiManagementName: "string",
    apiName: "string",
    displayName: "string",
    method: "string",
    operationId: "string",
    resourceGroupName: "string",
    urlTemplate: "string",
    description: "string",
    request: {
        description: "string",
        headers: [{
            name: "string",
            required: false,
            type: "string",
            defaultValue: "string",
            description: "string",
            values: ["string"],
        }],
        queryParameters: [{
            name: "string",
            required: false,
            type: "string",
            defaultValue: "string",
            description: "string",
            values: ["string"],
        }],
        representations: [{
            contentType: "string",
            examples: [{
                name: "string",
                description: "string",
                externalValue: "string",
                summary: "string",
                value: "string",
            }],
            formParameters: [{
                name: "string",
                required: false,
                type: "string",
                defaultValue: "string",
                description: "string",
                values: ["string"],
            }],
            schemaId: "string",
            typeName: "string",
        }],
    },
    responses: [{
        statusCode: 0,
        description: "string",
        headers: [{
            name: "string",
            required: false,
            type: "string",
            defaultValue: "string",
            description: "string",
            values: ["string"],
        }],
        representations: [{
            contentType: "string",
            examples: [{
                name: "string",
                description: "string",
                externalValue: "string",
                summary: "string",
                value: "string",
            }],
            formParameters: [{
                name: "string",
                required: false,
                type: "string",
                defaultValue: "string",
                description: "string",
                values: ["string"],
            }],
            schemaId: "string",
            typeName: "string",
        }],
    }],
    templateParameters: [{
        name: "string",
        required: false,
        type: "string",
        defaultValue: "string",
        description: "string",
        values: ["string"],
    }],
});

    type: azure:apimanagement:ApiOperation
properties:
    apiManagementName: string
    apiName: string
    description: string
    displayName: string
    method: string
    operationId: string
    request:
        description: string
        headers:
            - defaultValue: string
              description: string
              name: string
              required: false
              type: string
              values:
                - string
        queryParameters:
            - defaultValue: string
              description: string
              name: string
              required: false
              type: string
              values:
                - string
        representations:
            - contentType: string
              examples:
                - description: string
                  externalValue: string
                  name: string
                  summary: string
                  value: string
              formParameters:
                - defaultValue: string
                  description: string
                  name: string
                  required: false
                  type: string
                  values:
                    - string
              schemaId: string
              typeName: string
    resourceGroupName: string
    responses:
        - description: string
          headers:
            - defaultValue: string
              description: string
              name: string
              required: false
              type: string
              values:
                - string
          representations:
            - contentType: string
              examples:
                - description: string
                  externalValue: string
                  name: string
                  summary: string
                  value: string
              formParameters:
                - defaultValue: string
                  description: string
                  name: string
                  required: false
                  type: string
                  values:
                    - string
              schemaId: string
              typeName: string
          statusCode: 0
    templateParameters:
        - defaultValue: string
          description: string
          name: string
          required: false
          type: string
          values:
            - string
    urlTemplate: string

    ApiOperation Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ApiOperation resource accepts the following input properties:

    ApiManagementName string
    The Name of the API Management Service where the API exists. Changing this forces a new resource to be created.
    ApiName 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.
    DisplayName string
    The Display Name for this API Management Operation.
    Method string
    The HTTP Method used for this API Management Operation, like GET, DELETE, PUT or POST - but not limited to these values.
    OperationId string
    A unique identifier for this API Operation. Changing this forces a new resource to be created.
    ResourceGroupName string
    The Name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
    UrlTemplate string
    The relative URL Template identifying the target resource for this operation, which may include parameters.
    Description string
    A description for this API Operation, which may include HTML formatting tags.
    Request ApiOperationRequest
    A request block as defined below.
    Responses List<ApiOperationResponse>
    One or more response blocks as defined below.
    TemplateParameters List<ApiOperationTemplateParameter>
    One or more template_parameter blocks as defined below.
    ApiManagementName string
    The Name of the API Management Service where the API exists. Changing this forces a new resource to be created.
    ApiName 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.
    DisplayName string
    The Display Name for this API Management Operation.
    Method string
    The HTTP Method used for this API Management Operation, like GET, DELETE, PUT or POST - but not limited to these values.
    OperationId string
    A unique identifier for this API Operation. Changing this forces a new resource to be created.
    ResourceGroupName string
    The Name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
    UrlTemplate string
    The relative URL Template identifying the target resource for this operation, which may include parameters.
    Description string
    A description for this API Operation, which may include HTML formatting tags.
    Request ApiOperationRequestArgs
    A request block as defined below.
    Responses []ApiOperationResponseArgs
    One or more response blocks as defined below.
    TemplateParameters []ApiOperationTemplateParameterArgs
    One or more template_parameter blocks as defined below.
    apiManagementName String
    The Name of the API Management Service where the API exists. Changing this forces a new resource to be created.
    apiName 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.
    displayName String
    The Display Name for this API Management Operation.
    method String
    The HTTP Method used for this API Management Operation, like GET, DELETE, PUT or POST - but not limited to these values.
    operationId String
    A unique identifier for this API Operation. Changing this forces a new resource to be created.
    resourceGroupName String
    The Name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
    urlTemplate String
    The relative URL Template identifying the target resource for this operation, which may include parameters.
    description String
    A description for this API Operation, which may include HTML formatting tags.
    request ApiOperationRequest
    A request block as defined below.
    responses List<ApiOperationResponse>
    One or more response blocks as defined below.
    templateParameters List<ApiOperationTemplateParameter>
    One or more template_parameter blocks as defined below.
    apiManagementName string
    The Name of the API Management Service where the API exists. Changing this forces a new resource to be created.
    apiName 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.
    displayName string
    The Display Name for this API Management Operation.
    method string
    The HTTP Method used for this API Management Operation, like GET, DELETE, PUT or POST - but not limited to these values.
    operationId string
    A unique identifier for this API Operation. Changing this forces a new resource to be created.
    resourceGroupName string
    The Name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
    urlTemplate string
    The relative URL Template identifying the target resource for this operation, which may include parameters.
    description string
    A description for this API Operation, which may include HTML formatting tags.
    request ApiOperationRequest
    A request block as defined below.
    responses ApiOperationResponse[]
    One or more response blocks as defined below.
    templateParameters ApiOperationTemplateParameter[]
    One or more template_parameter blocks as defined below.
    api_management_name str
    The Name of the API Management Service where the API exists. Changing this forces a new resource to be created.
    api_name str
    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.
    display_name str
    The Display Name for this API Management Operation.
    method str
    The HTTP Method used for this API Management Operation, like GET, DELETE, PUT or POST - but not limited to these values.
    operation_id str
    A unique identifier for this API Operation. Changing this forces a new resource to be created.
    resource_group_name str
    The Name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
    url_template str
    The relative URL Template identifying the target resource for this operation, which may include parameters.
    description str
    A description for this API Operation, which may include HTML formatting tags.
    request ApiOperationRequestArgs
    A request block as defined below.
    responses Sequence[ApiOperationResponseArgs]
    One or more response blocks as defined below.
    template_parameters Sequence[ApiOperationTemplateParameterArgs]
    One or more template_parameter blocks as defined below.
    apiManagementName String
    The Name of the API Management Service where the API exists. Changing this forces a new resource to be created.
    apiName 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.
    displayName String
    The Display Name for this API Management Operation.
    method String
    The HTTP Method used for this API Management Operation, like GET, DELETE, PUT or POST - but not limited to these values.
    operationId String
    A unique identifier for this API Operation. Changing this forces a new resource to be created.
    resourceGroupName String
    The Name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
    urlTemplate String
    The relative URL Template identifying the target resource for this operation, which may include parameters.
    description String
    A description for this API Operation, which may include HTML formatting tags.
    request Property Map
    A request block as defined below.
    responses List<Property Map>
    One or more response blocks as defined below.
    templateParameters List<Property Map>
    One or more template_parameter blocks as defined below.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ApiOperation resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ApiOperation Resource

    Get an existing ApiOperation resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ApiOperationState, opts?: CustomResourceOptions): ApiOperation
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_management_name: Optional[str] = None,
        api_name: Optional[str] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        method: Optional[str] = None,
        operation_id: Optional[str] = None,
        request: Optional[ApiOperationRequestArgs] = None,
        resource_group_name: Optional[str] = None,
        responses: Optional[Sequence[ApiOperationResponseArgs]] = None,
        template_parameters: Optional[Sequence[ApiOperationTemplateParameterArgs]] = None,
        url_template: Optional[str] = None) -> ApiOperation
    func GetApiOperation(ctx *Context, name string, id IDInput, state *ApiOperationState, opts ...ResourceOption) (*ApiOperation, error)
    public static ApiOperation Get(string name, Input<string> id, ApiOperationState? state, CustomResourceOptions? opts = null)
    public static ApiOperation get(String name, Output<String> id, ApiOperationState state, CustomResourceOptions options)
    resources:  _:    type: azure:apimanagement:ApiOperation    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    ApiManagementName string
    The Name of the API Management Service where the API exists. Changing this forces a new resource to be created.
    ApiName 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.
    Description string
    A description for this API Operation, which may include HTML formatting tags.
    DisplayName string
    The Display Name for this API Management Operation.
    Method string
    The HTTP Method used for this API Management Operation, like GET, DELETE, PUT or POST - but not limited to these values.
    OperationId string
    A unique identifier for this API Operation. Changing this forces a new resource to be created.
    Request ApiOperationRequest
    A request block as defined below.
    ResourceGroupName string
    The Name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
    Responses List<ApiOperationResponse>
    One or more response blocks as defined below.
    TemplateParameters List<ApiOperationTemplateParameter>
    One or more template_parameter blocks as defined below.
    UrlTemplate string
    The relative URL Template identifying the target resource for this operation, which may include parameters.
    ApiManagementName string
    The Name of the API Management Service where the API exists. Changing this forces a new resource to be created.
    ApiName 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.
    Description string
    A description for this API Operation, which may include HTML formatting tags.
    DisplayName string
    The Display Name for this API Management Operation.
    Method string
    The HTTP Method used for this API Management Operation, like GET, DELETE, PUT or POST - but not limited to these values.
    OperationId string
    A unique identifier for this API Operation. Changing this forces a new resource to be created.
    Request ApiOperationRequestArgs
    A request block as defined below.
    ResourceGroupName string
    The Name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
    Responses []ApiOperationResponseArgs
    One or more response blocks as defined below.
    TemplateParameters []ApiOperationTemplateParameterArgs
    One or more template_parameter blocks as defined below.
    UrlTemplate string
    The relative URL Template identifying the target resource for this operation, which may include parameters.
    apiManagementName String
    The Name of the API Management Service where the API exists. Changing this forces a new resource to be created.
    apiName 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.
    description String
    A description for this API Operation, which may include HTML formatting tags.
    displayName String
    The Display Name for this API Management Operation.
    method String
    The HTTP Method used for this API Management Operation, like GET, DELETE, PUT or POST - but not limited to these values.
    operationId String
    A unique identifier for this API Operation. Changing this forces a new resource to be created.
    request ApiOperationRequest
    A request block as defined below.
    resourceGroupName String
    The Name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
    responses List<ApiOperationResponse>
    One or more response blocks as defined below.
    templateParameters List<ApiOperationTemplateParameter>
    One or more template_parameter blocks as defined below.
    urlTemplate String
    The relative URL Template identifying the target resource for this operation, which may include parameters.
    apiManagementName string
    The Name of the API Management Service where the API exists. Changing this forces a new resource to be created.
    apiName 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.
    description string
    A description for this API Operation, which may include HTML formatting tags.
    displayName string
    The Display Name for this API Management Operation.
    method string
    The HTTP Method used for this API Management Operation, like GET, DELETE, PUT or POST - but not limited to these values.
    operationId string
    A unique identifier for this API Operation. Changing this forces a new resource to be created.
    request ApiOperationRequest
    A request block as defined below.
    resourceGroupName string
    The Name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
    responses ApiOperationResponse[]
    One or more response blocks as defined below.
    templateParameters ApiOperationTemplateParameter[]
    One or more template_parameter blocks as defined below.
    urlTemplate string
    The relative URL Template identifying the target resource for this operation, which may include parameters.
    api_management_name str
    The Name of the API Management Service where the API exists. Changing this forces a new resource to be created.
    api_name str
    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.
    description str
    A description for this API Operation, which may include HTML formatting tags.
    display_name str
    The Display Name for this API Management Operation.
    method str
    The HTTP Method used for this API Management Operation, like GET, DELETE, PUT or POST - but not limited to these values.
    operation_id str
    A unique identifier for this API Operation. Changing this forces a new resource to be created.
    request ApiOperationRequestArgs
    A request block as defined below.
    resource_group_name str
    The Name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
    responses Sequence[ApiOperationResponseArgs]
    One or more response blocks as defined below.
    template_parameters Sequence[ApiOperationTemplateParameterArgs]
    One or more template_parameter blocks as defined below.
    url_template str
    The relative URL Template identifying the target resource for this operation, which may include parameters.
    apiManagementName String
    The Name of the API Management Service where the API exists. Changing this forces a new resource to be created.
    apiName 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.
    description String
    A description for this API Operation, which may include HTML formatting tags.
    displayName String
    The Display Name for this API Management Operation.
    method String
    The HTTP Method used for this API Management Operation, like GET, DELETE, PUT or POST - but not limited to these values.
    operationId String
    A unique identifier for this API Operation. Changing this forces a new resource to be created.
    request Property Map
    A request block as defined below.
    resourceGroupName String
    The Name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
    responses List<Property Map>
    One or more response blocks as defined below.
    templateParameters List<Property Map>
    One or more template_parameter blocks as defined below.
    urlTemplate String
    The relative URL Template identifying the target resource for this operation, which may include parameters.

    Supporting Types

    ApiOperationRequest, ApiOperationRequestArgs

    Description string
    A description of the HTTP Request, which may include HTML tags.
    Headers List<ApiOperationRequestHeader>
    One or more header blocks as defined above.
    QueryParameters List<ApiOperationRequestQueryParameter>
    One or more query_parameter blocks as defined above.
    Representations List<ApiOperationRequestRepresentation>
    One or more representation blocks as defined below.
    Description string
    A description of the HTTP Request, which may include HTML tags.
    Headers []ApiOperationRequestHeader
    One or more header blocks as defined above.
    QueryParameters []ApiOperationRequestQueryParameter
    One or more query_parameter blocks as defined above.
    Representations []ApiOperationRequestRepresentation
    One or more representation blocks as defined below.
    description String
    A description of the HTTP Request, which may include HTML tags.
    headers List<ApiOperationRequestHeader>
    One or more header blocks as defined above.
    queryParameters List<ApiOperationRequestQueryParameter>
    One or more query_parameter blocks as defined above.
    representations List<ApiOperationRequestRepresentation>
    One or more representation blocks as defined below.
    description string
    A description of the HTTP Request, which may include HTML tags.
    headers ApiOperationRequestHeader[]
    One or more header blocks as defined above.
    queryParameters ApiOperationRequestQueryParameter[]
    One or more query_parameter blocks as defined above.
    representations ApiOperationRequestRepresentation[]
    One or more representation blocks as defined below.
    description str
    A description of the HTTP Request, which may include HTML tags.
    headers Sequence[ApiOperationRequestHeader]
    One or more header blocks as defined above.
    query_parameters Sequence[ApiOperationRequestQueryParameter]
    One or more query_parameter blocks as defined above.
    representations Sequence[ApiOperationRequestRepresentation]
    One or more representation blocks as defined below.
    description String
    A description of the HTTP Request, which may include HTML tags.
    headers List<Property Map>
    One or more header blocks as defined above.
    queryParameters List<Property Map>
    One or more query_parameter blocks as defined above.
    representations List<Property Map>
    One or more representation blocks as defined below.

    ApiOperationRequestHeader, ApiOperationRequestHeaderArgs

    Name string
    The Name of this Header.
    Required bool
    Is this Header Required?
    Type string
    The Type of this Header, such as a string.
    DefaultValue string
    The default value for this Header.
    Description string
    A description of this Header.
    Values List<string>
    One or more acceptable values for this Header.
    Name string
    The Name of this Header.
    Required bool
    Is this Header Required?
    Type string
    The Type of this Header, such as a string.
    DefaultValue string
    The default value for this Header.
    Description string
    A description of this Header.
    Values []string
    One or more acceptable values for this Header.
    name String
    The Name of this Header.
    required Boolean
    Is this Header Required?
    type String
    The Type of this Header, such as a string.
    defaultValue String
    The default value for this Header.
    description String
    A description of this Header.
    values List<String>
    One or more acceptable values for this Header.
    name string
    The Name of this Header.
    required boolean
    Is this Header Required?
    type string
    The Type of this Header, such as a string.
    defaultValue string
    The default value for this Header.
    description string
    A description of this Header.
    values string[]
    One or more acceptable values for this Header.
    name str
    The Name of this Header.
    required bool
    Is this Header Required?
    type str
    The Type of this Header, such as a string.
    default_value str
    The default value for this Header.
    description str
    A description of this Header.
    values Sequence[str]
    One or more acceptable values for this Header.
    name String
    The Name of this Header.
    required Boolean
    Is this Header Required?
    type String
    The Type of this Header, such as a string.
    defaultValue String
    The default value for this Header.
    description String
    A description of this Header.
    values List<String>
    One or more acceptable values for this Header.

    ApiOperationRequestQueryParameter, ApiOperationRequestQueryParameterArgs

    Name string
    The Name of this Query Parameter.
    Required bool
    Is this Query Parameter Required?
    Type string
    The Type of this Query Parameter, such as a string.
    DefaultValue string
    The default value for this Query Parameter.
    Description string
    A description of this Query Parameter.
    Values List<string>
    One or more acceptable values for this Query Parameter.
    Name string
    The Name of this Query Parameter.
    Required bool
    Is this Query Parameter Required?
    Type string
    The Type of this Query Parameter, such as a string.
    DefaultValue string
    The default value for this Query Parameter.
    Description string
    A description of this Query Parameter.
    Values []string
    One or more acceptable values for this Query Parameter.
    name String
    The Name of this Query Parameter.
    required Boolean
    Is this Query Parameter Required?
    type String
    The Type of this Query Parameter, such as a string.
    defaultValue String
    The default value for this Query Parameter.
    description String
    A description of this Query Parameter.
    values List<String>
    One or more acceptable values for this Query Parameter.
    name string
    The Name of this Query Parameter.
    required boolean
    Is this Query Parameter Required?
    type string
    The Type of this Query Parameter, such as a string.
    defaultValue string
    The default value for this Query Parameter.
    description string
    A description of this Query Parameter.
    values string[]
    One or more acceptable values for this Query Parameter.
    name str
    The Name of this Query Parameter.
    required bool
    Is this Query Parameter Required?
    type str
    The Type of this Query Parameter, such as a string.
    default_value str
    The default value for this Query Parameter.
    description str
    A description of this Query Parameter.
    values Sequence[str]
    One or more acceptable values for this Query Parameter.
    name String
    The Name of this Query Parameter.
    required Boolean
    Is this Query Parameter Required?
    type String
    The Type of this Query Parameter, such as a string.
    defaultValue String
    The default value for this Query Parameter.
    description String
    A description of this Query Parameter.
    values List<String>
    One or more acceptable values for this Query Parameter.

    ApiOperationRequestRepresentation, ApiOperationRequestRepresentationArgs

    ContentType string
    The Content Type of this representation, such as application/json.
    Examples List<ApiOperationRequestRepresentationExample>
    One or more example blocks as defined above.
    FormParameters List<ApiOperationRequestRepresentationFormParameter>
    One or more form_parameter block as defined above.
    Sample string
    An example of this representation.

    Deprecated: Deprecated in favour of example

    SchemaId string
    The ID of an API Management Schema which represents this Response.
    TypeName string
    The Type Name defined by the Schema.
    ContentType string
    The Content Type of this representation, such as application/json.
    Examples []ApiOperationRequestRepresentationExample
    One or more example blocks as defined above.
    FormParameters []ApiOperationRequestRepresentationFormParameter
    One or more form_parameter block as defined above.
    Sample string
    An example of this representation.

    Deprecated: Deprecated in favour of example

    SchemaId string
    The ID of an API Management Schema which represents this Response.
    TypeName string
    The Type Name defined by the Schema.
    contentType String
    The Content Type of this representation, such as application/json.
    examples List<ApiOperationRequestRepresentationExample>
    One or more example blocks as defined above.
    formParameters List<ApiOperationRequestRepresentationFormParameter>
    One or more form_parameter block as defined above.
    sample String
    An example of this representation.

    Deprecated: Deprecated in favour of example

    schemaId String
    The ID of an API Management Schema which represents this Response.
    typeName String
    The Type Name defined by the Schema.
    contentType string
    The Content Type of this representation, such as application/json.
    examples ApiOperationRequestRepresentationExample[]
    One or more example blocks as defined above.
    formParameters ApiOperationRequestRepresentationFormParameter[]
    One or more form_parameter block as defined above.
    sample string
    An example of this representation.

    Deprecated: Deprecated in favour of example

    schemaId string
    The ID of an API Management Schema which represents this Response.
    typeName string
    The Type Name defined by the Schema.
    content_type str
    The Content Type of this representation, such as application/json.
    examples Sequence[ApiOperationRequestRepresentationExample]
    One or more example blocks as defined above.
    form_parameters Sequence[ApiOperationRequestRepresentationFormParameter]
    One or more form_parameter block as defined above.
    sample str
    An example of this representation.

    Deprecated: Deprecated in favour of example

    schema_id str
    The ID of an API Management Schema which represents this Response.
    type_name str
    The Type Name defined by the Schema.
    contentType String
    The Content Type of this representation, such as application/json.
    examples List<Property Map>
    One or more example blocks as defined above.
    formParameters List<Property Map>
    One or more form_parameter block as defined above.
    sample String
    An example of this representation.

    Deprecated: Deprecated in favour of example

    schemaId String
    The ID of an API Management Schema which represents this Response.
    typeName String
    The Type Name defined by the Schema.

    ApiOperationRequestRepresentationExample, ApiOperationRequestRepresentationExampleArgs

    Name string
    The name of this example.
    Description string
    A long description for this example.
    ExternalValue string
    A URL that points to the literal example.
    Summary string
    A short description for this example.
    Value string
    The example of the representation.
    Name string
    The name of this example.
    Description string
    A long description for this example.
    ExternalValue string
    A URL that points to the literal example.
    Summary string
    A short description for this example.
    Value string
    The example of the representation.
    name String
    The name of this example.
    description String
    A long description for this example.
    externalValue String
    A URL that points to the literal example.
    summary String
    A short description for this example.
    value String
    The example of the representation.
    name string
    The name of this example.
    description string
    A long description for this example.
    externalValue string
    A URL that points to the literal example.
    summary string
    A short description for this example.
    value string
    The example of the representation.
    name str
    The name of this example.
    description str
    A long description for this example.
    external_value str
    A URL that points to the literal example.
    summary str
    A short description for this example.
    value str
    The example of the representation.
    name String
    The name of this example.
    description String
    A long description for this example.
    externalValue String
    A URL that points to the literal example.
    summary String
    A short description for this example.
    value String
    The example of the representation.

    ApiOperationRequestRepresentationFormParameter, ApiOperationRequestRepresentationFormParameterArgs

    Name string
    The Name of this Form Parameter.
    Required bool
    Is this Form Parameter Required?
    Type string
    The Type of this Form Parameter, such as a string.
    DefaultValue string
    The default value for this Form Parameter.
    Description string
    A description of this Form Parameter.
    Values List<string>
    One or more acceptable values for this Form Parameter.
    Name string
    The Name of this Form Parameter.
    Required bool
    Is this Form Parameter Required?
    Type string
    The Type of this Form Parameter, such as a string.
    DefaultValue string
    The default value for this Form Parameter.
    Description string
    A description of this Form Parameter.
    Values []string
    One or more acceptable values for this Form Parameter.
    name String
    The Name of this Form Parameter.
    required Boolean
    Is this Form Parameter Required?
    type String
    The Type of this Form Parameter, such as a string.
    defaultValue String
    The default value for this Form Parameter.
    description String
    A description of this Form Parameter.
    values List<String>
    One or more acceptable values for this Form Parameter.
    name string
    The Name of this Form Parameter.
    required boolean
    Is this Form Parameter Required?
    type string
    The Type of this Form Parameter, such as a string.
    defaultValue string
    The default value for this Form Parameter.
    description string
    A description of this Form Parameter.
    values string[]
    One or more acceptable values for this Form Parameter.
    name str
    The Name of this Form Parameter.
    required bool
    Is this Form Parameter Required?
    type str
    The Type of this Form Parameter, such as a string.
    default_value str
    The default value for this Form Parameter.
    description str
    A description of this Form Parameter.
    values Sequence[str]
    One or more acceptable values for this Form Parameter.
    name String
    The Name of this Form Parameter.
    required Boolean
    Is this Form Parameter Required?
    type String
    The Type of this Form Parameter, such as a string.
    defaultValue String
    The default value for this Form Parameter.
    description String
    A description of this Form Parameter.
    values List<String>
    One or more acceptable values for this Form Parameter.

    ApiOperationResponse, ApiOperationResponseArgs

    StatusCode int
    The HTTP Status Code.
    Description string
    A description of the HTTP Response, which may include HTML tags.
    Headers List<ApiOperationResponseHeader>
    One or more header blocks as defined above.
    Representations List<ApiOperationResponseRepresentation>
    One or more representation blocks as defined below.
    StatusCode int
    The HTTP Status Code.
    Description string
    A description of the HTTP Response, which may include HTML tags.
    Headers []ApiOperationResponseHeader
    One or more header blocks as defined above.
    Representations []ApiOperationResponseRepresentation
    One or more representation blocks as defined below.
    statusCode Integer
    The HTTP Status Code.
    description String
    A description of the HTTP Response, which may include HTML tags.
    headers List<ApiOperationResponseHeader>
    One or more header blocks as defined above.
    representations List<ApiOperationResponseRepresentation>
    One or more representation blocks as defined below.
    statusCode number
    The HTTP Status Code.
    description string
    A description of the HTTP Response, which may include HTML tags.
    headers ApiOperationResponseHeader[]
    One or more header blocks as defined above.
    representations ApiOperationResponseRepresentation[]
    One or more representation blocks as defined below.
    status_code int
    The HTTP Status Code.
    description str
    A description of the HTTP Response, which may include HTML tags.
    headers Sequence[ApiOperationResponseHeader]
    One or more header blocks as defined above.
    representations Sequence[ApiOperationResponseRepresentation]
    One or more representation blocks as defined below.
    statusCode Number
    The HTTP Status Code.
    description String
    A description of the HTTP Response, which may include HTML tags.
    headers List<Property Map>
    One or more header blocks as defined above.
    representations List<Property Map>
    One or more representation blocks as defined below.

    ApiOperationResponseHeader, ApiOperationResponseHeaderArgs

    Name string
    The Name of this Header.
    Required bool
    Is this Header Required?
    Type string
    The Type of this Header, such as a string.
    DefaultValue string
    The default value for this Header.
    Description string
    A description of this Header.
    Values List<string>
    One or more acceptable values for this Header.
    Name string
    The Name of this Header.
    Required bool
    Is this Header Required?
    Type string
    The Type of this Header, such as a string.
    DefaultValue string
    The default value for this Header.
    Description string
    A description of this Header.
    Values []string
    One or more acceptable values for this Header.
    name String
    The Name of this Header.
    required Boolean
    Is this Header Required?
    type String
    The Type of this Header, such as a string.
    defaultValue String
    The default value for this Header.
    description String
    A description of this Header.
    values List<String>
    One or more acceptable values for this Header.
    name string
    The Name of this Header.
    required boolean
    Is this Header Required?
    type string
    The Type of this Header, such as a string.
    defaultValue string
    The default value for this Header.
    description string
    A description of this Header.
    values string[]
    One or more acceptable values for this Header.
    name str
    The Name of this Header.
    required bool
    Is this Header Required?
    type str
    The Type of this Header, such as a string.
    default_value str
    The default value for this Header.
    description str
    A description of this Header.
    values Sequence[str]
    One or more acceptable values for this Header.
    name String
    The Name of this Header.
    required Boolean
    Is this Header Required?
    type String
    The Type of this Header, such as a string.
    defaultValue String
    The default value for this Header.
    description String
    A description of this Header.
    values List<String>
    One or more acceptable values for this Header.

    ApiOperationResponseRepresentation, ApiOperationResponseRepresentationArgs

    ContentType string
    The Content Type of this representation, such as application/json.
    Examples List<ApiOperationResponseRepresentationExample>
    One or more example blocks as defined above.
    FormParameters List<ApiOperationResponseRepresentationFormParameter>
    One or more form_parameter block as defined above.
    Sample string
    An example of this representation.

    Deprecated: Deprecated in favour of example

    SchemaId string
    The ID of an API Management Schema which represents this Response.
    TypeName string
    The Type Name defined by the Schema.
    ContentType string
    The Content Type of this representation, such as application/json.
    Examples []ApiOperationResponseRepresentationExample
    One or more example blocks as defined above.
    FormParameters []ApiOperationResponseRepresentationFormParameter
    One or more form_parameter block as defined above.
    Sample string
    An example of this representation.

    Deprecated: Deprecated in favour of example

    SchemaId string
    The ID of an API Management Schema which represents this Response.
    TypeName string
    The Type Name defined by the Schema.
    contentType String
    The Content Type of this representation, such as application/json.
    examples List<ApiOperationResponseRepresentationExample>
    One or more example blocks as defined above.
    formParameters List<ApiOperationResponseRepresentationFormParameter>
    One or more form_parameter block as defined above.
    sample String
    An example of this representation.

    Deprecated: Deprecated in favour of example

    schemaId String
    The ID of an API Management Schema which represents this Response.
    typeName String
    The Type Name defined by the Schema.
    contentType string
    The Content Type of this representation, such as application/json.
    examples ApiOperationResponseRepresentationExample[]
    One or more example blocks as defined above.
    formParameters ApiOperationResponseRepresentationFormParameter[]
    One or more form_parameter block as defined above.
    sample string
    An example of this representation.

    Deprecated: Deprecated in favour of example

    schemaId string
    The ID of an API Management Schema which represents this Response.
    typeName string
    The Type Name defined by the Schema.
    content_type str
    The Content Type of this representation, such as application/json.
    examples Sequence[ApiOperationResponseRepresentationExample]
    One or more example blocks as defined above.
    form_parameters Sequence[ApiOperationResponseRepresentationFormParameter]
    One or more form_parameter block as defined above.
    sample str
    An example of this representation.

    Deprecated: Deprecated in favour of example

    schema_id str
    The ID of an API Management Schema which represents this Response.
    type_name str
    The Type Name defined by the Schema.
    contentType String
    The Content Type of this representation, such as application/json.
    examples List<Property Map>
    One or more example blocks as defined above.
    formParameters List<Property Map>
    One or more form_parameter block as defined above.
    sample String
    An example of this representation.

    Deprecated: Deprecated in favour of example

    schemaId String
    The ID of an API Management Schema which represents this Response.
    typeName String
    The Type Name defined by the Schema.

    ApiOperationResponseRepresentationExample, ApiOperationResponseRepresentationExampleArgs

    Name string
    The name of this example.
    Description string
    A long description for this example.
    ExternalValue string
    A URL that points to the literal example.
    Summary string
    A short description for this example.
    Value string
    The example of the representation.
    Name string
    The name of this example.
    Description string
    A long description for this example.
    ExternalValue string
    A URL that points to the literal example.
    Summary string
    A short description for this example.
    Value string
    The example of the representation.
    name String
    The name of this example.
    description String
    A long description for this example.
    externalValue String
    A URL that points to the literal example.
    summary String
    A short description for this example.
    value String
    The example of the representation.
    name string
    The name of this example.
    description string
    A long description for this example.
    externalValue string
    A URL that points to the literal example.
    summary string
    A short description for this example.
    value string
    The example of the representation.
    name str
    The name of this example.
    description str
    A long description for this example.
    external_value str
    A URL that points to the literal example.
    summary str
    A short description for this example.
    value str
    The example of the representation.
    name String
    The name of this example.
    description String
    A long description for this example.
    externalValue String
    A URL that points to the literal example.
    summary String
    A short description for this example.
    value String
    The example of the representation.

    ApiOperationResponseRepresentationFormParameter, ApiOperationResponseRepresentationFormParameterArgs

    Name string
    The Name of this Form Parameter.
    Required bool
    Is this Form Parameter Required?
    Type string
    The Type of this Form Parameter, such as a string.
    DefaultValue string
    The default value for this Form Parameter.
    Description string
    A description of this Form Parameter.
    Values List<string>
    One or more acceptable values for this Form Parameter.
    Name string
    The Name of this Form Parameter.
    Required bool
    Is this Form Parameter Required?
    Type string
    The Type of this Form Parameter, such as a string.
    DefaultValue string
    The default value for this Form Parameter.
    Description string
    A description of this Form Parameter.
    Values []string
    One or more acceptable values for this Form Parameter.
    name String
    The Name of this Form Parameter.
    required Boolean
    Is this Form Parameter Required?
    type String
    The Type of this Form Parameter, such as a string.
    defaultValue String
    The default value for this Form Parameter.
    description String
    A description of this Form Parameter.
    values List<String>
    One or more acceptable values for this Form Parameter.
    name string
    The Name of this Form Parameter.
    required boolean
    Is this Form Parameter Required?
    type string
    The Type of this Form Parameter, such as a string.
    defaultValue string
    The default value for this Form Parameter.
    description string
    A description of this Form Parameter.
    values string[]
    One or more acceptable values for this Form Parameter.
    name str
    The Name of this Form Parameter.
    required bool
    Is this Form Parameter Required?
    type str
    The Type of this Form Parameter, such as a string.
    default_value str
    The default value for this Form Parameter.
    description str
    A description of this Form Parameter.
    values Sequence[str]
    One or more acceptable values for this Form Parameter.
    name String
    The Name of this Form Parameter.
    required Boolean
    Is this Form Parameter Required?
    type String
    The Type of this Form Parameter, such as a string.
    defaultValue String
    The default value for this Form Parameter.
    description String
    A description of this Form Parameter.
    values List<String>
    One or more acceptable values for this Form Parameter.

    ApiOperationTemplateParameter, ApiOperationTemplateParameterArgs

    Name string
    The Name of this Template Parameter.
    Required bool
    Is this Template Parameter Required?
    Type string
    The Type of this Template Parameter, such as a string.
    DefaultValue string
    The default value for this Template Parameter.
    Description string
    A description of this Template Parameter.
    Values List<string>
    One or more acceptable values for this Template Parameter.
    Name string
    The Name of this Template Parameter.
    Required bool
    Is this Template Parameter Required?
    Type string
    The Type of this Template Parameter, such as a string.
    DefaultValue string
    The default value for this Template Parameter.
    Description string
    A description of this Template Parameter.
    Values []string
    One or more acceptable values for this Template Parameter.
    name String
    The Name of this Template Parameter.
    required Boolean
    Is this Template Parameter Required?
    type String
    The Type of this Template Parameter, such as a string.
    defaultValue String
    The default value for this Template Parameter.
    description String
    A description of this Template Parameter.
    values List<String>
    One or more acceptable values for this Template Parameter.
    name string
    The Name of this Template Parameter.
    required boolean
    Is this Template Parameter Required?
    type string
    The Type of this Template Parameter, such as a string.
    defaultValue string
    The default value for this Template Parameter.
    description string
    A description of this Template Parameter.
    values string[]
    One or more acceptable values for this Template Parameter.
    name str
    The Name of this Template Parameter.
    required bool
    Is this Template Parameter Required?
    type str
    The Type of this Template Parameter, such as a string.
    default_value str
    The default value for this Template Parameter.
    description str
    A description of this Template Parameter.
    values Sequence[str]
    One or more acceptable values for this Template Parameter.
    name String
    The Name of this Template Parameter.
    required Boolean
    Is this Template Parameter Required?
    type String
    The Type of this Template Parameter, such as a string.
    defaultValue String
    The default value for this Template Parameter.
    description String
    A description of this Template Parameter.
    values List<String>
    One or more acceptable values for this Template Parameter.

    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

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Viewing docs for Azure v4.42.0 (Older version)
    published on Monday, Mar 9, 2026 by Pulumi
    Go to latest version
    Schema (JSON)
    pulumi/pulumi-azure

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial