ApiOperation

Manages an API Operation within an API Management Service.

Create a ApiOperation Resource

new ApiOperation(name: string, args: ApiOperationArgs, opts?: CustomResourceOptions);

def ApiOperation(resource_name, opts=None, api_management_name=None, api_name=None, description=None, display_name=None, method=None, operation_id=None, request=None, resource_group_name=None, responses=None, template_parameters=None, url_template=None, __props__=None);

func NewApiOperation(ctx *Context, name string, args ApiOperationArgs, opts ...ResourceOption) (*ApiOperation, error)

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

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.
opts ResourceOptions: A bag of options that control this 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.

ApiOperation Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model 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 ApiOperationRequest: A request block as defined below.
Responses []ApiOperationResponse: One or more response blocks as defined below.
TemplateParameters []ApiOperationTemplateParameter: One or more template_parameter blocks as defined below.

apiManagementName string: The Name of the API Management Service where the API exists. Changing this forces a new resource to be created.
apiName string: The name of the API within the API Management Service where this API Operation should be created. Changing this forces a new resource to be created.
displayName string: The Display Name for this API Management Operation.
method string: The HTTP Method used for this API Management Operation, like GET, DELETE, PUT or POST - but not limited to these values.
operationId string: A unique identifier for this API Operation. Changing this forces a new resource to be created.
resourceGroupName string: The Name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
urlTemplate string: The relative URL Template identifying the target resource for this operation, which may include parameters.
description string: A description for this API Operation, which may include HTML formatting tags.
request ApiOperationRequest: A request block as defined below.
responses ApiOperationResponse[]: One or more response blocks as defined below.
templateParameters ApiOperationTemplateParameter[]: One or more template_parameter blocks as defined below.

api_management_name str: The Name of the API Management Service where the API exists. Changing this forces a new resource to be created.
api_name str: The name of the API within the API Management Service where this API Operation should be created. Changing this forces a new resource to be created.
display_name str: The Display Name for this API Management Operation.
method str: The HTTP Method used for this API Management Operation, like GET, DELETE, PUT or POST - but not limited to these values.
operation_id str: A unique identifier for this API Operation. Changing this forces a new resource to be created.
resource_group_name str: The Name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
url_template str: The relative URL Template identifying the target resource for this operation, which may include parameters.
description str: A description for this API Operation, which may include HTML formatting tags.
request Dict[ApiOperationRequest]: A request block as defined below.
responses List[ApiOperationResponse]: One or more response blocks as defined below.
template_parameters List[ApiOperationTemplateParameter]: 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 str: 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

static get(resource_name, id, opts=None, api_management_name=None, api_name=None, description=None, display_name=None, method=None, operation_id=None, request=None, resource_group_name=None, responses=None, template_parameters=None, url_template=None, __props__=None);

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)

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.

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 ApiOperationRequest: A request block as defined below.
ResourceGroupName string: The Name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
Responses []ApiOperationResponse: One or more response blocks as defined below.
TemplateParameters []ApiOperationTemplateParameter: One or more template_parameter blocks as defined below.
UrlTemplate string: The relative URL Template identifying the target resource for this operation, which may include parameters.

apiManagementName string: The Name of the API Management Service where the API exists. Changing this forces a new resource to be created.
apiName string: The name of the API within the API Management Service where this API Operation should be created. Changing this forces a new resource to be created.
description string: A description for this API Operation, which may include HTML formatting tags.
displayName string: The Display Name for this API Management Operation.
method string: The HTTP Method used for this API Management Operation, like GET, DELETE, PUT or POST - but not limited to these values.
operationId string: A unique identifier for this API Operation. Changing this forces a new resource to be created.
request ApiOperationRequest: A request block as defined below.
resourceGroupName string: The Name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
responses ApiOperationResponse[]: One or more response blocks as defined below.
templateParameters ApiOperationTemplateParameter[]: One or more template_parameter blocks as defined below.
urlTemplate string: The relative URL Template identifying the target resource for this operation, which may include parameters.

api_management_name str: The Name of the API Management Service where the API exists. Changing this forces a new resource to be created.
api_name str: The name of the API within the API Management Service where this API Operation should be created. Changing this forces a new resource to be created.
description str: A description for this API Operation, which may include HTML formatting tags.
display_name str: The Display Name for this API Management Operation.
method str: The HTTP Method used for this API Management Operation, like GET, DELETE, PUT or POST - but not limited to these values.
operation_id str: A unique identifier for this API Operation. Changing this forces a new resource to be created.
request Dict[ApiOperationRequest]: 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 List[ApiOperationResponse]: One or more response blocks as defined below.
template_parameters List[ApiOperationTemplateParameter]: 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.

Supporting Types

ApiOperationRequest

Description string: A description of the HTTP Request, which may include HTML tags.
Headers List<ApiOperationRequestHeaderArgs>: One or more header blocks as defined above.
QueryParameters List<ApiOperationRequestQueryParameterArgs>: One or more query_parameter blocks as defined above.
Representations List<ApiOperationRequestRepresentationArgs>: 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 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 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.

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 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.
defaultValue str: The default value for this Header.
description str: A description of this Header.
values List[str]: 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 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.
defaultValue str: The default value for this Query Parameter.
description str: A description of this Query Parameter.
values List[str]: One or more acceptable values for this Query Parameter.

ApiOperationRequestRepresentation

ContentType string: The Content Type of this representation, such as application/json.
FormParameters List<ApiOperationRequestRepresentationFormParameterArgs>: One or more form_parameter block as defined above.
Sample string: An example of this representation.
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.
FormParameters []ApiOperationRequestRepresentationFormParameter: One or more form_parameter block as defined above.
Sample string: An example of this representation.
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.
formParameters ApiOperationRequestRepresentationFormParameter[]: One or more form_parameter block as defined above.
sample string: An example of this representation.
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.
formParameters List[ApiOperationRequestRepresentationFormParameter]: One or more form_parameter block as defined above.
sample str: An example of this representation.
schema_id str: The ID of an API Management Schema which represents this Response.
typeName str: The Type Name defined by the Schema.

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 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.
defaultValue str: The default value for this Form Parameter.
description str: A description of this Form Parameter.
values List[str]: 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<ApiOperationResponseHeaderArgs>: One or more header blocks as defined above.
Representations List<ApiOperationResponseRepresentationArgs>: 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 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.

statusCode float: The HTTP Status Code.
description str: 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.

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 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.
defaultValue str: The default value for this Header.
description str: A description of this Header.
values List[str]: One or more acceptable values for this Header.

ApiOperationResponseRepresentation

ContentType string: The Content Type of this representation, such as application/json.
FormParameters List<ApiOperationResponseRepresentationFormParameterArgs>: One or more form_parameter block as defined above.
Sample string: An example of this representation.
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.
FormParameters []ApiOperationResponseRepresentationFormParameter: One or more form_parameter block as defined above.
Sample string: An example of this representation.
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.
formParameters ApiOperationResponseRepresentationFormParameter[]: One or more form_parameter block as defined above.
sample string: An example of this representation.
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.
formParameters List[ApiOperationResponseRepresentationFormParameter]: One or more form_parameter block as defined above.
sample str: An example of this representation.
schema_id str: The ID of an API Management Schema which represents this Response.
typeName str: The Type Name defined by the Schema.

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 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.
defaultValue str: The default value for this Form Parameter.
description str: A description of this Form Parameter.
values List[str]: 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 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.
defaultValue str: The default value for this Template Parameter.
description str: A description of this Template Parameter.
values List[str]: One or more acceptable values for this Template Parameter.

Package Details

Repository: https://github.com/pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud