1. Packages
  2. Fortios
  3. API Docs
  4. wirelesscontroller
  5. wirelesscontroller/hotspot20
  6. H2qpadviceofcharge
Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse

fortios.wirelesscontroller/hotspot20.H2qpadviceofcharge

Explore with Pulumi AI

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

    Configure advice of charge. Applies to FortiOS Version >= 7.0.2.

    Create H2qpadviceofcharge Resource

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

    Constructor syntax

    new H2qpadviceofcharge(name: string, args?: H2qpadviceofchargeArgs, opts?: CustomResourceOptions);
    @overload
    def H2qpadviceofcharge(resource_name: str,
                           args: Optional[H2qpadviceofchargeArgs] = None,
                           opts: Optional[ResourceOptions] = None)
    
    @overload
    def H2qpadviceofcharge(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           aoc_lists: Optional[Sequence[H2qpadviceofchargeAocListArgs]] = None,
                           dynamic_sort_subtable: Optional[str] = None,
                           get_all_tables: Optional[str] = None,
                           name: Optional[str] = None,
                           vdomparam: Optional[str] = None)
    func NewH2qpadviceofcharge(ctx *Context, name string, args *H2qpadviceofchargeArgs, opts ...ResourceOption) (*H2qpadviceofcharge, error)
    public H2qpadviceofcharge(string name, H2qpadviceofchargeArgs? args = null, CustomResourceOptions? opts = null)
    public H2qpadviceofcharge(String name, H2qpadviceofchargeArgs args)
    public H2qpadviceofcharge(String name, H2qpadviceofchargeArgs args, CustomResourceOptions options)
    
    type: fortios:wirelesscontroller/hotspot20/h2qpadviceofcharge:H2qpadviceofcharge
    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 H2qpadviceofchargeArgs
    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 H2qpadviceofchargeArgs
    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 H2qpadviceofchargeArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args H2qpadviceofchargeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args H2qpadviceofchargeArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    H2qpadviceofcharge Resource Properties

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

    Inputs

    The H2qpadviceofcharge resource accepts the following input properties:

    AocLists List<Pulumiverse.Fortios.Wirelesscontroller.Hotspot20.Inputs.H2qpadviceofchargeAocList>
    AOC list. The structure of aoc_list block is documented below.
    DynamicSortSubtable string
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    GetAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    Name string
    Plan name.
    Vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    AocLists []H2qpadviceofchargeAocListArgs
    AOC list. The structure of aoc_list block is documented below.
    DynamicSortSubtable string
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    GetAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    Name string
    Plan name.
    Vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    aocLists List<H2qpadviceofchargeAocList>
    AOC list. The structure of aoc_list block is documented below.
    dynamicSortSubtable String
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    getAllTables String
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    name String
    Plan name.
    vdomparam String
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    aocLists H2qpadviceofchargeAocList[]
    AOC list. The structure of aoc_list block is documented below.
    dynamicSortSubtable string
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    getAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    name string
    Plan name.
    vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    aoc_lists Sequence[H2qpadviceofchargeAocListArgs]
    AOC list. The structure of aoc_list block is documented below.
    dynamic_sort_subtable str
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    get_all_tables str
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    name str
    Plan name.
    vdomparam str
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    aocLists List<Property Map>
    AOC list. The structure of aoc_list block is documented below.
    dynamicSortSubtable String
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    getAllTables String
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    name String
    Plan name.
    vdomparam String
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing H2qpadviceofcharge Resource

    Get an existing H2qpadviceofcharge 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?: H2qpadviceofchargeState, opts?: CustomResourceOptions): H2qpadviceofcharge
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            aoc_lists: Optional[Sequence[H2qpadviceofchargeAocListArgs]] = None,
            dynamic_sort_subtable: Optional[str] = None,
            get_all_tables: Optional[str] = None,
            name: Optional[str] = None,
            vdomparam: Optional[str] = None) -> H2qpadviceofcharge
    func GetH2qpadviceofcharge(ctx *Context, name string, id IDInput, state *H2qpadviceofchargeState, opts ...ResourceOption) (*H2qpadviceofcharge, error)
    public static H2qpadviceofcharge Get(string name, Input<string> id, H2qpadviceofchargeState? state, CustomResourceOptions? opts = null)
    public static H2qpadviceofcharge get(String name, Output<String> id, H2qpadviceofchargeState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    AocLists List<Pulumiverse.Fortios.Wirelesscontroller.Hotspot20.Inputs.H2qpadviceofchargeAocList>
    AOC list. The structure of aoc_list block is documented below.
    DynamicSortSubtable string
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    GetAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    Name string
    Plan name.
    Vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    AocLists []H2qpadviceofchargeAocListArgs
    AOC list. The structure of aoc_list block is documented below.
    DynamicSortSubtable string
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    GetAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    Name string
    Plan name.
    Vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    aocLists List<H2qpadviceofchargeAocList>
    AOC list. The structure of aoc_list block is documented below.
    dynamicSortSubtable String
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    getAllTables String
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    name String
    Plan name.
    vdomparam String
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    aocLists H2qpadviceofchargeAocList[]
    AOC list. The structure of aoc_list block is documented below.
    dynamicSortSubtable string
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    getAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    name string
    Plan name.
    vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    aoc_lists Sequence[H2qpadviceofchargeAocListArgs]
    AOC list. The structure of aoc_list block is documented below.
    dynamic_sort_subtable str
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    get_all_tables str
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    name str
    Plan name.
    vdomparam str
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    aocLists List<Property Map>
    AOC list. The structure of aoc_list block is documented below.
    dynamicSortSubtable String
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    getAllTables String
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    name String
    Plan name.
    vdomparam String
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

    Supporting Types

    H2qpadviceofchargeAocList, H2qpadviceofchargeAocListArgs

    NaiRealm string
    NAI realm list name.
    NaiRealmEncoding string
    NAI realm encoding.
    Name string
    Advice of charge ID.
    PlanInfos List<Pulumiverse.Fortios.Wirelesscontroller.Hotspot20.Inputs.H2qpadviceofchargeAocListPlanInfo>
    Plan info. The structure of plan_info block is documented below.
    Type string
    Usage charge type. Valid values: time-based, volume-based, time-and-volume-based, unlimited.
    NaiRealm string
    NAI realm list name.
    NaiRealmEncoding string
    NAI realm encoding.
    Name string
    Advice of charge ID.
    PlanInfos []H2qpadviceofchargeAocListPlanInfo
    Plan info. The structure of plan_info block is documented below.
    Type string
    Usage charge type. Valid values: time-based, volume-based, time-and-volume-based, unlimited.
    naiRealm String
    NAI realm list name.
    naiRealmEncoding String
    NAI realm encoding.
    name String
    Advice of charge ID.
    planInfos List<H2qpadviceofchargeAocListPlanInfo>
    Plan info. The structure of plan_info block is documented below.
    type String
    Usage charge type. Valid values: time-based, volume-based, time-and-volume-based, unlimited.
    naiRealm string
    NAI realm list name.
    naiRealmEncoding string
    NAI realm encoding.
    name string
    Advice of charge ID.
    planInfos H2qpadviceofchargeAocListPlanInfo[]
    Plan info. The structure of plan_info block is documented below.
    type string
    Usage charge type. Valid values: time-based, volume-based, time-and-volume-based, unlimited.
    nai_realm str
    NAI realm list name.
    nai_realm_encoding str
    NAI realm encoding.
    name str
    Advice of charge ID.
    plan_infos Sequence[H2qpadviceofchargeAocListPlanInfo]
    Plan info. The structure of plan_info block is documented below.
    type str
    Usage charge type. Valid values: time-based, volume-based, time-and-volume-based, unlimited.
    naiRealm String
    NAI realm list name.
    naiRealmEncoding String
    NAI realm encoding.
    name String
    Advice of charge ID.
    planInfos List<Property Map>
    Plan info. The structure of plan_info block is documented below.
    type String
    Usage charge type. Valid values: time-based, volume-based, time-and-volume-based, unlimited.

    H2qpadviceofchargeAocListPlanInfo, H2qpadviceofchargeAocListPlanInfoArgs

    Currency string
    Currency code.
    InfoFile string
    Info file.
    Lang string
    Languague code.
    Name string
    Plan name.
    Currency string
    Currency code.
    InfoFile string
    Info file.
    Lang string
    Languague code.
    Name string
    Plan name.
    currency String
    Currency code.
    infoFile String
    Info file.
    lang String
    Languague code.
    name String
    Plan name.
    currency string
    Currency code.
    infoFile string
    Info file.
    lang string
    Languague code.
    name string
    Plan name.
    currency str
    Currency code.
    info_file str
    Info file.
    lang str
    Languague code.
    name str
    Plan name.
    currency String
    Currency code.
    infoFile String
    Info file.
    lang String
    Languague code.
    name String
    Plan name.

    Import

    WirelessControllerHotspot20 H2QpAdviceOfCharge can be imported using any of these accepted formats:

    $ pulumi import fortios:wirelesscontroller/hotspot20/h2qpadviceofcharge:H2qpadviceofcharge labelname {{name}}
    

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:wirelesscontroller/hotspot20/h2qpadviceofcharge:H2qpadviceofcharge labelname {{name}}
    

    $ unset “FORTIOS_IMPORT_TABLE”

    To learn more about importing existing cloud resources, see Importing resources.

    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