com.pulumi.azurenative.network.PacketCapture Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure-native Show documentation
Show all versions of azure-native Show documentation
A native Pulumi package for creating and managing Azure resources.
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package com.pulumi.azurenative.network;
import com.pulumi.azurenative.Utilities;
import com.pulumi.azurenative.network.PacketCaptureArgs;
import com.pulumi.azurenative.network.outputs.PacketCaptureFilterResponse;
import com.pulumi.azurenative.network.outputs.PacketCaptureMachineScopeResponse;
import com.pulumi.azurenative.network.outputs.PacketCaptureStorageLocationResponse;
import com.pulumi.core.Alias;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Export;
import com.pulumi.core.annotations.ResourceType;
import com.pulumi.core.internal.Codegen;
import java.lang.Double;
import java.lang.Integer;
import java.lang.String;
import java.util.List;
import java.util.Optional;
import javax.annotation.Nullable;
/**
* Information about packet capture session.
* Azure REST API version: 2023-02-01. Prior API version in Azure Native 1.x: 2020-11-01.
*
* Other available API versions: 2018-01-01, 2020-06-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01.
*
* ## Example Usage
* ### Create packet capture
*
*
* {@code
* package generated_program;
*
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.azurenative.network.PacketCapture;
* import com.pulumi.azurenative.network.PacketCaptureArgs;
* import com.pulumi.azurenative.network.inputs.PacketCaptureFilterArgs;
* import com.pulumi.azurenative.network.inputs.PacketCaptureStorageLocationArgs;
* 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)
* .filters(PacketCaptureFilterArgs.builder()
* .localIPAddress("10.0.0.4")
* .localPort("80")
* .protocol("TCP")
* .build())
* .networkWatcherName("nw1")
* .packetCaptureName("pc1")
* .resourceGroupName("rg1")
* .storageLocation(PacketCaptureStorageLocationArgs.builder()
* .filePath("D:\\capture\\pc1.cap")
* .storageId("/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Storage/storageAccounts/pcstore")
* .storagePath("https://mytestaccountname.blob.core.windows.net/capture/pc1.cap")
* .build())
* .target("/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1")
* .timeLimitInSeconds(100)
* .totalBytesPerSession(100000)
* .build());
*
* }
* }
*
* }
*
*
* ## Import
*
* An existing resource can be imported using its type token, name, and identifier, e.g.
*
* ```sh
* $ pulumi import azure-native:network:PacketCapture pc1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/packetCaptures/{packetCaptureName}
* ```
*
*/
@ResourceType(type="azure-native:network:PacketCapture")
public class PacketCapture extends com.pulumi.resources.CustomResource {
/**
* Number of bytes captured per packet, the remaining bytes are truncated.
*
*/
@Export(name="bytesToCapturePerPacket", refs={Double.class}, tree="[0]")
private Output bytesToCapturePerPacket;
/**
* @return Number of bytes captured per packet, the remaining bytes are truncated.
*
*/
public Output> bytesToCapturePerPacket() {
return Codegen.optional(this.bytesToCapturePerPacket);
}
/**
* A unique read-only string that changes whenever the resource is updated.
*
*/
@Export(name="etag", refs={String.class}, tree="[0]")
private Output etag;
/**
* @return A unique read-only string that changes whenever the resource is updated.
*
*/
public Output etag() {
return this.etag;
}
/**
* A list of packet capture filters.
*
*/
@Export(name="filters", refs={List.class,PacketCaptureFilterResponse.class}, tree="[0,1]")
private Output> filters;
/**
* @return A list of packet capture filters.
*
*/
public Output>> filters() {
return Codegen.optional(this.filters);
}
/**
* Name of the packet capture session.
*
*/
@Export(name="name", refs={String.class}, tree="[0]")
private Output name;
/**
* @return Name of the packet capture session.
*
*/
public Output name() {
return this.name;
}
/**
* The provisioning state of the packet capture session.
*
*/
@Export(name="provisioningState", refs={String.class}, tree="[0]")
private Output provisioningState;
/**
* @return The provisioning state of the packet capture session.
*
*/
public Output provisioningState() {
return this.provisioningState;
}
/**
* A list of AzureVMSS instances which can be included or excluded to run packet capture. If both included and excluded are empty, then the packet capture will run on all instances of AzureVMSS.
*
*/
@Export(name="scope", refs={PacketCaptureMachineScopeResponse.class}, tree="[0]")
private Output scope;
/**
* @return A list of AzureVMSS instances which can be included or excluded to run packet capture. If both included and excluded are empty, then the packet capture will run on all instances of AzureVMSS.
*
*/
public Output> scope() {
return Codegen.optional(this.scope);
}
/**
* The storage location for a packet capture session.
*
*/
@Export(name="storageLocation", refs={PacketCaptureStorageLocationResponse.class}, tree="[0]")
private Output storageLocation;
/**
* @return The storage location for a packet capture session.
*
*/
public Output storageLocation() {
return this.storageLocation;
}
/**
* The ID of the targeted resource, only AzureVM and AzureVMSS as target type are currently supported.
*
*/
@Export(name="target", refs={String.class}, tree="[0]")
private Output target;
/**
* @return The ID of the targeted resource, only AzureVM and AzureVMSS as target type are currently supported.
*
*/
public Output target() {
return this.target;
}
/**
* Target type of the resource provided.
*
*/
@Export(name="targetType", refs={String.class}, tree="[0]")
private Output targetType;
/**
* @return Target type of the resource provided.
*
*/
public Output> targetType() {
return Codegen.optional(this.targetType);
}
/**
* Maximum duration of the capture session in seconds.
*
*/
@Export(name="timeLimitInSeconds", refs={Integer.class}, tree="[0]")
private Output timeLimitInSeconds;
/**
* @return Maximum duration of the capture session in seconds.
*
*/
public Output> timeLimitInSeconds() {
return Codegen.optional(this.timeLimitInSeconds);
}
/**
* Maximum size of the capture output.
*
*/
@Export(name="totalBytesPerSession", refs={Double.class}, tree="[0]")
private Output totalBytesPerSession;
/**
* @return Maximum size of the capture output.
*
*/
public Output> totalBytesPerSession() {
return Codegen.optional(this.totalBytesPerSession);
}
/**
*
* @param name The _unique_ name of the resulting resource.
*/
public PacketCapture(java.lang.String name) {
this(name, PacketCaptureArgs.Empty);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
*/
public PacketCapture(java.lang.String name, PacketCaptureArgs args) {
this(name, args, null);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
* @param options A bag of options that control this resource's behavior.
*/
public PacketCapture(java.lang.String name, PacketCaptureArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("azure-native:network:PacketCapture", name, makeArgs(args, options), makeResourceOptions(options, Codegen.empty()), false);
}
private PacketCapture(java.lang.String name, Output id, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("azure-native:network:PacketCapture", name, null, makeResourceOptions(options, id), false);
}
private static PacketCaptureArgs makeArgs(PacketCaptureArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
if (options != null && options.getUrn().isPresent()) {
return null;
}
return args == null ? PacketCaptureArgs.Empty : args;
}
private static com.pulumi.resources.CustomResourceOptions makeResourceOptions(@Nullable com.pulumi.resources.CustomResourceOptions options, @Nullable Output id) {
var defaultOptions = com.pulumi.resources.CustomResourceOptions.builder()
.version(Utilities.getVersion())
.aliases(List.of(
Output.of(Alias.builder().type("azure-native:network/v20160901:PacketCapture").build()),
Output.of(Alias.builder().type("azure-native:network/v20161201:PacketCapture").build()),
Output.of(Alias.builder().type("azure-native:network/v20170301:PacketCapture").build()),
Output.of(Alias.builder().type("azure-native:network/v20170601:PacketCapture").build()),
Output.of(Alias.builder().type("azure-native:network/v20170801:PacketCapture").build()),
Output.of(Alias.builder().type("azure-native:network/v20170901:PacketCapture").build()),
Output.of(Alias.builder().type("azure-native:network/v20171001:PacketCapture").build()),
Output.of(Alias.builder().type("azure-native:network/v20171101:PacketCapture").build()),
Output.of(Alias.builder().type("azure-native:network/v20180101:PacketCapture").build()),
Output.of(Alias.builder().type("azure-native:network/v20180201:PacketCapture").build()),
Output.of(Alias.builder().type("azure-native:network/v20180401:PacketCapture").build()),
Output.of(Alias.builder().type("azure-native:network/v20180601:PacketCapture").build()),
Output.of(Alias.builder().type("azure-native:network/v20180701:PacketCapture").build()),
Output.of(Alias.builder().type("azure-native:network/v20180801:PacketCapture").build()),
Output.of(Alias.builder().type("azure-native:network/v20181001:PacketCapture").build()),
Output.of(Alias.builder().type("azure-native:network/v20181101:PacketCapture").build()),
Output.of(Alias.builder().type("azure-native:network/v20181201:PacketCapture").build()),
Output.of(Alias.builder().type("azure-native:network/v20190201:PacketCapture").build()),
Output.of(Alias.builder().type("azure-native:network/v20190401:PacketCapture").build()),
Output.of(Alias.builder().type("azure-native:network/v20190601:PacketCapture").build()),
Output.of(Alias.builder().type("azure-native:network/v20190701:PacketCapture").build()),
Output.of(Alias.builder().type("azure-native:network/v20190801:PacketCapture").build()),
Output.of(Alias.builder().type("azure-native:network/v20190901:PacketCapture").build()),
Output.of(Alias.builder().type("azure-native:network/v20191101:PacketCapture").build()),
Output.of(Alias.builder().type("azure-native:network/v20191201:PacketCapture").build()),
Output.of(Alias.builder().type("azure-native:network/v20200301:PacketCapture").build()),
Output.of(Alias.builder().type("azure-native:network/v20200401:PacketCapture").build()),
Output.of(Alias.builder().type("azure-native:network/v20200501:PacketCapture").build()),
Output.of(Alias.builder().type("azure-native:network/v20200601:PacketCapture").build()),
Output.of(Alias.builder().type("azure-native:network/v20200701:PacketCapture").build()),
Output.of(Alias.builder().type("azure-native:network/v20200801:PacketCapture").build()),
Output.of(Alias.builder().type("azure-native:network/v20201101:PacketCapture").build()),
Output.of(Alias.builder().type("azure-native:network/v20210201:PacketCapture").build()),
Output.of(Alias.builder().type("azure-native:network/v20210301:PacketCapture").build()),
Output.of(Alias.builder().type("azure-native:network/v20210501:PacketCapture").build()),
Output.of(Alias.builder().type("azure-native:network/v20210801:PacketCapture").build()),
Output.of(Alias.builder().type("azure-native:network/v20220101:PacketCapture").build()),
Output.of(Alias.builder().type("azure-native:network/v20220501:PacketCapture").build()),
Output.of(Alias.builder().type("azure-native:network/v20220701:PacketCapture").build()),
Output.of(Alias.builder().type("azure-native:network/v20220901:PacketCapture").build()),
Output.of(Alias.builder().type("azure-native:network/v20221101:PacketCapture").build()),
Output.of(Alias.builder().type("azure-native:network/v20230201:PacketCapture").build()),
Output.of(Alias.builder().type("azure-native:network/v20230401:PacketCapture").build()),
Output.of(Alias.builder().type("azure-native:network/v20230501:PacketCapture").build()),
Output.of(Alias.builder().type("azure-native:network/v20230601:PacketCapture").build()),
Output.of(Alias.builder().type("azure-native:network/v20230901:PacketCapture").build()),
Output.of(Alias.builder().type("azure-native:network/v20231101:PacketCapture").build()),
Output.of(Alias.builder().type("azure-native:network/v20240101:PacketCapture").build()),
Output.of(Alias.builder().type("azure-native:network/v20240301:PacketCapture").build())
))
.build();
return com.pulumi.resources.CustomResourceOptions.merge(defaultOptions, options, id);
}
/**
* Get an existing Host resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param options Optional settings to control the behavior of the CustomResource.
*/
public static PacketCapture get(java.lang.String name, Output id, @Nullable com.pulumi.resources.CustomResourceOptions options) {
return new PacketCapture(name, id, options);
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy