@pulumiverse/fortios/json/genericApi.d.ts

A Pulumi package for creating and managing Fortios resources. Based on terraform-provider-fortios: version v1.16.0

import * as pulumi from "@pulumi/pulumi";
/**
 * FortiAPI Generic Interface.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as fortios from "@pulumiverse/fortios";
 *
 * const test1 = new fortios.json.GenericApi("test1", {
 *     json: "",
 *     method: "GET",
 *     path: "/api/v2/cmdb/firewall/address",
 * });
 * export const response1 = test1.response;
 * const test2 = new fortios.json.GenericApi("test2", {
 *     json: `{
 *   "name": "11221",
 *   "type": "geography",
 *   "fqdn": "",
 *   "country": "AL",
 *   "comment": "ccc",
 *   "visibility": "enable",
 *   "associated-interface": "port1",
 *   "allow-routing": "disable"
 * }
 *
 * `,
 *     method: "POST",
 *     path: "/api/v2/cmdb/firewall/address",
 * });
 * export const response2 = test2.response;
 * const test3 = new fortios.json.GenericApi("test3", {
 *     json: "",
 *     method: "PUT",
 *     path: "/api/v2/cmdb/firewall/policy/3",
 *     specialparams: "action=move&after=1",
 * });
 * export const response3 = test3.response;
 * ```
 */
export declare class GenericApi extends pulumi.CustomResource {
    /**
     * Get an existing GenericApi 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 state Any extra arguments used during the lookup.
     * @param opts Optional settings to control the behavior of the CustomResource.
     */
    static get(name: string, id: pulumi.Input<pulumi.ID>, state?: GenericApiState, opts?: pulumi.CustomResourceOptions): GenericApi;
    /**
     * Returns true if the given object is an instance of GenericApi.  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 GenericApi;
    /**
     * The argument is optional, if it is set, when its value changes, the resource will be re-created. It is usually used when the return value needs to be forced to update.
     */
    readonly forceRecreate: pulumi.Output<string | undefined>;
    /**
     * Body data in JSON format.
     */
    readonly json: pulumi.Output<string | undefined>;
    /**
     * HTTP method.
     */
    readonly method: pulumi.Output<string>;
    /**
     * FortiAPI URL path.
     */
    readonly path: pulumi.Output<string>;
    /**
     * FortiAPI returns results.
     */
    readonly response: pulumi.Output<string>;
    /**
     * URL parameters, in addition to the URL path, user can specify URL parameters which are appended to the URL path.
     */
    readonly specialparams: pulumi.Output<string | undefined>;
    readonly vdomparam: pulumi.Output<string | undefined>;
    /**
     * Create a GenericApi 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: GenericApiArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering GenericApi resources.
 */
export interface GenericApiState {
    /**
     * The argument is optional, if it is set, when its value changes, the resource will be re-created. It is usually used when the return value needs to be forced to update.
     */
    forceRecreate?: pulumi.Input<string>;
    /**
     * Body data in JSON format.
     */
    json?: pulumi.Input<string>;
    /**
     * HTTP method.
     */
    method?: pulumi.Input<string>;
    /**
     * FortiAPI URL path.
     */
    path?: pulumi.Input<string>;
    /**
     * FortiAPI returns results.
     */
    response?: pulumi.Input<string>;
    /**
     * URL parameters, in addition to the URL path, user can specify URL parameters which are appended to the URL path.
     */
    specialparams?: pulumi.Input<string>;
    vdomparam?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a GenericApi resource.
 */
export interface GenericApiArgs {
    /**
     * The argument is optional, if it is set, when its value changes, the resource will be re-created. It is usually used when the return value needs to be forced to update.
     */
    forceRecreate?: pulumi.Input<string>;
    /**
     * Body data in JSON format.
     */
    json?: pulumi.Input<string>;
    /**
     * HTTP method.
     */
    method: pulumi.Input<string>;
    /**
     * FortiAPI URL path.
     */
    path: pulumi.Input<string>;
    /**
     * URL parameters, in addition to the URL path, user can specify URL parameters which are appended to the URL path.
     */
    specialparams?: pulumi.Input<string>;
    vdomparam?: pulumi.Input<string>;
}