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

panos.AdministrativeTag

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.AdministrativeTag;
    import com.pulumi.panos.AdministrativeTagArgs;
    import com.pulumi.panos.inputs.AdministrativeTagLocationArgs;
    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 exampleDeviceGroup = new DeviceGroup("exampleDeviceGroup", DeviceGroupArgs.builder()
                .location(DeviceGroupLocationArgs.builder()
                    .panorama()
                    .build())
                .build());
    
            var exampleAdministrativeTag = new AdministrativeTag("exampleAdministrativeTag", AdministrativeTagArgs.builder()
                .location(AdministrativeTagLocationArgs.builder()
                    .device_group(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                    .build())
                .color("color1")
                .build());
    
        }
    }
    
    resources:
      exampleAdministrativeTag:
        type: panos:AdministrativeTag
        properties:
          location:
            device_group:
              name: ${exampleDeviceGroup.name}
          color: color1
      exampleDeviceGroup:
        type: panos:DeviceGroup
        properties:
          location:
            panorama: {}
    

    Create AdministrativeTag Resource

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

    Constructor syntax

    new AdministrativeTag(name: string, args: AdministrativeTagArgs, opts?: CustomResourceOptions);
    @overload
    def AdministrativeTag(resource_name: str,
                          args: AdministrativeTagArgs,
                          opts: Optional[ResourceOptions] = None)
    
    @overload
    def AdministrativeTag(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          location: Optional[AdministrativeTagLocationArgs] = None,
                          color: Optional[str] = None,
                          comments: Optional[str] = None,
                          disable_override: Optional[str] = None,
                          name: Optional[str] = None)
    func NewAdministrativeTag(ctx *Context, name string, args AdministrativeTagArgs, opts ...ResourceOption) (*AdministrativeTag, error)
    public AdministrativeTag(string name, AdministrativeTagArgs args, CustomResourceOptions? opts = null)
    public AdministrativeTag(String name, AdministrativeTagArgs args)
    public AdministrativeTag(String name, AdministrativeTagArgs args, CustomResourceOptions options)
    
    type: panos:AdministrativeTag
    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 AdministrativeTagArgs
    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 AdministrativeTagArgs
    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 AdministrativeTagArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AdministrativeTagArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AdministrativeTagArgs
    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 administrativeTagResource = new Panos.AdministrativeTag("administrativeTagResource", new()
    {
        Location = new Panos.Inputs.AdministrativeTagLocationArgs
        {
            DeviceGroup = new Panos.Inputs.AdministrativeTagLocationDeviceGroupArgs
            {
                Name = "string",
                PanoramaDevice = "string",
            },
            Shared = null,
            Vsys = new Panos.Inputs.AdministrativeTagLocationVsysArgs
            {
                Name = "string",
                NgfwDevice = "string",
            },
        },
        Color = "string",
        Comments = "string",
        DisableOverride = "string",
        Name = "string",
    });
    
    example, err := panos.NewAdministrativeTag(ctx, "administrativeTagResource", &panos.AdministrativeTagArgs{
    	Location: &panos.AdministrativeTagLocationArgs{
    		DeviceGroup: &panos.AdministrativeTagLocationDeviceGroupArgs{
    			Name:           pulumi.String("string"),
    			PanoramaDevice: pulumi.String("string"),
    		},
    		Shared: &panos.AdministrativeTagLocationSharedArgs{},
    		Vsys: &panos.AdministrativeTagLocationVsysArgs{
    			Name:       pulumi.String("string"),
    			NgfwDevice: pulumi.String("string"),
    		},
    	},
    	Color:           pulumi.String("string"),
    	Comments:        pulumi.String("string"),
    	DisableOverride: pulumi.String("string"),
    	Name:            pulumi.String("string"),
    })
    
    var administrativeTagResource = new AdministrativeTag("administrativeTagResource", AdministrativeTagArgs.builder()
        .location(AdministrativeTagLocationArgs.builder()
            .deviceGroup(AdministrativeTagLocationDeviceGroupArgs.builder()
                .name("string")
                .panoramaDevice("string")
                .build())
            .shared()
            .vsys(AdministrativeTagLocationVsysArgs.builder()
                .name("string")
                .ngfwDevice("string")
                .build())
            .build())
        .color("string")
        .comments("string")
        .disableOverride("string")
        .name("string")
        .build());
    
    administrative_tag_resource = panos.AdministrativeTag("administrativeTagResource",
        location={
            "device_group": {
                "name": "string",
                "panorama_device": "string",
            },
            "shared": {},
            "vsys": {
                "name": "string",
                "ngfw_device": "string",
            },
        },
        color="string",
        comments="string",
        disable_override="string",
        name="string")
    
    const administrativeTagResource = new panos.AdministrativeTag("administrativeTagResource", {
        location: {
            deviceGroup: {
                name: "string",
                panoramaDevice: "string",
            },
            shared: {},
            vsys: {
                name: "string",
                ngfwDevice: "string",
            },
        },
        color: "string",
        comments: "string",
        disableOverride: "string",
        name: "string",
    });
    
    type: panos:AdministrativeTag
    properties:
        color: string
        comments: string
        disableOverride: string
        location:
            deviceGroup:
                name: string
                panoramaDevice: string
            shared: {}
            vsys:
                name: string
                ngfwDevice: string
        name: string
    

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

    Location AdministrativeTagLocation
    The location of this object.
    Color string
    Comments string
    DisableOverride string
    disable object override in child device groups
    Name string
    Location AdministrativeTagLocationArgs
    The location of this object.
    Color string
    Comments string
    DisableOverride string
    disable object override in child device groups
    Name string
    location AdministrativeTagLocation
    The location of this object.
    color String
    comments String
    disableOverride String
    disable object override in child device groups
    name String
    location AdministrativeTagLocation
    The location of this object.
    color string
    comments string
    disableOverride string
    disable object override in child device groups
    name string
    location AdministrativeTagLocationArgs
    The location of this object.
    color str
    comments str
    disable_override str
    disable object override in child device groups
    name str
    location Property Map
    The location of this object.
    color String
    comments String
    disableOverride String
    disable object override in child device groups
    name String

    Outputs

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

    Get an existing AdministrativeTag 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?: AdministrativeTagState, opts?: CustomResourceOptions): AdministrativeTag
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            color: Optional[str] = None,
            comments: Optional[str] = None,
            disable_override: Optional[str] = None,
            location: Optional[AdministrativeTagLocationArgs] = None,
            name: Optional[str] = None) -> AdministrativeTag
    func GetAdministrativeTag(ctx *Context, name string, id IDInput, state *AdministrativeTagState, opts ...ResourceOption) (*AdministrativeTag, error)
    public static AdministrativeTag Get(string name, Input<string> id, AdministrativeTagState? state, CustomResourceOptions? opts = null)
    public static AdministrativeTag get(String name, Output<String> id, AdministrativeTagState state, CustomResourceOptions options)
    resources:  _:    type: panos:AdministrativeTag    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:
    Color string
    Comments string
    DisableOverride string
    disable object override in child device groups
    Location AdministrativeTagLocation
    The location of this object.
    Name string
    Color string
    Comments string
    DisableOverride string
    disable object override in child device groups
    Location AdministrativeTagLocationArgs
    The location of this object.
    Name string
    color String
    comments String
    disableOverride String
    disable object override in child device groups
    location AdministrativeTagLocation
    The location of this object.
    name String
    color string
    comments string
    disableOverride string
    disable object override in child device groups
    location AdministrativeTagLocation
    The location of this object.
    name string
    color str
    comments str
    disable_override str
    disable object override in child device groups
    location AdministrativeTagLocationArgs
    The location of this object.
    name str
    color String
    comments String
    disableOverride String
    disable object override in child device groups
    location Property Map
    The location of this object.
    name String

    Supporting Types

    AdministrativeTagLocation, AdministrativeTagLocationArgs

    DeviceGroup AdministrativeTagLocationDeviceGroup
    Located in a specific Device Group
    Shared AdministrativeTagLocationShared
    Panorama shared object
    Vsys AdministrativeTagLocationVsys
    Located in a specific Virtual System
    DeviceGroup AdministrativeTagLocationDeviceGroup
    Located in a specific Device Group
    Shared AdministrativeTagLocationShared
    Panorama shared object
    Vsys AdministrativeTagLocationVsys
    Located in a specific Virtual System
    deviceGroup AdministrativeTagLocationDeviceGroup
    Located in a specific Device Group
    shared AdministrativeTagLocationShared
    Panorama shared object
    vsys AdministrativeTagLocationVsys
    Located in a specific Virtual System
    deviceGroup AdministrativeTagLocationDeviceGroup
    Located in a specific Device Group
    shared AdministrativeTagLocationShared
    Panorama shared object
    vsys AdministrativeTagLocationVsys
    Located in a specific Virtual System
    device_group AdministrativeTagLocationDeviceGroup
    Located in a specific Device Group
    shared AdministrativeTagLocationShared
    Panorama shared object
    vsys AdministrativeTagLocationVsys
    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

    AdministrativeTagLocationDeviceGroup, AdministrativeTagLocationDeviceGroupArgs

    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

    AdministrativeTagLocationVsys, AdministrativeTagLocationVsysArgs

    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