Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Fortimanager Provider
  3. API Docs
  4. JsonGenericApi
fortimanager 1.13.0 published on Thursday, Mar 13, 2025 by fortinetdev
fortinetdev/terraform-provider-fortimanager

fortimanager.JsonGenericApi

Explore with Pulumi AI

fortimanager logo
fortimanager 1.13.0 published on Thursday, Mar 13, 2025 by fortinetdev
fortinetdev/terraform-provider-fortimanager

    FortiManager API Generic Interface.

    Create JsonGenericApi Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new JsonGenericApi(name: string, args: JsonGenericApiArgs, opts?: CustomResourceOptions);
    @overload
def JsonGenericApi(resource_name: str,
                   args: JsonGenericApiArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def JsonGenericApi(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   json_content: Optional[str] = None,
                   comment: Optional[str] = None,
                   force_recreate: Optional[str] = None,
                   json_generic_api_id: Optional[str] = None)
    func NewJsonGenericApi(ctx *Context, name string, args JsonGenericApiArgs, opts ...ResourceOption) (*JsonGenericApi, error)
    public JsonGenericApi(string name, JsonGenericApiArgs args, CustomResourceOptions? opts = null)
    public JsonGenericApi(String name, JsonGenericApiArgs args)
public JsonGenericApi(String name, JsonGenericApiArgs args, CustomResourceOptions options)

    type: fortimanager:JsonGenericApi
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args JsonGenericApiArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args JsonGenericApiArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args JsonGenericApiArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args JsonGenericApiArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args JsonGenericApiArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var jsonGenericApiResource = new Fortimanager.JsonGenericApi("jsonGenericApiResource", new()
{
    JsonContent = "string",
    Comment = "string",
    ForceRecreate = "string",
    JsonGenericApiId = "string",
});

    example, err := fortimanager.NewJsonGenericApi(ctx, "jsonGenericApiResource", &fortimanager.JsonGenericApiArgs{
JsonContent: pulumi.String("string"),
Comment: pulumi.String("string"),
ForceRecreate: pulumi.String("string"),
JsonGenericApiId: pulumi.String("string"),
})

    var jsonGenericApiResource = new JsonGenericApi("jsonGenericApiResource", JsonGenericApiArgs.builder()
    .jsonContent("string")
    .comment("string")
    .forceRecreate("string")
    .jsonGenericApiId("string")
    .build());

    json_generic_api_resource = fortimanager.JsonGenericApi("jsonGenericApiResource",
    json_content="string",
    comment="string",
    force_recreate="string",
    json_generic_api_id="string")

    const jsonGenericApiResource = new fortimanager.JsonGenericApi("jsonGenericApiResource", {
    jsonContent: "string",
    comment: "string",
    forceRecreate: "string",
    jsonGenericApiId: "string",
});

    type: fortimanager:JsonGenericApi
properties:
    comment: string
    forceRecreate: string
    jsonContent: string
    jsonGenericApiId: string

    JsonGenericApi Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The JsonGenericApi resource accepts the following input properties:

    JsonContent string
    Body data in JSON format.
    Comment string
    Comment.
    ForceRecreate string
    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.
    JsonGenericApiId string
    The resource id.
    JsonContent string
    Body data in JSON format.
    Comment string
    Comment.
    ForceRecreate string
    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.
    JsonGenericApiId string
    The resource id.
    jsonContent String
    Body data in JSON format.
    comment String
    Comment.
    forceRecreate String
    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.
    jsonGenericApiId String
    The resource id.
    jsonContent string
    Body data in JSON format.
    comment string
    Comment.
    forceRecreate string
    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.
    jsonGenericApiId string
    The resource id.
    json_content str
    Body data in JSON format.
    comment str
    Comment.
    force_recreate str
    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.
    json_generic_api_id str
    The resource id.
    jsonContent String
    Body data in JSON format.
    comment String
    Comment.
    forceRecreate String
    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.
    jsonGenericApiId String
    The resource id.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the JsonGenericApi resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Response string
    API returns results.
    Id string
    The provider-assigned unique ID for this managed resource.
    Response string
    API returns results.
    id String
    The provider-assigned unique ID for this managed resource.
    response String
    API returns results.
    id string
    The provider-assigned unique ID for this managed resource.
    response string
    API returns results.
    id str
    The provider-assigned unique ID for this managed resource.
    response str
    API returns results.
    id String
    The provider-assigned unique ID for this managed resource.
    response String
    API returns results.

    Look up Existing JsonGenericApi Resource

    Get an existing JsonGenericApi 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?: JsonGenericApiState, opts?: CustomResourceOptions): JsonGenericApi
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        comment: Optional[str] = None,
        force_recreate: Optional[str] = None,
        json_content: Optional[str] = None,
        json_generic_api_id: Optional[str] = None,
        response: Optional[str] = None) -> JsonGenericApi
    func GetJsonGenericApi(ctx *Context, name string, id IDInput, state *JsonGenericApiState, opts ...ResourceOption) (*JsonGenericApi, error)
    public static JsonGenericApi Get(string name, Input<string> id, JsonGenericApiState? state, CustomResourceOptions? opts = null)
    public static JsonGenericApi get(String name, Output<String> id, JsonGenericApiState state, CustomResourceOptions options)
    resources:  _:    type: fortimanager:JsonGenericApi    get:      id: ${id}
    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.
    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:
    Comment string
    Comment.
    ForceRecreate string
    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.
    JsonContent string
    Body data in JSON format.
    JsonGenericApiId string
    The resource id.
    Response string
    API returns results.
    Comment string
    Comment.
    ForceRecreate string
    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.
    JsonContent string
    Body data in JSON format.
    JsonGenericApiId string
    The resource id.
    Response string
    API returns results.
    comment String
    Comment.
    forceRecreate String
    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.
    jsonContent String
    Body data in JSON format.
    jsonGenericApiId String
    The resource id.
    response String
    API returns results.
    comment string
    Comment.
    forceRecreate string
    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.
    jsonContent string
    Body data in JSON format.
    jsonGenericApiId string
    The resource id.
    response string
    API returns results.
    comment str
    Comment.
    force_recreate str
    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.
    json_content str
    Body data in JSON format.
    json_generic_api_id str
    The resource id.
    response str
    API returns results.
    comment String
    Comment.
    forceRecreate String
    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.
    jsonContent String
    Body data in JSON format.
    jsonGenericApiId String
    The resource id.
    response String
    API returns results.

    Package Details

    Repository
    fortimanager fortinetdev/terraform-provider-fortimanager
    License
    Notes
    This Pulumi package is based on the fortimanager Terraform Provider.
    fortimanager logo
    fortimanager 1.13.0 published on Thursday, Mar 13, 2025 by fortinetdev
    fortinetdev/terraform-provider-fortimanager