GradientEdge CDK Utils
    Preparing search index...

    Interface ApiOperationProps

    interface ApiOperationProps {
        apiId: Input<string>;
        description?: Input<string>;
        displayName: Input<string>;
        method: Input<string>;
        operationId?: Input<string>;
        policies?: Input<string>;
        request?: Input<RequestContractArgs>;
        resourceGroupName: Input<string>;
        responses?: Input<Input<ResponseContractArgs>[]>;
        serviceName: Input<string>;
        templateParameters?: Input<Input<ParameterContractArgs>[]>;
        urlTemplate: Input<string>;
    }

    Hierarchy

    • ApiOperationArgs
      • ApiOperationProps
    Index

    Properties

    apiId description? displayName method operationId? policies? request? resourceGroupName responses? serviceName templateParameters? urlTemplate

    Properties

    apiId: Input<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.

    description?: Input<string>

    Description of the operation. May include HTML formatting tags.

    displayName: Input<string>

    Operation Name.

    method: Input<string>

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

    operationId?: Input<string>

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

    policies?: Input<string>

    Operation Policies

    request?: Input<RequestContractArgs>

    An entity containing request details.

    resourceGroupName: Input<string>

    The name of the resource group. The name is case insensitive.

    responses?: Input<Input<ResponseContractArgs>[]>

    Array of Operation responses.

    serviceName: Input<string>

    The name of the API Management service.

    templateParameters?: Input<Input<ParameterContractArgs>[]>

    Collection of URL template parameters.

    urlTemplate: Input<string>

    Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}

    Settings

    Member Visibility

    On This Page

    Properties