Class ApiOperation

Manages an API Operation within an API Management Service.

Inheritance

System.Object

Resource

CustomResource

ApiOperation

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Azure.ApiManagement

Assembly: Pulumi.Azure.dll

Syntax

public class ApiOperation : CustomResource

Constructors

ApiOperation(String, ApiOperationArgs, CustomResourceOptions)

Create a ApiOperation resource with the given unique name, arguments, and options.

Declaration

public ApiOperation(string name, ApiOperationArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
ApiOperationArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

ApiManagementName

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

Declaration

public Output<string> ApiManagementName { get; }

Property Value

Type	Description
Output<System.String>

ApiName

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.

Declaration

public Output<string> ApiName { get; }

Property Value

Type	Description
Output<System.String>

Description

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

Declaration

public Output<string> Description { get; }

Property Value

Type	Description
Output<System.String>

DisplayName

The Display Name for this API Management Operation.

Declaration

public Output<string> DisplayName { get; }

Property Value

Type	Description
Output<System.String>

Method

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

Declaration

public Output<string> Method { get; }

Property Value

Type	Description
Output<System.String>

OperationId

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

Declaration

public Output<string> OperationId { get; }

Property Value

Type	Description
Output<System.String>

Request

A request block as defined below.

Declaration

public Output<ApiOperationRequest> Request { get; }

Property Value

Type	Description
Output<ApiOperationRequest>

ResourceGroupName

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

Declaration

public Output<string> ResourceGroupName { get; }

Property Value

Type	Description
Output<System.String>

Responses

One or more response blocks as defined below.

Declaration

public Output<ImmutableArray<ApiOperationResponse>> Responses { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<ApiOperationResponse>>

TemplateParameters

One or more template_parameter blocks as defined below.

Declaration

public Output<ImmutableArray<ApiOperationTemplateParameter>> TemplateParameters { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<ApiOperationTemplateParameter>>

UrlTemplate

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

Declaration

public Output<string> UrlTemplate { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, ApiOperationState, CustomResourceOptions)

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

Declaration

public static ApiOperation Get(string name, Input<string> id, ApiOperationState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
ApiOperationState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
ApiOperation