pulumi-azure-native 2.29.1a1708510433__py3-none-any.whl → 2.29.1a1708705299__py3-none-any.whl

pulumi_azure_native/mobilenetwork/v20240201/packet_capture.py

@@ -0,0 +1,363 @@
+# coding=utf-8
+# *** WARNING: this file was generated by pulumi-language-python. ***
+# *** Do not edit by hand unless you're certain you know what you are doing! ***
+
+import copy
+import warnings
+import pulumi
+import pulumi.runtime
+from typing import Any, Mapping, Optional, Sequence, Union, overload
+from ... import _utilities
+from . import outputs
+
+__all__ = ['PacketCaptureArgs', 'PacketCapture']
+
+@pulumi.input_type
+class PacketCaptureArgs:
+    def __init__(__self__, *,
+                 packet_core_control_plane_name: pulumi.Input[str],
+                 resource_group_name: pulumi.Input[str],
+                 bytes_to_capture_per_packet: Optional[pulumi.Input[float]] = None,
+                 network_interfaces: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
+                 packet_capture_name: Optional[pulumi.Input[str]] = None,
+                 time_limit_in_seconds: Optional[pulumi.Input[int]] = None,
+                 total_bytes_per_session: Optional[pulumi.Input[float]] = None):
+        """
+        The set of arguments for constructing a PacketCapture resource.
+        :param pulumi.Input[str] packet_core_control_plane_name: The name of the packet core control plane.
+        :param pulumi.Input[str] resource_group_name: The name of the resource group. The name is case insensitive.
+        :param pulumi.Input[float] bytes_to_capture_per_packet: Number of bytes captured per packet, the remaining bytes are truncated. The default "0" means the entire packet is captured.
+        :param pulumi.Input[Sequence[pulumi.Input[str]]] network_interfaces: List of network interfaces to capture on.
+        :param pulumi.Input[str] packet_capture_name: The name of the packet capture session.
+        :param pulumi.Input[int] time_limit_in_seconds: Maximum duration of the capture session in seconds.
+        :param pulumi.Input[float] total_bytes_per_session: Maximum size of the capture output.
+        """
+        pulumi.set(__self__, "packet_core_control_plane_name", packet_core_control_plane_name)
+        pulumi.set(__self__, "resource_group_name", resource_group_name)
+        if bytes_to_capture_per_packet is None:
+            bytes_to_capture_per_packet = 0
+        if bytes_to_capture_per_packet is not None:
+            pulumi.set(__self__, "bytes_to_capture_per_packet", bytes_to_capture_per_packet)
+        if network_interfaces is not None:
+            pulumi.set(__self__, "network_interfaces", network_interfaces)
+        if packet_capture_name is not None:
+            pulumi.set(__self__, "packet_capture_name", packet_capture_name)
+        if time_limit_in_seconds is None:
+            time_limit_in_seconds = 18000
+        if time_limit_in_seconds is not None:
+            pulumi.set(__self__, "time_limit_in_seconds", time_limit_in_seconds)
+        if total_bytes_per_session is None:
+            total_bytes_per_session = 67108864
+        if total_bytes_per_session is not None:
+            pulumi.set(__self__, "total_bytes_per_session", total_bytes_per_session)
+
+    @property
+    @pulumi.getter(name="packetCoreControlPlaneName")
+    def packet_core_control_plane_name(self) -> pulumi.Input[str]:
+        """
+        The name of the packet core control plane.
+        """
+        return pulumi.get(self, "packet_core_control_plane_name")
+
+    @packet_core_control_plane_name.setter
+    def packet_core_control_plane_name(self, value: pulumi.Input[str]):
+        pulumi.set(self, "packet_core_control_plane_name", value)
+
+    @property
+    @pulumi.getter(name="resourceGroupName")
+    def resource_group_name(self) -> pulumi.Input[str]:
+        """
+        The name of the resource group. The name is case insensitive.
+        """
+        return pulumi.get(self, "resource_group_name")
+
+    @resource_group_name.setter
+    def resource_group_name(self, value: pulumi.Input[str]):
+        pulumi.set(self, "resource_group_name", value)
+
+    @property
+    @pulumi.getter(name="bytesToCapturePerPacket")
+    def bytes_to_capture_per_packet(self) -> Optional[pulumi.Input[float]]:
+        """
+        Number of bytes captured per packet, the remaining bytes are truncated. The default "0" means the entire packet is captured.
+        """
+        return pulumi.get(self, "bytes_to_capture_per_packet")
+
+    @bytes_to_capture_per_packet.setter
+    def bytes_to_capture_per_packet(self, value: Optional[pulumi.Input[float]]):
+        pulumi.set(self, "bytes_to_capture_per_packet", value)
+
+    @property
+    @pulumi.getter(name="networkInterfaces")
+    def network_interfaces(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
+        """
+        List of network interfaces to capture on.
+        """
+        return pulumi.get(self, "network_interfaces")
+
+    @network_interfaces.setter
+    def network_interfaces(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
+        pulumi.set(self, "network_interfaces", value)
+
+    @property
+    @pulumi.getter(name="packetCaptureName")
+    def packet_capture_name(self) -> Optional[pulumi.Input[str]]:
+        """
+        The name of the packet capture session.
+        """
+        return pulumi.get(self, "packet_capture_name")
+
+    @packet_capture_name.setter
+    def packet_capture_name(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "packet_capture_name", value)
+
+    @property
+    @pulumi.getter(name="timeLimitInSeconds")
+    def time_limit_in_seconds(self) -> Optional[pulumi.Input[int]]:
+        """
+        Maximum duration of the capture session in seconds.
+        """
+        return pulumi.get(self, "time_limit_in_seconds")
+
+    @time_limit_in_seconds.setter
+    def time_limit_in_seconds(self, value: Optional[pulumi.Input[int]]):
+        pulumi.set(self, "time_limit_in_seconds", value)
+
+    @property
+    @pulumi.getter(name="totalBytesPerSession")
+    def total_bytes_per_session(self) -> Optional[pulumi.Input[float]]:
+        """
+        Maximum size of the capture output.
+        """
+        return pulumi.get(self, "total_bytes_per_session")
+
+    @total_bytes_per_session.setter
+    def total_bytes_per_session(self, value: Optional[pulumi.Input[float]]):
+        pulumi.set(self, "total_bytes_per_session", value)
+
+
+class PacketCapture(pulumi.CustomResource):
+    @overload
+    def __init__(__self__,
+                 resource_name: str,
+                 opts: Optional[pulumi.ResourceOptions] = None,
+                 bytes_to_capture_per_packet: Optional[pulumi.Input[float]] = None,
+                 network_interfaces: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
+                 packet_capture_name: Optional[pulumi.Input[str]] = None,
+                 packet_core_control_plane_name: Optional[pulumi.Input[str]] = None,
+                 resource_group_name: Optional[pulumi.Input[str]] = None,
+                 time_limit_in_seconds: Optional[pulumi.Input[int]] = None,
+                 total_bytes_per_session: Optional[pulumi.Input[float]] = None,
+                 __props__=None):
+        """
+        Packet capture session resource.
+
+        :param str resource_name: The name of the resource.
+        :param pulumi.ResourceOptions opts: Options for the resource.
+        :param pulumi.Input[float] bytes_to_capture_per_packet: Number of bytes captured per packet, the remaining bytes are truncated. The default "0" means the entire packet is captured.
+        :param pulumi.Input[Sequence[pulumi.Input[str]]] network_interfaces: List of network interfaces to capture on.
+        :param pulumi.Input[str] packet_capture_name: The name of the packet capture session.
+        :param pulumi.Input[str] packet_core_control_plane_name: The name of the packet core control plane.
+        :param pulumi.Input[str] resource_group_name: The name of the resource group. The name is case insensitive.
+        :param pulumi.Input[int] time_limit_in_seconds: Maximum duration of the capture session in seconds.
+        :param pulumi.Input[float] total_bytes_per_session: Maximum size of the capture output.
+        """
+        ...
+    @overload
+    def __init__(__self__,
+                 resource_name: str,
+                 args: PacketCaptureArgs,
+                 opts: Optional[pulumi.ResourceOptions] = None):
+        """
+        Packet capture session resource.
+
+        :param str resource_name: The name of the resource.
+        :param PacketCaptureArgs args: The arguments to use to populate this resource's properties.
+        :param pulumi.ResourceOptions opts: Options for the resource.
+        """
+        ...
+    def __init__(__self__, resource_name: str, *args, **kwargs):
+        resource_args, opts = _utilities.get_resource_args_opts(PacketCaptureArgs, pulumi.ResourceOptions, *args, **kwargs)
+        if resource_args is not None:
+            __self__._internal_init(resource_name, opts, **resource_args.__dict__)
+        else:
+            __self__._internal_init(resource_name, *args, **kwargs)
+
+    def _internal_init(__self__,
+                 resource_name: str,
+                 opts: Optional[pulumi.ResourceOptions] = None,
+                 bytes_to_capture_per_packet: Optional[pulumi.Input[float]] = None,
+                 network_interfaces: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
+                 packet_capture_name: Optional[pulumi.Input[str]] = None,
+                 packet_core_control_plane_name: Optional[pulumi.Input[str]] = None,
+                 resource_group_name: Optional[pulumi.Input[str]] = None,
+                 time_limit_in_seconds: Optional[pulumi.Input[int]] = None,
+                 total_bytes_per_session: Optional[pulumi.Input[float]] = None,
+                 __props__=None):
+        opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts)
+        if not isinstance(opts, pulumi.ResourceOptions):
+            raise TypeError('Expected resource options to be a ResourceOptions instance')
+        if opts.id is None:
+            if __props__ is not None:
+                raise TypeError('__props__ is only valid when passed in combination with a valid opts.id to get an existing resource')
+            __props__ = PacketCaptureArgs.__new__(PacketCaptureArgs)
+
+            if bytes_to_capture_per_packet is None:
+                bytes_to_capture_per_packet = 0
+            __props__.__dict__["bytes_to_capture_per_packet"] = bytes_to_capture_per_packet
+            __props__.__dict__["network_interfaces"] = network_interfaces
+            __props__.__dict__["packet_capture_name"] = packet_capture_name
+            if packet_core_control_plane_name is None and not opts.urn:
+                raise TypeError("Missing required property 'packet_core_control_plane_name'")
+            __props__.__dict__["packet_core_control_plane_name"] = packet_core_control_plane_name
+            if resource_group_name is None and not opts.urn:
+                raise TypeError("Missing required property 'resource_group_name'")
+            __props__.__dict__["resource_group_name"] = resource_group_name
+            if time_limit_in_seconds is None:
+                time_limit_in_seconds = 18000
+            __props__.__dict__["time_limit_in_seconds"] = time_limit_in_seconds
+            if total_bytes_per_session is None:
+                total_bytes_per_session = 67108864
+            __props__.__dict__["total_bytes_per_session"] = total_bytes_per_session
+            __props__.__dict__["capture_start_time"] = None
+            __props__.__dict__["name"] = None
+            __props__.__dict__["output_files"] = None
+            __props__.__dict__["provisioning_state"] = None
+            __props__.__dict__["reason"] = None
+            __props__.__dict__["status"] = None
+            __props__.__dict__["system_data"] = None
+            __props__.__dict__["type"] = None
+        alias_opts = pulumi.ResourceOptions(aliases=[pulumi.Alias(type_="azure-native:mobilenetwork:PacketCapture"), pulumi.Alias(type_="azure-native:mobilenetwork/v20230601:PacketCapture"), pulumi.Alias(type_="azure-native:mobilenetwork/v20230901:PacketCapture")])
+        opts = pulumi.ResourceOptions.merge(opts, alias_opts)
+        super(PacketCapture, __self__).__init__(
+            'azure-native:mobilenetwork/v20240201:PacketCapture',
+            resource_name,
+            __props__,
+            opts)
+
+    @staticmethod
+    def get(resource_name: str,
+            id: pulumi.Input[str],
+            opts: Optional[pulumi.ResourceOptions] = None) -> 'PacketCapture':
+        """
+        Get an existing PacketCapture resource's state with the given name, id, and optional extra
+        properties used to qualify the lookup.
+
+        :param str resource_name: The unique name of the resulting resource.
+        :param pulumi.Input[str] id: The unique provider ID of the resource to lookup.
+        :param pulumi.ResourceOptions opts: Options for the resource.
+        """
+        opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
+
+        __props__ = PacketCaptureArgs.__new__(PacketCaptureArgs)
+
+        __props__.__dict__["bytes_to_capture_per_packet"] = None
+        __props__.__dict__["capture_start_time"] = None
+        __props__.__dict__["name"] = None
+        __props__.__dict__["network_interfaces"] = None
+        __props__.__dict__["output_files"] = None
+        __props__.__dict__["provisioning_state"] = None
+        __props__.__dict__["reason"] = None
+        __props__.__dict__["status"] = None
+        __props__.__dict__["system_data"] = None
+        __props__.__dict__["time_limit_in_seconds"] = None
+        __props__.__dict__["total_bytes_per_session"] = None
+        __props__.__dict__["type"] = None
+        return PacketCapture(resource_name, opts=opts, __props__=__props__)
+
+    @property
+    @pulumi.getter(name="bytesToCapturePerPacket")
+    def bytes_to_capture_per_packet(self) -> pulumi.Output[Optional[float]]:
+        """
+        Number of bytes captured per packet, the remaining bytes are truncated. The default "0" means the entire packet is captured.
+        """
+        return pulumi.get(self, "bytes_to_capture_per_packet")
+
+    @property
+    @pulumi.getter(name="captureStartTime")
+    def capture_start_time(self) -> pulumi.Output[str]:
+        """
+        The start time of the packet capture session.
+        """
+        return pulumi.get(self, "capture_start_time")
+
+    @property
+    @pulumi.getter
+    def name(self) -> pulumi.Output[str]:
+        """
+        The name of the resource
+        """
+        return pulumi.get(self, "name")
+
+    @property
+    @pulumi.getter(name="networkInterfaces")
+    def network_interfaces(self) -> pulumi.Output[Optional[Sequence[str]]]:
+        """
+        List of network interfaces to capture on.
+        """
+        return pulumi.get(self, "network_interfaces")
+
+    @property
+    @pulumi.getter(name="outputFiles")
+    def output_files(self) -> pulumi.Output[Sequence[str]]:
+        """
+        The list of output files of a packet capture session.
+        """
+        return pulumi.get(self, "output_files")
+
+    @property
+    @pulumi.getter(name="provisioningState")
+    def provisioning_state(self) -> pulumi.Output[str]:
+        """
+        The provisioning state of the packet capture session resource.
+        """
+        return pulumi.get(self, "provisioning_state")
+
+    @property
+    @pulumi.getter
+    def reason(self) -> pulumi.Output[str]:
+        """
+        The reason the current packet capture session state.
+        """
+        return pulumi.get(self, "reason")
+
+    @property
+    @pulumi.getter
+    def status(self) -> pulumi.Output[str]:
+        """
+        The status of the packet capture session.
+        """
+        return pulumi.get(self, "status")
+
+    @property
+    @pulumi.getter(name="systemData")
+    def system_data(self) -> pulumi.Output['outputs.SystemDataResponse']:
+        """
+        Azure Resource Manager metadata containing createdBy and modifiedBy information.
+        """
+        return pulumi.get(self, "system_data")
+
+    @property
+    @pulumi.getter(name="timeLimitInSeconds")
+    def time_limit_in_seconds(self) -> pulumi.Output[Optional[int]]:
+        """
+        Maximum duration of the capture session in seconds.
+        """
+        return pulumi.get(self, "time_limit_in_seconds")
+
+    @property
+    @pulumi.getter(name="totalBytesPerSession")
+    def total_bytes_per_session(self) -> pulumi.Output[Optional[float]]:
+        """
+        Maximum size of the capture output.
+        """
+        return pulumi.get(self, "total_bytes_per_session")
+
+    @property
+    @pulumi.getter
+    def type(self) -> pulumi.Output[str]:
+        """
+        The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
+        """
+        return pulumi.get(self, "type")
+