Azure Native

Pulumi Official
Package maintained by Pulumi
v1.64.1 published on Wednesday, May 18, 2022 by Pulumi

getApiOperation

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

Using getApiOperation

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getApiOperation(args: GetApiOperationArgs, opts?: InvokeOptions): Promise<GetApiOperationResult>
function getApiOperationOutput(args: GetApiOperationOutputArgs, opts?: InvokeOptions): Output<GetApiOperationResult>
def get_api_operation(api_id: Optional[str] = None,
                      operation_id: Optional[str] = None,
                      resource_group_name: Optional[str] = None,
                      service_name: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetApiOperationResult
def get_api_operation_output(api_id: Optional[pulumi.Input[str]] = None,
                      operation_id: Optional[pulumi.Input[str]] = None,
                      resource_group_name: Optional[pulumi.Input[str]] = None,
                      service_name: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetApiOperationResult]
func LookupApiOperation(ctx *Context, args *LookupApiOperationArgs, opts ...InvokeOption) (*LookupApiOperationResult, error)
func LookupApiOperationOutput(ctx *Context, args *LookupApiOperationOutputArgs, opts ...InvokeOption) LookupApiOperationResultOutput

> Note: This function is named LookupApiOperation in the Go SDK.

public static class GetApiOperation 
{
    public static Task<GetApiOperationResult> InvokeAsync(GetApiOperationArgs args, InvokeOptions? opts = null)
    public static Output<GetApiOperationResult> Invoke(GetApiOperationInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetApiOperationResult> getApiOperation(GetApiOperationArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: azure-native:apimanagement:getApiOperation
  Arguments:
    # Arguments dictionary

The following arguments are supported:

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.

OperationId string

Operation identifier within an API. Must be unique in the current API Management service instance.

ResourceGroupName string

The name of the resource group.

ServiceName string

The name of the API Management service.

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.

OperationId string

Operation identifier within an API. Must be unique in the current API Management service instance.

ResourceGroupName string

The name of the resource group.

ServiceName string

The name of the API Management service.

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.

operationId String

Operation identifier within an API. Must be unique in the current API Management service instance.

resourceGroupName String

The name of the resource group.

serviceName String

The name of the API Management service.

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.

operationId string

Operation identifier within an API. Must be unique in the current API Management service instance.

resourceGroupName string

The name of the resource group.

serviceName string

The name of the API Management service.

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.

operation_id str

Operation identifier within an API. Must be unique in the current API Management service instance.

resource_group_name str

The name of the resource group.

service_name str

The name of the API Management service.

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.

operationId String

Operation identifier within an API. Must be unique in the current API Management service instance.

resourceGroupName String

The name of the resource group.

serviceName String

The name of the API Management service.

getApiOperation Result

The following output properties are available:

DisplayName string

Operation Name.

Id string

Resource ID.

Method string

A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.

Name string

Resource name.

Type string

Resource type for API Management resource.

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.

Policies string

Operation Policies

Request Pulumi.AzureNative.ApiManagement.Outputs.RequestContractResponse

An entity containing request details.

Responses List<Pulumi.AzureNative.ApiManagement.Outputs.ResponseContractResponse>

Array of Operation responses.

TemplateParameters List<Pulumi.AzureNative.ApiManagement.Outputs.ParameterContractResponse>

Collection of URL template parameters.

DisplayName string

Operation Name.

Id string

Resource ID.

Method string

A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.

Name string

Resource name.

Type string

Resource type for API Management resource.

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.

Policies string

Operation Policies

Request RequestContractResponse

An entity containing request details.

Responses []ResponseContractResponse

Array of Operation responses.

TemplateParameters []ParameterContractResponse

Collection of URL template parameters.

displayName String

Operation Name.

id String

Resource ID.

method String

A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.

name String

Resource name.

type String

Resource type for API Management resource.

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.

policies String

Operation Policies

request RequestContractResponse

An entity containing request details.

responses ListContractResponse>

Array of Operation responses.

templateParameters ListContractResponse>

Collection of URL template parameters.

displayName string

Operation Name.

id string

Resource ID.

method string

A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.

name string

Resource name.

type string

Resource type for API Management resource.

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.

policies string

Operation Policies

request RequestContractResponse

An entity containing request details.

responses ResponseContractResponse[]

Array of Operation responses.

templateParameters ParameterContractResponse[]

Collection of URL template parameters.

display_name str

Operation Name.

id str

Resource ID.

method str

A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.

name str

Resource name.

type str

Resource type for API Management resource.

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.

policies str

Operation Policies

request RequestContractResponse

An entity containing request details.

responses Sequence[ResponseContractResponse]

Array of Operation responses.

template_parameters Sequence[ParameterContractResponse]

Collection of URL template parameters.

displayName String

Operation Name.

id String

Resource ID.

method String

A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.

name String

Resource name.

type String

Resource type for API Management resource.

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.

policies String

Operation Policies

request Property Map

An entity containing request details.

responses List

Array of Operation responses.

templateParameters List

Collection of URL template parameters.

Supporting Types

ParameterContractResponse

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

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

Parameter values.

RepresentationContractResponse

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 ListContractResponse>

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

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'.

RequestContractResponse

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 ListContractResponse>

Collection of operation request headers.

queryParameters ListContractResponse>

Collection of operation request query parameters.

representations ListContractResponse>

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

Collection of operation request headers.

queryParameters List

Collection of operation request query parameters.

representations List

Collection of operation request representations.

ResponseContractResponse

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 ListContractResponse>

Collection of operation response headers.

representations ListContractResponse>

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

Collection of operation response headers.

representations List

Collection of operation response representations.

Package Details

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