Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v1
  3. API Docs
  4. apimanagement
  5. ApiOperation
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

azure-native.apimanagement.ApiOperation

Explore with Pulumi AI

azure-native-v1 logo
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

    Api Operation details. API Version: 2020-12-01.

    Example Usage

    ApiManagementCreateApiOperation

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var apiOperation = new AzureNative.ApiManagement.ApiOperation("apiOperation", new()
    {
        ApiId = "PetStoreTemplate2",
        Description = "This can only be done by the logged in user.",
        DisplayName = "createUser2",
        Method = "POST",
        OperationId = "newoperations",
        Request = new AzureNative.ApiManagement.Inputs.RequestContractArgs
        {
            Description = "Created user object",
            Headers = new[] {},
            QueryParameters = new[] {},
            Representations = new[]
            {
                new AzureNative.ApiManagement.Inputs.RepresentationContractArgs
                {
                    ContentType = "application/json",
                    SchemaId = "592f6c1d0af5840ca8897f0c",
                    TypeName = "User",
                },
            },
        },
        ResourceGroupName = "rg1",
        Responses = new[]
        {
            new AzureNative.ApiManagement.Inputs.ResponseContractArgs
            {
                Description = "successful operation",
                Headers = new[] {},
                Representations = new[]
                {
                    new AzureNative.ApiManagement.Inputs.RepresentationContractArgs
                    {
                        ContentType = "application/xml",
                    },
                    new AzureNative.ApiManagement.Inputs.RepresentationContractArgs
                    {
                        ContentType = "application/json",
                    },
                },
                StatusCode = 200,
            },
        },
        ServiceName = "apimService1",
        TemplateParameters = new[] {},
        UrlTemplate = "/user1",
    });

});

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apimanagement.NewApiOperation(ctx, "apiOperation", &apimanagement.ApiOperationArgs{
			ApiId:       pulumi.String("PetStoreTemplate2"),
			Description: pulumi.String("This can only be done by the logged in user."),
			DisplayName: pulumi.String("createUser2"),
			Method:      pulumi.String("POST"),
			OperationId: pulumi.String("newoperations"),
			Request: apimanagement.RequestContractResponse{
				Description:     pulumi.String("Created user object"),
				Headers:         apimanagement.ParameterContractArray{},
				QueryParameters: apimanagement.ParameterContractArray{},
				Representations: apimanagement.RepresentationContractArray{
					&apimanagement.RepresentationContractArgs{
						ContentType: pulumi.String("application/json"),
						SchemaId:    pulumi.String("592f6c1d0af5840ca8897f0c"),
						TypeName:    pulumi.String("User"),
					},
				},
			},
			ResourceGroupName: pulumi.String("rg1"),
			Responses: []apimanagement.ResponseContractArgs{
				{
					Description: pulumi.String("successful operation"),
					Headers:     apimanagement.ParameterContractArray{},
					Representations: apimanagement.RepresentationContractArray{
						{
							ContentType: pulumi.String("application/xml"),
						},
						{
							ContentType: pulumi.String("application/json"),
						},
					},
					StatusCode: pulumi.Int(200),
				},
			},
			ServiceName:        pulumi.String("apimService1"),
			TemplateParameters: apimanagement.ParameterContractArray{},
			UrlTemplate:        pulumi.String("/user1"),
		})
		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.azurenative.apimanagement.ApiOperation;
