1. Packages
  2. Fortios
  3. API Docs
  4. json
  5. getGenericApi
Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse

fortios.json.getGenericApi

Explore with Pulumi AI

fortios logo
Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse

    Provides a FortiAPI Generic Interface data source.

    Using getGenericApi

    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 getGenericApi(args: GetGenericApiArgs, opts?: InvokeOptions): Promise<GetGenericApiResult>
    function getGenericApiOutput(args: GetGenericApiOutputArgs, opts?: InvokeOptions): Output<GetGenericApiResult>
    def get_generic_api(path: Optional[str] = None,
                        specialparams: Optional[str] = None,
                        vdomparam: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetGenericApiResult
    def get_generic_api_output(path: Optional[pulumi.Input[str]] = None,
                        specialparams: Optional[pulumi.Input[str]] = None,
                        vdomparam: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetGenericApiResult]
    func LookupGenericApi(ctx *Context, args *LookupGenericApiArgs, opts ...InvokeOption) (*LookupGenericApiResult, error)
    func LookupGenericApiOutput(ctx *Context, args *LookupGenericApiOutputArgs, opts ...InvokeOption) LookupGenericApiResultOutput

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

    public static class GetGenericApi 
    {
        public static Task<GetGenericApiResult> InvokeAsync(GetGenericApiArgs args, InvokeOptions? opts = null)
        public static Output<GetGenericApiResult> Invoke(GetGenericApiInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetGenericApiResult> getGenericApi(GetGenericApiArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: fortios:json/getGenericApi:getGenericApi
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Path string
    FortiAPI URL path.
    Specialparams string
    URL parameters, in addition to the URL path, user can specify URL parameters which are appended to the URL path..
    Vdomparam string
    Path string
    FortiAPI URL path.
    Specialparams string
    URL parameters, in addition to the URL path, user can specify URL parameters which are appended to the URL path..
    Vdomparam string
    path String
    FortiAPI URL path.
    specialparams String
    URL parameters, in addition to the URL path, user can specify URL parameters which are appended to the URL path..
    vdomparam String
    path string
    FortiAPI URL path.
    specialparams string
    URL parameters, in addition to the URL path, user can specify URL parameters which are appended to the URL path..
    vdomparam string
    path str
    FortiAPI URL path.
    specialparams str
    URL parameters, in addition to the URL path, user can specify URL parameters which are appended to the URL path..
    vdomparam str
    path String
    FortiAPI URL path.
    specialparams String
    URL parameters, in addition to the URL path, user can specify URL parameters which are appended to the URL path..
    vdomparam String

    getGenericApi Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Path string
    FortiAPI URL path.
    Response string
    FortiAPI returns results.
    Specialparams string
    URL parameters, in addition to the URL path, user can specify URL parameters which are appended to the URL path..
    Vdomparam string
    Id string
    The provider-assigned unique ID for this managed resource.
    Path string
    FortiAPI URL path.
    Response string
    FortiAPI returns results.
    Specialparams string
    URL parameters, in addition to the URL path, user can specify URL parameters which are appended to the URL path..
    Vdomparam string
    id String
    The provider-assigned unique ID for this managed resource.
    path String
    FortiAPI URL path.
    response String
    FortiAPI returns results.
    specialparams String
    URL parameters, in addition to the URL path, user can specify URL parameters which are appended to the URL path..
    vdomparam String
    id string
    The provider-assigned unique ID for this managed resource.
    path string
    FortiAPI URL path.
    response string
    FortiAPI returns results.
    specialparams string
    URL parameters, in addition to the URL path, user can specify URL parameters which are appended to the URL path..
    vdomparam string
    id str
    The provider-assigned unique ID for this managed resource.
    path str
    FortiAPI URL path.
    response str
    FortiAPI returns results.
    specialparams str
    URL parameters, in addition to the URL path, user can specify URL parameters which are appended to the URL path..
    vdomparam str
    id String
    The provider-assigned unique ID for this managed resource.
    path String
    FortiAPI URL path.
    response String
    FortiAPI returns results.
    specialparams String
    URL parameters, in addition to the URL path, user can specify URL parameters which are appended to the URL path..
    vdomparam String

    Package Details

    Repository
    fortios pulumiverse/pulumi-fortios
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the fortios Terraform Provider.
    fortios logo
    Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse