1. Packages
  2. Panos Provider
  3. API Docs
  4. CustomUrlCategory
panos 2.0.0 published on Tuesday, Apr 15, 2025 by paloaltonetworks

panos.CustomUrlCategory

Explore with Pulumi AI

panos logo
panos 2.0.0 published on Tuesday, Apr 15, 2025 by paloaltonetworks

    Example Usage

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.panos.DeviceGroup;
    import com.pulumi.panos.DeviceGroupArgs;
    import com.pulumi.panos.inputs.DeviceGroupLocationArgs;
    import com.pulumi.panos.inputs.DeviceGroupLocationPanoramaArgs;
    import com.pulumi.panos.CustomUrlCategory;
    import com.pulumi.panos.CustomUrlCategoryArgs;
    import com.pulumi.panos.inputs.CustomUrlCategoryLocationArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var example = new DeviceGroup("example", DeviceGroupArgs.builder()
                .location(DeviceGroupLocationArgs.builder()
                    .panorama()
                    .build())
                .build());
    
            var name = new CustomUrlCategory("name", CustomUrlCategoryArgs.builder()
                .location(CustomUrlCategoryLocationArgs.builder()
                    .device_group(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                    .build())
                .type("URL List")
                .lists(            
                    "test.com",
                    "hello.com")
                .build());
    
        }
    }
    
    resources:
      name:
        type: panos:CustomUrlCategory
        properties:
          location:
            device_group:
              name: ${example.name}
          type: URL List
          lists:
            - test.com
            - hello.com
      example:
        type: panos:DeviceGroup
        properties:
          location:
            panorama: {}
    

    Create CustomUrlCategory Resource

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

    Constructor syntax

    new CustomUrlCategory(name: string, args: CustomUrlCategoryArgs, opts?: CustomResourceOptions);
    @overload
    def CustomUrlCategory(resource_name: str,
                          args: CustomUrlCategoryArgs,
                          opts: Optional[ResourceOptions] = None)
    
    @overload
    def CustomUrlCategory(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          location: Optional[CustomUrlCategoryLocationArgs] = None,
                          description: Optional[str] = None,
                          disable_override: Optional[str] = None,
                          lists: Optional[Sequence[str]] = None,
                          name: Optional[str] = None,
                          type: Optional[str] = None)
    func NewCustomUrlCategory(ctx *Context, name string, args CustomUrlCategoryArgs, opts ...ResourceOption) (*CustomUrlCategory, error)
    public CustomUrlCategory(string name, CustomUrlCategoryArgs args, CustomResourceOptions? opts = null)
    public CustomUrlCategory(String name, CustomUrlCategoryArgs args)
    public CustomUrlCategory(String name, CustomUrlCategoryArgs args, CustomResourceOptions options)
    
    type: panos:CustomUrlCategory
    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 CustomUrlCategoryArgs
    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 CustomUrlCategoryArgs
    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 CustomUrlCategoryArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CustomUrlCategoryArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CustomUrlCategoryArgs
    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 customUrlCategoryResource = new Panos.CustomUrlCategory("customUrlCategoryResource", new()
    {
        Location = new Panos.Inputs.CustomUrlCategoryLocationArgs
        {
            DeviceGroup = new Panos.Inputs.CustomUrlCategoryLocationDeviceGroupArgs
            {
                Name = "string",
                PanoramaDevice = "string",
            },
            Shared = null,
            Vsys = new Panos.Inputs.CustomUrlCategoryLocationVsysArgs
            {
                Name = "string",
                NgfwDevice = "string",
            },
        },
        Description = "string",
        DisableOverride = "string",
        Lists = new[]
        {
            "string",
        },
        Name = "string",
        Type = "string",
    });
    
    example, err := panos.NewCustomUrlCategory(ctx, "customUrlCategoryResource", &panos.CustomUrlCategoryArgs{
    	Location: &panos.CustomUrlCategoryLocationArgs{
    		DeviceGroup: &panos.CustomUrlCategoryLocationDeviceGroupArgs{
    			Name:           pulumi.String("string"),
    			PanoramaDevice: pulumi.String("string"),
    		},
    		Shared: &panos.CustomUrlCategoryLocationSharedArgs{},
    		Vsys: &panos.CustomUrlCategoryLocationVsysArgs{
    			Name:       pulumi.String("string"),
    			NgfwDevice: pulumi.String("string"),
    		},
    	},
    	Description:     pulumi.String("string"),
    	DisableOverride: pulumi.String("string"),
    	Lists: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Name: pulumi.String("string"),
    	Type: pulumi.String("string"),
    })
    
    var customUrlCategoryResource = new CustomUrlCategory("customUrlCategoryResource", CustomUrlCategoryArgs.builder()
        .location(CustomUrlCategoryLocationArgs.builder()
            .deviceGroup(CustomUrlCategoryLocationDeviceGroupArgs.builder()
                .name("string")
                .panoramaDevice("string")
                .build())
            .shared()
            .vsys(CustomUrlCategoryLocationVsysArgs.builder()
                .name("string")
                .ngfwDevice("string")
                .build())
            .build())
        .description("string")
        .disableOverride("string")
        .lists("string")
        .name("string")
        .type("string")
        .build());
    
    custom_url_category_resource = panos.CustomUrlCategory("customUrlCategoryResource",
        location={
            "device_group": {
                "name": "string",
                "panorama_device": "string",
            },
            "shared": {},
            "vsys": {
                "name": "string",
                "ngfw_device": "string",
            },
        },
        description="string",
        disable_override="string",
        lists=["string"],
        name="string",
        type="string")
    
    const customUrlCategoryResource = new panos.CustomUrlCategory("customUrlCategoryResource", {
        location: {
            deviceGroup: {
                name: "string",
                panoramaDevice: "string",
            },
            shared: {},
            vsys: {
                name: "string",
                ngfwDevice: "string",
            },
        },
        description: "string",
        disableOverride: "string",
        lists: ["string"],
        name: "string",
        type: "string",
    });
    
    type: panos:CustomUrlCategory
    properties:
        description: string
        disableOverride: string
        lists:
            - string
        location:
            deviceGroup:
                name: string
                panoramaDevice: string
            shared: {}
            vsys:
                name: string
                ngfwDevice: string
        name: string
        type: string
    

    CustomUrlCategory 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 CustomUrlCategory resource accepts the following input properties:

    Location CustomUrlCategoryLocation
    The location of this object.
    Description string
    DisableOverride string
    disable object override in child device groups
    Lists List<string>
    Name string
    Type string
    Location CustomUrlCategoryLocationArgs
    The location of this object.
    Description string
    DisableOverride string
    disable object override in child device groups
    Lists []string
    Name string
    Type string
    location CustomUrlCategoryLocation
    The location of this object.
    description String
    disableOverride String
    disable object override in child device groups
    lists List<String>
    name String
    type String
    location CustomUrlCategoryLocation
    The location of this object.
    description string
    disableOverride string
    disable object override in child device groups
    lists string[]
    name string
    type string
    location CustomUrlCategoryLocationArgs
    The location of this object.
    description str
    disable_override str
    disable object override in child device groups
    lists Sequence[str]
    name str
    type str
    location Property Map
    The location of this object.
    description String
    disableOverride String
    disable object override in child device groups
    lists List<String>
    name String
    type String

    Outputs

    All input properties are implicitly available as output properties. Additionally, the CustomUrlCategory 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 CustomUrlCategory Resource

    Get an existing CustomUrlCategory 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?: CustomUrlCategoryState, opts?: CustomResourceOptions): CustomUrlCategory
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            description: Optional[str] = None,
            disable_override: Optional[str] = None,
            lists: Optional[Sequence[str]] = None,
            location: Optional[CustomUrlCategoryLocationArgs] = None,
            name: Optional[str] = None,
            type: Optional[str] = None) -> CustomUrlCategory
    func GetCustomUrlCategory(ctx *Context, name string, id IDInput, state *CustomUrlCategoryState, opts ...ResourceOption) (*CustomUrlCategory, error)
    public static CustomUrlCategory Get(string name, Input<string> id, CustomUrlCategoryState? state, CustomResourceOptions? opts = null)
    public static CustomUrlCategory get(String name, Output<String> id, CustomUrlCategoryState state, CustomResourceOptions options)
    resources:  _:    type: panos:CustomUrlCategory    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:
    Description string
    DisableOverride string
    disable object override in child device groups
    Lists List<string>
    Location CustomUrlCategoryLocation
    The location of this object.
    Name string
    Type string
    Description string
    DisableOverride string
    disable object override in child device groups
    Lists []string
    Location CustomUrlCategoryLocationArgs
    The location of this object.
    Name string
    Type string
    description String
    disableOverride String
    disable object override in child device groups
    lists List<String>
    location CustomUrlCategoryLocation
    The location of this object.
    name String
    type String
    description string
    disableOverride string
    disable object override in child device groups
    lists string[]
    location CustomUrlCategoryLocation
    The location of this object.
    name string
    type string
    description str
    disable_override str
    disable object override in child device groups
    lists Sequence[str]
    location CustomUrlCategoryLocationArgs
    The location of this object.
    name str
    type str
    description String
    disableOverride String
    disable object override in child device groups
    lists List<String>
    location Property Map
    The location of this object.
    name String
    type String

    Supporting Types

    CustomUrlCategoryLocation, CustomUrlCategoryLocationArgs

    DeviceGroup CustomUrlCategoryLocationDeviceGroup
    Located in a specific Device Group
    Shared CustomUrlCategoryLocationShared
    Panorama shared object
    Vsys CustomUrlCategoryLocationVsys
    Located in a specific Virtual System
    DeviceGroup CustomUrlCategoryLocationDeviceGroup
    Located in a specific Device Group
    Shared CustomUrlCategoryLocationShared
    Panorama shared object
    Vsys CustomUrlCategoryLocationVsys
    Located in a specific Virtual System
    deviceGroup CustomUrlCategoryLocationDeviceGroup
    Located in a specific Device Group
    shared CustomUrlCategoryLocationShared
    Panorama shared object
    vsys CustomUrlCategoryLocationVsys
    Located in a specific Virtual System
    deviceGroup CustomUrlCategoryLocationDeviceGroup
    Located in a specific Device Group
    shared CustomUrlCategoryLocationShared
    Panorama shared object
    vsys CustomUrlCategoryLocationVsys
    Located in a specific Virtual System
    device_group CustomUrlCategoryLocationDeviceGroup
    Located in a specific Device Group
    shared CustomUrlCategoryLocationShared
    Panorama shared object
    vsys CustomUrlCategoryLocationVsys
    Located in a specific Virtual System
    deviceGroup Property Map
    Located in a specific Device Group
    shared Property Map
    Panorama shared object
    vsys Property Map
    Located in a specific Virtual System

    CustomUrlCategoryLocationDeviceGroup, CustomUrlCategoryLocationDeviceGroupArgs

    Name string
    Device Group name
    PanoramaDevice string
    Panorama device name
    Name string
    Device Group name
    PanoramaDevice string
    Panorama device name
    name String
    Device Group name
    panoramaDevice String
    Panorama device name
    name string
    Device Group name
    panoramaDevice string
    Panorama device name
    name str
    Device Group name
    panorama_device str
    Panorama device name
    name String
    Device Group name
    panoramaDevice String
    Panorama device name

    CustomUrlCategoryLocationVsys, CustomUrlCategoryLocationVsysArgs

    Name string
    The Virtual System name
    NgfwDevice string
    The NGFW device name
    Name string
    The Virtual System name
    NgfwDevice string
    The NGFW device name
    name String
    The Virtual System name
    ngfwDevice String
    The NGFW device name
    name string
    The Virtual System name
    ngfwDevice string
    The NGFW device name
    name str
    The Virtual System name
    ngfw_device str
    The NGFW device name
    name String
    The Virtual System name
    ngfwDevice String
    The NGFW device name

    Package Details

    Repository
    panos paloaltonetworks/terraform-provider-panos
    License
    Notes
    This Pulumi package is based on the panos Terraform Provider.
    panos logo
    panos 2.0.0 published on Tuesday, Apr 15, 2025 by paloaltonetworks