Azure Classic

Pulumi Official
Package maintained by Pulumi
v5.15.0 published on Wednesday, Aug 17, 2022 by Pulumi

ApiOperation

Manages an API Operation within an API Management Service.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var exampleApi = Azure.ApiManagement.GetApi.Invoke(new()
    {
        Name = "search-api",
        ApiManagementName = "search-api-management",
        ResourceGroupName = "search-service",
        Revision = "2",
    });

    var exampleApiOperation = new Azure.ApiManagement.ApiOperation("exampleApiOperation", new()
    {
        OperationId = "user-delete",
        ApiName = exampleApi.Apply(getApiResult => getApiResult.Name),
        ApiManagementName = exampleApi.Apply(getApiResult => getApiResult.ApiManagementName),
        ResourceGroupName = exampleApi.Apply(getApiResult => getApiResult.ResourceGroupName),
        DisplayName = "Delete User Operation",
        Method = "DELETE",
        UrlTemplate = "/users/{id}/delete",
        Description = "This can only be done by the logged in user.",
        Responses = new[]
        {
            new Azure.ApiManagement.Inputs.ApiOperationResponseArgs
            {
                StatusCode = 200,
            },
        },
    });

});
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v5/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
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.apimanagement.ApimanagementFunctions;
import com.pulumi.azure.apimanagement.inputs.GetApiArgs;
import com.pulumi.azure.apimanagement.ApiOperation;
import com.pulumi.azure.apimanagement.ApiOperationArgs;
import com.pulumi.azure.apimanagement.inputs.ApiOperationResponseArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var exampleApi = ApimanagementFunctions.getApi(GetApiArgs.builder()
            .name("search-api")
            .apiManagementName("search-api-management")
            .resourceGroupName("search-service")
            .revision("2")
            .build());

        var exampleApiOperation = new ApiOperation("exampleApiOperation", ApiOperationArgs.builder()        
            .operationId("user-delete")
            .apiName(exampleApi.applyValue(getApiResult -> getApiResult.name()))
            .apiManagementName(exampleApi.applyValue(getApiResult -> getApiResult.apiManagementName()))
            .resourceGroupName(exampleApi.applyValue(getApiResult -> getApiResult.resourceGroupName()))
            .displayName("Delete User Operation")
            .method("DELETE")
            .urlTemplate("/users/{id}/delete")
            .description("This can only be done by the logged in user.")
            .responses(ApiOperationResponseArgs.builder()
                .statusCode(200)
                .build())
            .build());

    }
}
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,
    )])
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,
    }],
});
resources:
  exampleApiOperation:
    type: azure:apimanagement:ApiOperation
    properties:
      operationId: user-delete
      apiName: ${exampleApi.name}
      apiManagementName: ${exampleApi.apiManagementName}
      resourceGroupName: ${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
variables:
  exampleApi:
    Fn::Invoke:
      Function: azure:apimanagement:getApi
      Arguments:
        name: search-api
        apiManagementName: search-api-management
        resourceGroupName: search-service
        revision: 2

Create a ApiOperation Resource

new ApiOperation(name: string, args: ApiOperationArgs, opts?: CustomResourceOptions);
@overload
def ApiOperation(resource_name: 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)
@overload
def ApiOperation(resource_name: str,
                 args: ApiOperationArgs,
                 opts: Optional[ResourceOptions] = 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.

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.

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

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 ApiOperationRequestArgs

A request block as defined below.

Responses List<ApiOperationResponseArgs>

One or more response blocks as defined below.

TemplateParameters List<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 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 ApiOperationRequestArgs

A request block as defined below.

responses List<ApiOperationResponseArgs>

One or more response blocks as defined below.

templateParameters List<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 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.

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 an 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)
Resource lookup is not supported in YAML
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 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 List<ApiOperationResponseArgs>

One or more response blocks as defined below.

TemplateParameters List<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 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 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 List<ApiOperationResponseArgs>

One or more response blocks as defined below.

templateParameters List<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 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.

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

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

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

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

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.

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.

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.

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.

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.

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.

schemaId String

The ID of an API Management Schema which represents this Response.

typeName String

The Type Name defined by the Schema.

ApiOperationRequestRepresentationExample

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

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

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

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

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.

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.

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.

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.

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.

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.

schemaId String

The ID of an API Management Schema which represents this Response.

typeName String

The Type Name defined by the Schema.

ApiOperationResponseRepresentationExample

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

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

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

Package Details

Repository
https://github.com/pulumi/pulumi-azure
License
Apache-2.0
Notes

This Pulumi package is based on the azurerm Terraform Provider.