import com.pulumi.azurenative.apimanagement.ApiOperationArgs;
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) {
        var apiOperation = new ApiOperation("apiOperation", ApiOperationArgs.builder()        
            .apiId("PetStoreTemplate2")
            .description("This can only be done by the logged in user.")
            .displayName("createUser2")
            .method("POST")
            .operationId("newoperations")
            .request(Map.ofEntries(
                Map.entry("description", "Created user object"),
                Map.entry("headers", ),
                Map.entry("queryParameters", ),
                Map.entry("representations", Map.ofEntries(
                    Map.entry("contentType", "application/json"),
                    Map.entry("schemaId", "592f6c1d0af5840ca8897f0c"),
                    Map.entry("typeName", "User")
                ))
            ))
            .resourceGroupName("rg1")
            .responses(Map.ofEntries(
                Map.entry("description", "successful operation"),
                Map.entry("headers", ),
                Map.entry("representations",                 
                    Map.of("contentType", "application/xml"),
                    Map.of("contentType", "application/json")),
                Map.entry("statusCode", 200)
            ))
            .serviceName("apimService1")
            .templateParameters()
            .urlTemplate("/user1")
            .build());

    }
}

    import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const apiOperation = new azure_native.apimanagement.ApiOperation("apiOperation", {
    apiId: "PetStoreTemplate2",
    description: "This can only be done by the logged in user.",
    displayName: "createUser2",
    method: "POST",
    operationId: "newoperations",
    request: {
        description: "Created user object",
        headers: [],
        queryParameters: [],
        representations: [{
            contentType: "application/json",
            schemaId: "592f6c1d0af5840ca8897f0c",
            typeName: "User",
        }],
    },
    resourceGroupName: "rg1",
    responses: [{
        description: "successful operation",
        headers: [],
        representations: [
            {
                contentType: "application/xml",
            },
            {
                contentType: "application/json",
            },
        ],
        statusCode: 200,
    }],
    serviceName: "apimService1",
    templateParameters: [],
    urlTemplate: "/user1",
});

    import pulumi
import pulumi_azure_native as azure_native

