1. Packages
  2. Azure Native
  3. API Docs
  4. mobilenetwork
  5. PacketCapture
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.47.1 published on Monday, Jun 24, 2024 by Pulumi

azure-native.mobilenetwork.PacketCapture

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.47.1 published on Monday, Jun 24, 2024 by Pulumi

    Packet capture session resource. Azure REST API version: 2023-06-01.

    Other available API versions: 2023-09-01, 2024-02-01, 2024-04-01.

    Example Usage

    Create packet capture

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var packetCapture = new AzureNative.MobileNetwork.PacketCapture("packetCapture", new()
        {
            BytesToCapturePerPacket = 10000,
            NetworkInterfaces = new[]
            {
                "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/TestPacketCoreCP",
                "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/TestPacketCoreCP/packetCoreDataPlanes/TestPacketCoreDP",
                "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/TestPacketCoreCP/packetCoreDataPlanes/TestPacketCoreDP/attachedDataNetworks/TestADN",
            },
            PacketCaptureName = "pc1",
            PacketCoreControlPlaneName = "TestPacketCoreCP",
            ResourceGroupName = "rg1",
            TimeLimitInSeconds = 100,
            TotalBytesPerSession = 100000,
        });
    
    });
    
    package main
    
    import (
    	mobilenetwork "github.com/pulumi/pulumi-azure-native-sdk/mobilenetwork/v2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := mobilenetwork.NewPacketCapture(ctx, "packetCapture", &mobilenetwork.PacketCaptureArgs{
    			BytesToCapturePerPacket: pulumi.Float64(10000),
    			NetworkInterfaces: pulumi.StringArray{
    				pulumi.String("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/TestPacketCoreCP"),
    				pulumi.String("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/TestPacketCoreCP/packetCoreDataPlanes/TestPacketCoreDP"),
    				pulumi.String("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/TestPacketCoreCP/packetCoreDataPlanes/TestPacketCoreDP/attachedDataNetworks/TestADN"),
    			},
    			PacketCaptureName:          pulumi.String("pc1"),
    			PacketCoreControlPlaneName: pulumi.String("TestPacketCoreCP"),
    			ResourceGroupName:          pulumi.String("rg1"),
    			TimeLimitInSeconds:         pulumi.Int(100),
    			TotalBytesPerSession:       pulumi.Float64(100000),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azurenative.mobilenetwork.PacketCapture;
    import com.pulumi.azurenative.mobilenetwork.PacketCaptureArgs;
    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 packetCapture = new PacketCapture("packetCapture", PacketCaptureArgs.builder()
                .bytesToCapturePerPacket(10000)
                .networkInterfaces(            
                    "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/TestPacketCoreCP",
                    "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/TestPacketCoreCP/packetCoreDataPlanes/TestPacketCoreDP",
                    "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/TestPacketCoreCP/packetCoreDataPlanes/TestPacketCoreDP/attachedDataNetworks/TestADN")
                .packetCaptureName("pc1")
                .packetCoreControlPlaneName("TestPacketCoreCP")
                .resourceGroupName("rg1")
                .timeLimitInSeconds(100)
                .totalBytesPerSession(100000)
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    packet_capture = azure_native.mobilenetwork.PacketCapture("packetCapture",
        bytes_to_capture_per_packet=10000,
        network_interfaces=[
            "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/TestPacketCoreCP",
            "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/TestPacketCoreCP/packetCoreDataPlanes/TestPacketCoreDP",
            "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/TestPacketCoreCP/packetCoreDataPlanes/TestPacketCoreDP/attachedDataNetworks/TestADN",
        ],
        packet_capture_name="pc1",
        packet_core_control_plane_name="TestPacketCoreCP",
        resource_group_name="rg1",
        time_limit_in_seconds=100,
        total_bytes_per_session=100000)
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const packetCapture = new azure_native.mobilenetwork.PacketCapture("packetCapture", {
        bytesToCapturePerPacket: 10000,
        networkInterfaces: [
            "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/TestPacketCoreCP",
            "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/TestPacketCoreCP/packetCoreDataPlanes/TestPacketCoreDP",
            "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/TestPacketCoreCP/packetCoreDataPlanes/TestPacketCoreDP/attachedDataNetworks/TestADN",
        ],
        packetCaptureName: "pc1",
        packetCoreControlPlaneName: "TestPacketCoreCP",
        resourceGroupName: "rg1",
        timeLimitInSeconds: 100,
        totalBytesPerSession: 100000,
    });
    
    resources:
      packetCapture:
        type: azure-native:mobilenetwork:PacketCapture
        properties:
          bytesToCapturePerPacket: 10000
          networkInterfaces:
            - /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/TestPacketCoreCP
            - /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/TestPacketCoreCP/packetCoreDataPlanes/TestPacketCoreDP
            - /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/TestPacketCoreCP/packetCoreDataPlanes/TestPacketCoreDP/attachedDataNetworks/TestADN
          packetCaptureName: pc1
          packetCoreControlPlaneName: TestPacketCoreCP
          resourceGroupName: rg1
          timeLimitInSeconds: 100
          totalBytesPerSession: 100000
    

    Create PacketCapture Resource

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

    Constructor syntax

    new PacketCapture(name: string, args: PacketCaptureArgs, opts?: CustomResourceOptions);
    @overload
    def PacketCapture(resource_name: str,
                      args: PacketCaptureArgs,
                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def PacketCapture(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      packet_core_control_plane_name: Optional[str] = None,
                      resource_group_name: Optional[str] = None,
                      bytes_to_capture_per_packet: Optional[float] = None,
                      network_interfaces: Optional[Sequence[str]] = None,
                      packet_capture_name: Optional[str] = None,
                      time_limit_in_seconds: Optional[int] = None,
                      total_bytes_per_session: Optional[float] = None)
    func NewPacketCapture(ctx *Context, name string, args PacketCaptureArgs, opts ...ResourceOption) (*PacketCapture, error)
    public PacketCapture(string name, PacketCaptureArgs args, CustomResourceOptions? opts = null)
    public PacketCapture(String name, PacketCaptureArgs args)
    public PacketCapture(String name, PacketCaptureArgs args, CustomResourceOptions options)
    
    type: azure-native:mobilenetwork:PacketCapture
    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 PacketCaptureArgs
    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 PacketCaptureArgs
    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 PacketCaptureArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PacketCaptureArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PacketCaptureArgs
    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 packetCaptureResource = new AzureNative.MobileNetwork.PacketCapture("packetCaptureResource", new()
    {
        PacketCoreControlPlaneName = "string",
        ResourceGroupName = "string",
        BytesToCapturePerPacket = 0,
        NetworkInterfaces = new[]
        {
            "string",
        },
        PacketCaptureName = "string",
        TimeLimitInSeconds = 0,
        TotalBytesPerSession = 0,
    });
    
    example, err := mobilenetwork.NewPacketCapture(ctx, "packetCaptureResource", &mobilenetwork.PacketCaptureArgs{
    PacketCoreControlPlaneName: pulumi.String("string"),
    ResourceGroupName: pulumi.String("string"),
    BytesToCapturePerPacket: pulumi.Float64(0),
    NetworkInterfaces: pulumi.StringArray{
    pulumi.String("string"),
    },
    PacketCaptureName: pulumi.String("string"),
    TimeLimitInSeconds: pulumi.Int(0),
    TotalBytesPerSession: pulumi.Float64(0),
    })
    
    var packetCaptureResource = new PacketCapture("packetCaptureResource", PacketCaptureArgs.builder()
        .packetCoreControlPlaneName("string")
        .resourceGroupName("string")
        .bytesToCapturePerPacket(0)
        .networkInterfaces("string")
        .packetCaptureName("string")
        .timeLimitInSeconds(0)
        .totalBytesPerSession(0)
        .build());
    
    packet_capture_resource = azure_native.mobilenetwork.PacketCapture("packetCaptureResource",
        packet_core_control_plane_name="string",
        resource_group_name="string",
        bytes_to_capture_per_packet=0,
        network_interfaces=["string"],
        packet_capture_name="string",
        time_limit_in_seconds=0,
        total_bytes_per_session=0)
    
    const packetCaptureResource = new azure_native.mobilenetwork.PacketCapture("packetCaptureResource", {
        packetCoreControlPlaneName: "string",
        resourceGroupName: "string",
        bytesToCapturePerPacket: 0,
        networkInterfaces: ["string"],
        packetCaptureName: "string",
        timeLimitInSeconds: 0,
        totalBytesPerSession: 0,
    });
    
    type: azure-native:mobilenetwork:PacketCapture
    properties:
        bytesToCapturePerPacket: 0
        networkInterfaces:
            - string
        packetCaptureName: string
        packetCoreControlPlaneName: string
        resourceGroupName: string
        timeLimitInSeconds: 0
        totalBytesPerSession: 0
    

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

    PacketCoreControlPlaneName string
    The name of the packet core control plane.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    BytesToCapturePerPacket double
    Number of bytes captured per packet, the remaining bytes are truncated. The default "0" means the entire packet is captured.
    NetworkInterfaces List<string>
    List of network interfaces to capture on.
    PacketCaptureName string
    The name of the packet capture session.
    TimeLimitInSeconds int
    Maximum duration of the capture session in seconds.
    TotalBytesPerSession double
    Maximum size of the capture output.
    PacketCoreControlPlaneName string
    The name of the packet core control plane.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    BytesToCapturePerPacket float64
    Number of bytes captured per packet, the remaining bytes are truncated. The default "0" means the entire packet is captured.
    NetworkInterfaces []string
    List of network interfaces to capture on.
    PacketCaptureName string
    The name of the packet capture session.
    TimeLimitInSeconds int
    Maximum duration of the capture session in seconds.
    TotalBytesPerSession float64
    Maximum size of the capture output.
    packetCoreControlPlaneName String
    The name of the packet core control plane.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    bytesToCapturePerPacket Double
    Number of bytes captured per packet, the remaining bytes are truncated. The default "0" means the entire packet is captured.
    networkInterfaces List<String>
    List of network interfaces to capture on.
    packetCaptureName String
    The name of the packet capture session.
    timeLimitInSeconds Integer
    Maximum duration of the capture session in seconds.
    totalBytesPerSession Double
    Maximum size of the capture output.
    packetCoreControlPlaneName string
    The name of the packet core control plane.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    bytesToCapturePerPacket number
    Number of bytes captured per packet, the remaining bytes are truncated. The default "0" means the entire packet is captured.
    networkInterfaces string[]
    List of network interfaces to capture on.
    packetCaptureName string
    The name of the packet capture session.
    timeLimitInSeconds number
    Maximum duration of the capture session in seconds.
    totalBytesPerSession number
    Maximum size of the capture output.
    packet_core_control_plane_name str
    The name of the packet core control plane.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    bytes_to_capture_per_packet float
    Number of bytes captured per packet, the remaining bytes are truncated. The default "0" means the entire packet is captured.
    network_interfaces Sequence[str]
    List of network interfaces to capture on.
    packet_capture_name str
    The name of the packet capture session.
    time_limit_in_seconds int
    Maximum duration of the capture session in seconds.
    total_bytes_per_session float
    Maximum size of the capture output.
    packetCoreControlPlaneName String
    The name of the packet core control plane.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    bytesToCapturePerPacket Number
    Number of bytes captured per packet, the remaining bytes are truncated. The default "0" means the entire packet is captured.
    networkInterfaces List<String>
    List of network interfaces to capture on.
    packetCaptureName String
    The name of the packet capture session.
    timeLimitInSeconds Number
    Maximum duration of the capture session in seconds.
    totalBytesPerSession Number
    Maximum size of the capture output.

    Outputs

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

    CaptureStartTime string
    The start time of the packet capture session.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    ProvisioningState string
    The provisioning state of the packet capture session resource.
    Reason string
    The reason the current packet capture session state.
    Status string
    The status of the packet capture session.
    SystemData Pulumi.AzureNative.MobileNetwork.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    CaptureStartTime string
    The start time of the packet capture session.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    ProvisioningState string
    The provisioning state of the packet capture session resource.
    Reason string
    The reason the current packet capture session state.
    Status string
    The status of the packet capture session.
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    captureStartTime String
    The start time of the packet capture session.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    provisioningState String
    The provisioning state of the packet capture session resource.
    reason String
    The reason the current packet capture session state.
    status String
    The status of the packet capture session.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    captureStartTime string
    The start time of the packet capture session.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The name of the resource
    provisioningState string
    The provisioning state of the packet capture session resource.
    reason string
    The reason the current packet capture session state.
    status string
    The status of the packet capture session.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    capture_start_time str
    The start time of the packet capture session.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The name of the resource
    provisioning_state str
    The provisioning state of the packet capture session resource.
    reason str
    The reason the current packet capture session state.
    status str
    The status of the packet capture session.
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    captureStartTime String
    The start time of the packet capture session.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    provisioningState String
    The provisioning state of the packet capture session resource.
    reason String
    The reason the current packet capture session state.
    status String
    The status of the packet capture session.
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    Supporting Types

    SystemDataResponse, SystemDataResponseArgs

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:mobilenetwork:PacketCapture pc1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/{packetCoreControlPlaneName}/packetCaptures/{packetCaptureName} 
    

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

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.47.1 published on Monday, Jun 24, 2024 by Pulumi