@kengachu-pulumi/azure-native-apimanagement/apiOperation.d.ts

Pulumi Azure Native package for apimanagement

import * as pulumi from "@pulumi/pulumi";
import * as types from "./types";
/**
 * API Operation details.
 * Azure REST API version: 2022-08-01. Prior API version in Azure Native 1.x: 2020-12-01.
 *
 * Other available API versions: 2016-07-07, 2016-10-10, 2022-09-01-preview, 2023-03-01-preview.
 */
export declare class ApiOperation extends pulumi.CustomResource {
    /**
     * Get an existing ApiOperation resource's state with the given name, ID, and optional extra
     * properties used to qualify the lookup.
     *
     * @param name The _unique_ name of the resulting resource.
     * @param id The _unique_ provider ID of the resource to lookup.
     * @param opts Optional settings to control the behavior of the CustomResource.
     */
    static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): ApiOperation;
    /** @internal */
    static readonly __pulumiType = "azure-native:apimanagement:ApiOperation";
    /**
     * Returns true if the given object is an instance of ApiOperation.  This is designed to work even
     * when multiple copies of the Pulumi SDK have been loaded into the same process.
     */
    static isInstance(obj: any): obj is ApiOperation;
    /**
     * Description of the operation. May include HTML formatting tags.
     */
    readonly description: pulumi.Output<string | undefined>;
    /**
     * Operation Name.
     */
    readonly displayName: pulumi.Output<string>;
    /**
     * A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.
     */
    readonly method: pulumi.Output<string>;
    /**
     * The name of the resource
     */
    readonly name: pulumi.Output<string>;
    /**
     * Operation Policies
     */
    readonly policies: pulumi.Output<string | undefined>;
    /**
     * An entity containing request details.
     */
    readonly request: pulumi.Output<types.outputs.RequestContractResponse | undefined>;
    /**
     * Array of Operation responses.
     */
    readonly responses: pulumi.Output<types.outputs.ResponseContractResponse[] | undefined>;
    /**
     * Collection of URL template parameters.
     */
    readonly templateParameters: pulumi.Output<types.outputs.ParameterContractResponse[] | undefined>;
    /**
     * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
     */
    readonly type: pulumi.Output<string>;
    /**
     * Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}
     */
    readonly urlTemplate: pulumi.Output<string>;
    /**
     * Create a ApiOperation resource with the given unique name, arguments, and options.
     *
     * @param name The _unique_ name of the resource.
     * @param args The arguments to use to populate this resource's properties.
     * @param opts A bag of options that control this resource's behavior.
     */
    constructor(name: string, args: ApiOperationArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * The set of arguments for constructing a ApiOperation resource.
 */
export interface ApiOperationArgs {
    /**
     * 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.
     */
    apiId: pulumi.Input<string>;
    /**
     * Description of the operation. May include HTML formatting tags.
     */
    description?: pulumi.Input<string>;
    /**
     * Operation Name.
     */
    displayName: pulumi.Input<string>;
    /**
     * A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.
     */
    method: pulumi.Input<string>;
    /**
     * Operation identifier within an API. Must be unique in the current API Management service instance.
     */
    operationId?: pulumi.Input<string>;
    /**
     * Operation Policies
     */
    policies?: pulumi.Input<string>;
    /**
     * An entity containing request details.
     */
    request?: pulumi.Input<types.inputs.RequestContractArgs>;
    /**
     * The name of the resource group. The name is case insensitive.
     */
    resourceGroupName: pulumi.Input<string>;
    /**
     * Array of Operation responses.
     */
    responses?: pulumi.Input<pulumi.Input<types.inputs.ResponseContractArgs>[]>;
    /**
     * The name of the API Management service.
     */
    serviceName: pulumi.Input<string>;
    /**
     * Collection of URL template parameters.
     */
    templateParameters?: pulumi.Input<pulumi.Input<types.inputs.ParameterContractArgs>[]>;
    /**
     * Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}
     */
    urlTemplate: pulumi.Input<string>;
}