api_operation = azure_native.apimanagement.ApiOperation("apiOperation",
    api_id="PetStoreTemplate2",
    description="This can only be done by the logged in user.",
    display_name="createUser2",
    method="POST",
    operation_id="newoperations",
    request=azure_native.apimanagement.RequestContractResponseArgs(
        description="Created user object",
        headers=[],
        query_parameters=[],
        representations=[azure_native.apimanagement.RepresentationContractArgs(
            content_type="application/json",
            schema_id="592f6c1d0af5840ca8897f0c",
            type_name="User",
        )],
    ),
    resource_group_name="rg1",
    responses=[{
        "description": "successful operation",
        "headers": [],
        "representations": [
            azure_native.apimanagement.RepresentationContractArgs(
                content_type="application/xml",
            ),
            azure_native.apimanagement.RepresentationContractArgs(
                content_type="application/json",
            ),
        ],
        "statusCode": 200,
    }],
    service_name="apimService1",
    template_parameters=[],
    url_template="/user1")

    resources:
  apiOperation:
    type: azure-native:apimanagement:ApiOperation
    properties:
      apiId: PetStoreTemplate2
      description: This can only be done by the logged in user.
      displayName: createUser2
      method: POST
      operationId: newoperations
      request:
        description: Created user object
        headers: []
        queryParameters: []
        representations:
          - contentType: application/json
            schemaId: 592f6c1d0af5840ca8897f0c
            typeName: User
      resourceGroupName: rg1
      responses:
        - description: successful operation
          headers: []
          representations:
            - contentType: application/xml
            - contentType: application/json
          statusCode: 200
      serviceName: apimService1
      templateParameters: []
      urlTemplate: /user1

    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_id: Optional[str] = None,
                 display_name: Optional[str] = None,
                 method: Optional[str] = None,
                 resource_group_name: Optional[str] = None,
                 service_name: Optional[str] = None,
                 url_template: Optional[str] = None,
                 description: Optional[str] = None,
                 operation_id: Optional[str] = None,
                 policies: Optional[str] = None,
                 request: Optional[RequestContractArgs] = None,
                 responses: Optional[Sequence[ResponseContractArgs]] = None,
                 template_parameters: Optional[Sequence[ParameterContractArgs]] = 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-native: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 AzureNative.Apimanagement.ApiOperation("apiOperationResource", new()
{
    ApiId = "string",
    DisplayName = "string",
    Method = "string",
    ResourceGroupName = "string",
    ServiceName = "string",
    UrlTemplate = "string",
    Description = "string",
    OperationId = "string",
    Policies = "string",
    Request = 
    {
        { "description", "string" },
        { "headers", new[]
        {
            
            {
                { "name", "string" },
                { "type", "string" },
                { "defaultValue", "string" },
                { "description", "string" },
                { "required", false },
                { "values", new[]
                {
                    "string",
                } },
            },
        } },
        { "queryParameters", new[]
        {
            
            {
                { "name", "string" },
                { "type", "string" },
                { "defaultValue", "string" },
                { "description", "string" },
                { "required", false },
                { "values", new[]
                {
                    "string",
                } },
            },
        } },
        { "representations", new[]
        {
            
            {
                { "contentType", "string" },
                { "formParameters", new[]
                {
                    
                    {
                        { "name", "string" },
                        { "type", "string" },
                        { "defaultValue", "string" },
                        { "description", "string" },
                        { "required", false },
                        { "values", new[]
                        {
                            "string",
                        } },
                    },
                } },
                { "sample", "string" },
                { "schemaId", "string" },
                { "typeName", "string" },
            },
        } },
    },
    Responses = new[]
    {
        
        {
            { "statusCode", 0 },
            { "description", "string" },
            { "headers", new[]
            {
                
                {
                    { "name", "string" },
                    { "type", "string" },
                    { "defaultValue", "string" },
                    { "description", "string" },
                    { "required", false },
                    { "values", new[]
                    {
                        "string",
                    } },
                },
            } },
            { "representations", new[]
            {
                
                {
                    { "contentType", "string" },
                    { "formParameters", new[]
                    {
                        
                        {
                            { "name", "string" },
                            { "type", "string" },
                            { "defaultValue", "string" },
                            { "description", "string" },
                            { "required", false },
                            { "values", new[]
                            {
                                "string",
                            } },
                        },
                    } },
                    { "sample", "string" },
                    { "schemaId", "string" },
                    { "typeName", "string" },
                },
            } },
        },
    },
    TemplateParameters = new[]
    {
        
        {
            { "name", "string" },
            { "type", "string" },
            { "defaultValue", "string" },
            { "description", "string" },
            { "required", false },
            { "values", new[]
            {
                "string",
            } },
        },
    },
});

    example, err := apimanagement.NewApiOperation(ctx, "apiOperationResource", &apimanagement.ApiOperationArgs{
	ApiId:             "string",
	DisplayName:       "string",
	Method:            "string",
	ResourceGroupName: "string",
	ServiceName:       "string",
	UrlTemplate:       "string",
	Description:       "string",
	OperationId:       "string",
	Policies:          "string",
	Request: map[string]interface{}{
		"description": "string",
		"headers": []map[string]interface{}{
			map[string]interface{}{
				"name":         "string",
				"type":         "string",
				"defaultValue": "string",
				"description":  "string",
				"required":     false,
				"values": []string{
					"string",
				},
			},
		},
		"queryParameters": []map[string]interface{}{
			map[string]interface{}{
				"name":         "string",
				"type":         "string",
				"defaultValue": "string",
				"description":  "string",
				"required":     false,
				"values": []string{
					"string",
				},
			},
		},
		"representations": []map[string]interface{}{
			map[string]interface{}{
				"contentType": "string",
				"formParameters": []map[string]interface{}{
					map[string]interface{}{
						"name":         "string",
						"type":         "string",
						"defaultValue": "string",
						"description":  "string",
						"required":     false,
						"values": []string{
							"string",
						},
					},
				},
				"sample":   "string",
				"schemaId": "string",
				"typeName": "string",
			},
		},
	},
	Responses: []map[string]interface{}{
		map[string]interface{}{
			"statusCode":  0,
			"description": "string",
			"headers": []map[string]interface{}{
				map[string]interface{}{
					"name":         "string",
					"type":         "string",
					"defaultValue": "string",
					"description":  "string",
					"required":     false,
					"values": []string{
						"string",
					},
				},
			},
			"representations": []map[string]interface{}{
				map[string]interface{}{
					"contentType": "string",
					"formParameters": []map[string]interface{}{
						map[string]interface{}{
							"name":         "string",
							"type":         "string",
							"defaultValue": "string",
							"description":  "string",
							"required":     false,
							"values": []string{
								"string",
							},
						},
					},
					"sample":   "string",
					"schemaId": "string",
					"typeName": "string",
				},
			},
		},
	},
	TemplateParameters: []map[string]interface{}{
		map[string]interface{}{
			"name":         "string",
			"type":         "string",
			"defaultValue": "string",
			"description":  "string",
			"required":     false,
			"values": []string{
				"string",
			},
		},
	},
})

    var apiOperationResource = new ApiOperation("apiOperationResource", ApiOperationArgs.builder()
    .apiId("string")
    .displayName("string")
    .method("string")
    .resourceGroupName("string")
    .serviceName("string")
    .urlTemplate("string")
    .description("string")
    .operationId("string")
    .policies("string")
    .request(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .responses(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .templateParameters(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .build());

    api_operation_resource = azure_native.apimanagement.ApiOperation("apiOperationResource",
    api_id=string,
    display_name=string,
    method=string,
    resource_group_name=string,
    service_name=string,
    url_template=string,
    description=string,
    operation_id=string,
    policies=string,
    request={
        description: string,
        headers: [{
            name: string,
            type: string,
            defaultValue: string,
            description: string,
            required: False,
            values: [string],
        }],
        queryParameters: [{
            name: string,
            type: string,
            defaultValue: string,
            description: string,
            required: False,
            values: [string],
        }],
        representations: [{
            contentType: string,
            formParameters: [{
                name: string,
                type: string,
                defaultValue: string,
                description: string,
                required: False,
                values: [string],
            }],
            sample: string,
            schemaId: string,
            typeName: string,
        }],
    },
    responses=[{
        statusCode: 0,
        description: string,
        headers: [{
            name: string,
            type: string,
            defaultValue: string,
            description: string,
            required: False,
            values: [string],
        }],
        representations: [{
            contentType: string,
            formParameters: [{
                name: string,
                type: string,
                defaultValue: string,
                description: string,
                required: False,
                values: [string],
            }],
            sample: string,
            schemaId: string,
            typeName: string,
        }],
    }],
    template_parameters=[{
        name: string,
        type: string,
        defaultValue: string,
        description: string,
        required: False,
        values: [string],
    }])

    const apiOperationResource = new azure_native.apimanagement.ApiOperation("apiOperationResource", {
    apiId: "string",
    displayName: "string",
    method: "string",
    resourceGroupName: "string",
    serviceName: "string",
    urlTemplate: "string",
    description: "string",
    operationId: "string",
    policies: "string",
    request: {
        description: "string",
        headers: [{
            name: "string",
            type: "string",
            defaultValue: "string",
            description: "string",
            required: false,
            values: ["string"],
        }],
        queryParameters: [{
            name: "string",
            type: "string",
            defaultValue: "string",
            description: "string",
            required: false,
            values: ["string"],
        }],
        representations: [{
            contentType: "string",
            formParameters: [{
                name: "string",
                type: "string",
                defaultValue: "string",
                description: "string",
                required: false,
                values: ["string"],
            }],
            sample: "string",
            schemaId: "string",
            typeName: "string",
        }],
    },
    responses: [{
        statusCode: 0,
        description: "string",
        headers: [{
            name: "string",
            type: "string",
            defaultValue: "string",
            description: "string",
            required: false,
            values: ["string"],
        }],
        representations: [{
            contentType: "string",
            formParameters: [{
                name: "string",
                type: "string",
                defaultValue: "string",
                description: "string",
                required: false,
                values: ["string"],
            }],
            sample: "string",
            schemaId: "string",
            typeName: "string",
        }],
    }],
    templateParameters: [{
        name: "string",
        type: "string",
        defaultValue: "string",
        description: "string",
        required: false,
        values: ["string"],
    }],
});

    type: azure-native:apimanagement:ApiOperation
properties:
    apiId: string
    description: string
    displayName: string
    method: string
    operationId: string
    policies: 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
              formParameters:
                - defaultValue: string
                  description: string
                  name: string
                  required: false
                  type: string
                  values:
                    - string
              sample: 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
              formParameters:
                - defaultValue: string
                  description: string
                  name: string
                  required: false
                  type: string
                  values:
                    - string
              sample: string
              schemaId: string
              typeName: string
          statusCode: 0
    serviceName: string
    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:

    ApiId string
    API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
    DisplayName string
    Operation Name.
    Method string
    A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.
    ResourceGroupName string
    The name of the resource group.
    ServiceName string
    The name of the API Management service.
    UrlTemplate string
    Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}
    Description string
    Description of the operation. May include HTML formatting tags.
    OperationId string
    Operation identifier within an API. Must be unique in the current API Management service instance.
    Policies string
    Operation Policies
    Request Pulumi.AzureNative.ApiManagement.Inputs.RequestContract
    An entity containing request details.
    Responses List<Pulumi.AzureNative.ApiManagement.Inputs.ResponseContract>
    Array of Operation responses.
    TemplateParameters List<Pulumi.AzureNative.ApiManagement.Inputs.ParameterContract>
    Collection of URL template parameters.
    ApiId string
    API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
    DisplayName string
    Operation Name.
    Method string
    A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.
    ResourceGroupName string
    The name of the resource group.
    ServiceName string
    The name of the API Management service.
    UrlTemplate string
    Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}
    Description string
    Description of the operation. May include HTML formatting tags.
    OperationId string
    Operation identifier within an API. Must be unique in the current API Management service instance.
    Policies string
    Operation Policies
    Request RequestContractArgs
    An entity containing request details.
    Responses []ResponseContractArgs
    Array of Operation responses.
    TemplateParameters []ParameterContractArgs
    Collection of URL template parameters.
    apiId String
    API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
    displayName String
    Operation Name.
    method String
    A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.
    resourceGroupName String
    The name of the resource group.
    serviceName String
    The name of the API Management service.
    urlTemplate String
    Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}
    description String
    Description of the operation. May include HTML formatting tags.
    operationId String
    Operation identifier within an API. Must be unique in the current API Management service instance.
    policies String
    Operation Policies
    request RequestContract
    An entity containing request details.
    responses List<ResponseContract>
    Array of Operation responses.
    templateParameters List<ParameterContract>
    Collection of URL template parameters.
    apiId string
    API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
    displayName string
    Operation Name.
    method string
    A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.
    resourceGroupName string
    The name of the resource group.
    serviceName string
    The name of the API Management service.
    urlTemplate string
    Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}
    description string
    Description of the operation. May include HTML formatting tags.
    operationId string
    Operation identifier within an API. Must be unique in the current API Management service instance.
    policies string
    Operation Policies
    request RequestContract
    An entity containing request details.
    responses ResponseContract[]
    Array of Operation responses.
    templateParameters ParameterContract[]
    Collection of URL template parameters.
    api_id str
    API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
    display_name str
    Operation Name.
    method str
    A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.
    resource_group_name str
    The name of the resource group.
    service_name str
    The name of the API Management service.
    url_template str
    Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}
    description str
    Description of the operation. May include HTML formatting tags.
    operation_id str
    Operation identifier within an API. Must be unique in the current API Management service instance.
    policies str
    Operation Policies
    request RequestContractArgs
    An entity containing request details.
    responses Sequence[ResponseContractArgs]
    Array of Operation responses.
    template_parameters Sequence[ParameterContractArgs]
    Collection of URL template parameters.
    apiId String
    API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
    displayName String
    Operation Name.
    method String
    A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.
    resourceGroupName String
    The name of the resource group.
    serviceName String
    The name of the API Management service.
    urlTemplate String
    Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}
    description String
    Description of the operation. May include HTML formatting tags.
    operationId String
    Operation identifier within an API. Must be unique in the current API Management service instance.
    policies String
    Operation Policies
    request Property Map
    An entity containing request details.
    responses List<Property Map>
    Array of Operation responses.
    templateParameters List<Property Map>
    Collection of URL template parameters.

    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.
    Name string
    Resource name.
    Type string
    Resource type for API Management resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Resource name.
    Type string
    Resource type for API Management resource.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Resource name.
    type String
    Resource type for API Management resource.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    Resource name.
    type string
    Resource type for API Management resource.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    Resource name.
    type str
    Resource type for API Management resource.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Resource name.
    type String
    Resource type for API Management resource.

    Supporting Types

    ParameterContract, ParameterContractArgs

    Name string
    Parameter name.
    Type string
    Parameter type.
    DefaultValue string
    Default parameter value.
    Description string
    Parameter description.
    Required bool
    Specifies whether parameter is required or not.
    Values List<string>
    Parameter values.
    Name string
    Parameter name.
    Type string
    Parameter type.
    DefaultValue string
    Default parameter value.
    Description string
    Parameter description.
    Required bool
    Specifies whether parameter is required or not.
    Values []string
    Parameter values.
    name String
    Parameter name.
    type String
    Parameter type.
    defaultValue String
    Default parameter value.
    description String
    Parameter description.
    required Boolean
    Specifies whether parameter is required or not.
    values List<String>
    Parameter values.
    name string
    Parameter name.
    type string
    Parameter type.
    defaultValue string
    Default parameter value.
    description string
    Parameter description.
    required boolean
    Specifies whether parameter is required or not.
    values string[]
    Parameter values.
    name str
    Parameter name.
    type str
    Parameter type.
    default_value str
    Default parameter value.
    description str
    Parameter description.
    required bool
    Specifies whether parameter is required or not.
    values Sequence[str]
    Parameter values.
    name String
    Parameter name.
    type String
    Parameter type.
    defaultValue String
    Default parameter value.
    description String
    Parameter description.
    required Boolean
    Specifies whether parameter is required or not.
    values List<String>
    Parameter values.

    ParameterContractResponse, ParameterContractResponseArgs

    Name string
    Parameter name.
    Type string
    Parameter type.
    DefaultValue string
    Default parameter value.
    Description string
    Parameter description.
    Required bool
    Specifies whether parameter is required or not.
    Values List<string>
    Parameter values.
    Name string
    Parameter name.
    Type string
    Parameter type.
    DefaultValue string
    Default parameter value.
    Description string
    Parameter description.
    Required bool
    Specifies whether parameter is required or not.
    Values []string
    Parameter values.
    name String
    Parameter name.
    type String
    Parameter type.
    defaultValue String
    Default parameter value.
    description String
    Parameter description.
    required Boolean
    Specifies whether parameter is required or not.
    values List<String>
    Parameter values.
    name string
    Parameter name.
    type string
    Parameter type.
    defaultValue string
    Default parameter value.
    description string
    Parameter description.
    required boolean
    Specifies whether parameter is required or not.
    values string[]
    Parameter values.
    name str
    Parameter name.
    type str
    Parameter type.
    default_value str
    Default parameter value.
    description str
    Parameter description.
    required bool
    Specifies whether parameter is required or not.
    values Sequence[str]
    Parameter values.
    name String
    Parameter name.
    type String
    Parameter type.
    defaultValue String
    Default parameter value.
    description String
    Parameter description.
    required Boolean
    Specifies whether parameter is required or not.
    values List<String>
    Parameter values.

    RepresentationContract, RepresentationContractArgs

    ContentType string
    Specifies a registered or custom content type for this representation, e.g. application/xml.
    FormParameters List<Pulumi.AzureNative.ApiManagement.Inputs.ParameterContract>
    Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'..
    Sample string
    An example of the representation.
    SchemaId string
    Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.
    TypeName string
    Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.
    ContentType string
    Specifies a registered or custom content type for this representation, e.g. application/xml.
    FormParameters []ParameterContract
    Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'..
    Sample string
    An example of the representation.
    SchemaId string
    Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.
    TypeName string
    Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.
    contentType String
    Specifies a registered or custom content type for this representation, e.g. application/xml.
    formParameters List<ParameterContract>
    Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'..
    sample String
    An example of the representation.
    schemaId String
    Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.
    typeName String
    Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.
    contentType string
    Specifies a registered or custom content type for this representation, e.g. application/xml.
    formParameters ParameterContract[]
    Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'..
    sample string
    An example of the representation.
    schemaId string
    Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.
    typeName string
    Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.
    content_type str
    Specifies a registered or custom content type for this representation, e.g. application/xml.
    form_parameters Sequence[ParameterContract]
    Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'..
    sample str
    An example of the representation.
    schema_id str
    Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.
    type_name str
    Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.
    contentType String
    Specifies a registered or custom content type for this representation, e.g. application/xml.
    formParameters List<Property Map>
    Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'..
    sample String
    An example of the representation.
    schemaId String
    Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.
    typeName String
    Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.

    RepresentationContractResponse, RepresentationContractResponseArgs

    ContentType string
    Specifies a registered or custom content type for this representation, e.g. application/xml.
    FormParameters List<Pulumi.AzureNative.ApiManagement.Inputs.ParameterContractResponse>
    Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'..
    Sample string
    An example of the representation.
    SchemaId string
    Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.
    TypeName string
    Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.
    ContentType string
    Specifies a registered or custom content type for this representation, e.g. application/xml.
    FormParameters []ParameterContractResponse
    Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'..
    Sample string
    An example of the representation.
    SchemaId string
    Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.
    TypeName string
    Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.
    contentType String
    Specifies a registered or custom content type for this representation, e.g. application/xml.
    formParameters List<ParameterContractResponse>
    Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'..
    sample String
    An example of the representation.
    schemaId String
    Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.
    typeName String
    Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.
    contentType string
    Specifies a registered or custom content type for this representation, e.g. application/xml.
    formParameters ParameterContractResponse[]
    Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'..
    sample string
    An example of the representation.
    schemaId string
    Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.
    typeName string
    Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.
    content_type str
    Specifies a registered or custom content type for this representation, e.g. application/xml.
    form_parameters Sequence[ParameterContractResponse]
    Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'..
    sample str
    An example of the representation.
    schema_id str
    Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.
    type_name str
    Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.
    contentType String
    Specifies a registered or custom content type for this representation, e.g. application/xml.
    formParameters List<Property Map>
    Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'..
    sample String
    An example of the representation.
    schemaId String
    Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.
    typeName String
    Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.

    RequestContract, RequestContractArgs

    Description string
    Operation request description.
    Headers List<Pulumi.AzureNative.ApiManagement.Inputs.ParameterContract>
    Collection of operation request headers.
    QueryParameters List<Pulumi.AzureNative.ApiManagement.Inputs.ParameterContract>
    Collection of operation request query parameters.
    Representations List<Pulumi.AzureNative.ApiManagement.Inputs.RepresentationContract>
    Collection of operation request representations.
    Description string
    Operation request description.
    Headers []ParameterContract
    Collection of operation request headers.
    QueryParameters []ParameterContract
    Collection of operation request query parameters.
    Representations []RepresentationContract
    Collection of operation request representations.
    description String
    Operation request description.
    headers List<ParameterContract>
    Collection of operation request headers.
    queryParameters List<ParameterContract>
    Collection of operation request query parameters.
    representations List<RepresentationContract>
    Collection of operation request representations.
    description string
    Operation request description.
    headers ParameterContract[]
    Collection of operation request headers.
    queryParameters ParameterContract[]
    Collection of operation request query parameters.
    representations RepresentationContract[]
    Collection of operation request representations.
    description str
    Operation request description.
    headers Sequence[ParameterContract]
    Collection of operation request headers.
    query_parameters Sequence[ParameterContract]
    Collection of operation request query parameters.
    representations Sequence[RepresentationContract]
    Collection of operation request representations.
    description String
    Operation request description.
    headers List<Property Map>
    Collection of operation request headers.
    queryParameters List<Property Map>
    Collection of operation request query parameters.
    representations List<Property Map>
    Collection of operation request representations.

    RequestContractResponse, RequestContractResponseArgs

    Description string
    Operation request description.
    Headers []ParameterContractResponse
    Collection of operation request headers.
    QueryParameters []ParameterContractResponse
    Collection of operation request query parameters.
    Representations []RepresentationContractResponse
    Collection of operation request representations.
    description String
    Operation request description.
    headers List<ParameterContractResponse>
    Collection of operation request headers.
    queryParameters List<ParameterContractResponse>
    Collection of operation request query parameters.
    representations List<RepresentationContractResponse>
    Collection of operation request representations.
    description string
    Operation request description.
    headers ParameterContractResponse[]
    Collection of operation request headers.
    queryParameters ParameterContractResponse[]
    Collection of operation request query parameters.
    representations RepresentationContractResponse[]
    Collection of operation request representations.
    description str
    Operation request description.
    headers Sequence[ParameterContractResponse]
    Collection of operation request headers.
    query_parameters Sequence[ParameterContractResponse]
    Collection of operation request query parameters.
    representations Sequence[RepresentationContractResponse]
    Collection of operation request representations.
    description String
    Operation request description.
    headers List<Property Map>
    Collection of operation request headers.
    queryParameters List<Property Map>
    Collection of operation request query parameters.
    representations List<Property Map>
    Collection of operation request representations.

    ResponseContract, ResponseContractArgs

    StatusCode int
    Operation response HTTP status code.
    Description string
    Operation response description.
    Headers List<Pulumi.AzureNative.ApiManagement.Inputs.ParameterContract>
    Collection of operation response headers.
    Representations List<Pulumi.AzureNative.ApiManagement.Inputs.RepresentationContract>
    Collection of operation response representations.
    StatusCode int
    Operation response HTTP status code.
    Description string
    Operation response description.
    Headers []ParameterContract
    Collection of operation response headers.
    Representations []RepresentationContract
    Collection of operation response representations.
    statusCode Integer
    Operation response HTTP status code.
    description String
    Operation response description.
    headers List<ParameterContract>
    Collection of operation response headers.
    representations List<RepresentationContract>
    Collection of operation response representations.
    statusCode number
    Operation response HTTP status code.
    description string
    Operation response description.
    headers ParameterContract[]
    Collection of operation response headers.
    representations RepresentationContract[]
    Collection of operation response representations.
    status_code int
    Operation response HTTP status code.
    description str
    Operation response description.
    headers Sequence[ParameterContract]
    Collection of operation response headers.
    representations Sequence[RepresentationContract]
    Collection of operation response representations.
    statusCode Number
    Operation response HTTP status code.
    description String
    Operation response description.
    headers List<Property Map>
    Collection of operation response headers.
    representations List<Property Map>
    Collection of operation response representations.

    ResponseContractResponse, ResponseContractResponseArgs

    StatusCode int
    Operation response HTTP status code.
    Description string
    Operation response description.
    Headers List<Pulumi.AzureNative.ApiManagement.Inputs.ParameterContractResponse>
    Collection of operation response headers.
    Representations List<Pulumi.AzureNative.ApiManagement.Inputs.RepresentationContractResponse>
    Collection of operation response representations.
    StatusCode int
    Operation response HTTP status code.
    Description string
    Operation response description.
    Headers []ParameterContractResponse
    Collection of operation response headers.
    Representations []RepresentationContractResponse
    Collection of operation response representations.
    statusCode Integer
    Operation response HTTP status code.
    description String
    Operation response description.
    headers List<ParameterContractResponse>
    Collection of operation response headers.
    representations List<RepresentationContractResponse>
    Collection of operation response representations.
    statusCode number
    Operation response HTTP status code.
    description string
    Operation response description.
    headers ParameterContractResponse[]
    Collection of operation response headers.
    representations RepresentationContractResponse[]
    Collection of operation response representations.
    status_code int
    Operation response HTTP status code.
    description str
    Operation response description.
    headers Sequence[ParameterContractResponse]
    Collection of operation response headers.
    representations Sequence[RepresentationContractResponse]
    Collection of operation response representations.
    statusCode Number
    Operation response HTTP status code.
    description String
    Operation response description.
    headers List<Property Map>
    Collection of operation response headers.
    representations List<Property Map>
    Collection of operation response representations.

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:apimanagement:ApiOperation newoperations /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/PetStoreTemplate2/operations/newoperations

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

    Package Details

    Repository
    azure-native-v1 pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native-v1 logo
    These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
    Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
    pulumi/pulumi-azure-native