Packet Captures - Create

Service:

Network Watcher

API Version:

2023-09-01

Создайте и запустите запись пакетов на указанной виртуальной машине.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/packetCaptures/{packetCaptureName}?api-version=2023-09-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
networkWatcherName	path	True	string	Имя наблюдателя за сетями.
packetCaptureName	path	True	string	Имя сеанса записи пакетов.
resourceGroupName	path	True	string	Имя группы ресурсов.
subscriptionId	path	True	string	Учетные данные подписки, которые однозначно идентифицируют подписку Microsoft Azure. Идентификатор подписки формирует часть URI для каждого вызова службы.
api-version	query	True	string	Версия API клиента.

Текст запроса

Имя	Обязательно	Тип	Описание
properties.storageLocation	True	PacketCaptureStorageLocation	Место хранения для сеанса записи пакетов.
properties.target	True	string	В настоящее время поддерживаются идентификатор целевого ресурса, только AzureVM и AzureVMSS в качестве целевого типа.
properties.bytesToCapturePerPacket		integer	Количество байтов, захваченных на пакет, остальные байты усекаются.
properties.filters		PacketCaptureFilter[]	Список фильтров записи пакетов.
properties.scope		PacketCaptureMachineScope	Список экземпляров AzureVMSS, которые можно включить или исключить для выполнения записи пакетов. Если включенные и исключенные значения пусты, запись пакетов будет выполняться на всех экземплярах AzureVMSS.
properties.targetType		PacketCaptureTargetType	Целевой тип предоставленного ресурса.
properties.timeLimitInSeconds		integer	Максимальная продолжительность сеанса записи в секундах.
properties.totalBytesPerSession		integer	Максимальный размер выходных данных записи.

Ответы

Имя	Тип	Описание
201 Created	PacketCaptureResult	Запрос выполнен успешно. Операция возвращает результирующий сеанс записи пакетов.
Other Status Codes	ErrorResponse	Ответ об ошибке, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

Create packet capture

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/packetCaptures/pc1?api-version=2023-09-01

{
  "properties": {
    "target": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1",
    "bytesToCapturePerPacket": 10000,
    "totalBytesPerSession": 100000,
    "timeLimitInSeconds": 100,
    "storageLocation": {
      "storageId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Storage/storageAccounts/pcstore",
      "storagePath": "https://mytestaccountname.blob.core.windows.net/capture/pc1.cap",
      "filePath": "D:\\capture\\pc1.cap"
    },
    "filters": [
      {
        "protocol": "TCP",
        "localIPAddress": "10.0.0.4",
        "localPort": "80"
      }
    ]
  }
}

Java

import com.azure.resourcemanager.network.fluent.models.PacketCaptureInner;
import com.azure.resourcemanager.network.models.PacketCaptureFilter;
import com.azure.resourcemanager.network.models.PacketCaptureStorageLocation;
import com.azure.resourcemanager.network.models.PcProtocol;
import java.util.Arrays;

/**
 * Samples for PacketCaptures Create.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/
     * NetworkWatcherPacketCaptureCreate.json
     */
    /**
     * Sample code: Create packet capture.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void createPacketCapture(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getPacketCaptures().create("rg1", "nw1", "pc1",
            new PacketCaptureInner()
                .withTarget("/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1")
                .withBytesToCapturePerPacket(10000L).withTotalBytesPerSession(100000L).withTimeLimitInSeconds(100)
                .withStorageLocation(new PacketCaptureStorageLocation()
                    .withStorageId(
                        "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Storage/storageAccounts/pcstore")
                    .withStoragePath("https://mytestaccountname.blob.core.windows.net/capture/pc1.cap")
                    .withFilePath("D:\\capture\\pc1.cap"))
                .withFilters(Arrays.asList(new PacketCaptureFilter().withProtocol(PcProtocol.TCP)
                    .withLocalIpAddress("10.0.0.4").withLocalPort("80"))),
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.network import NetworkManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-network
# USAGE
    python network_watcher_packet_capture_create.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = NetworkManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.packet_captures.begin_create(
        resource_group_name="rg1",
        network_watcher_name="nw1",
        packet_capture_name="pc1",
        parameters={
            "properties": {
                "bytesToCapturePerPacket": 10000,
                "filters": [{"localIPAddress": "10.0.0.4", "localPort": "80", "protocol": "TCP"}],
                "storageLocation": {
                    "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",
                },
                "target": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1",
                "timeLimitInSeconds": 100,
                "totalBytesPerSession": 100000,
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/NetworkWatcherPacketCaptureCreate.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armnetwork_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/network/armnetwork/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d4205894880b989ede35d62d97c8e901ed14fb5a/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/NetworkWatcherPacketCaptureCreate.json
func ExamplePacketCapturesClient_BeginCreate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armnetwork.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewPacketCapturesClient().BeginCreate(ctx, "rg1", "nw1", "pc1", armnetwork.PacketCapture{
		Properties: &armnetwork.PacketCaptureParameters{
			BytesToCapturePerPacket: to.Ptr[int64](10000),
			Filters: []*armnetwork.PacketCaptureFilter{
				{
					LocalIPAddress: to.Ptr("10.0.0.4"),
					LocalPort:      to.Ptr("80"),
					Protocol:       to.Ptr(armnetwork.PcProtocolTCP),
				}},
			StorageLocation: &armnetwork.PacketCaptureStorageLocation{
				FilePath:    to.Ptr("D:\\capture\\pc1.cap"),
				StorageID:   to.Ptr("/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Storage/storageAccounts/pcstore"),
				StoragePath: to.Ptr("https://mytestaccountname.blob.core.windows.net/capture/pc1.cap"),
			},
			Target:               to.Ptr("/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1"),
			TimeLimitInSeconds:   to.Ptr[int32](100),
			TotalBytesPerSession: to.Ptr[int64](100000),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { NetworkManagementClient } = require("@azure/arm-network");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Create and start a packet capture on the specified VM.
 *
 * @summary Create and start a packet capture on the specified VM.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/NetworkWatcherPacketCaptureCreate.json
 */
async function createPacketCapture() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const networkWatcherName = "nw1";
  const packetCaptureName = "pc1";
  const parameters = {
    bytesToCapturePerPacket: 10000,
    filters: [{ localIPAddress: "10.0.0.4", localPort: "80", protocol: "TCP" }],
    storageLocation: {
      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",
    },
    target:
      "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1",
    timeLimitInSeconds: 100,
    totalBytesPerSession: 100000,
  };
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.packetCaptures.beginCreateAndWait(
    resourceGroupName,
    networkWatcherName,
    packetCaptureName,
    parameters,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Network;
using Azure.ResourceManager.Network.Models;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/NetworkWatcherPacketCaptureCreate.json
// this example is just showing the usage of "PacketCaptures_Create" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this NetworkWatcherResource created on azure
// for more information of creating NetworkWatcherResource, please refer to the document of NetworkWatcherResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string networkWatcherName = "nw1";
ResourceIdentifier networkWatcherResourceId = NetworkWatcherResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, networkWatcherName);
NetworkWatcherResource networkWatcher = client.GetNetworkWatcherResource(networkWatcherResourceId);

// get the collection of this PacketCaptureResource
PacketCaptureCollection collection = networkWatcher.GetPacketCaptures();

// invoke the operation
string packetCaptureName = "pc1";
PacketCaptureCreateOrUpdateContent content = new PacketCaptureCreateOrUpdateContent("/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1", new PacketCaptureStorageLocation()
{
    StorageId = new ResourceIdentifier("/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Storage/storageAccounts/pcstore"),
    StoragePath = "https://mytestaccountname.blob.core.windows.net/capture/pc1.cap",
    FilePath = "D:\\capture\\pc1.cap",
})
{
    BytesToCapturePerPacket = 10000,
    TotalBytesPerSession = 100000,
    TimeLimitInSeconds = 100,
    Filters =
    {
    new PacketCaptureFilter()
    {
    Protocol = PcProtocol.Tcp,
    LocalIPAddress = "10.0.0.4",
    LocalPort = "80",
    }
    },
};
ArmOperation<PacketCaptureResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, packetCaptureName, content);
PacketCaptureResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
PacketCaptureData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

201

{
  "name": "pc1",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/packetCaptures/pc1",
  "properties": {
    "provisioningState": "Updating",
    "target": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1",
    "bytesToCapturePerPacket": 10000,
    "totalBytesPerSession": 100000,
    "timeLimitInSeconds": 100,
    "storageLocation": {
      "storageId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Storage/storageAccounts/pcstore",
      "storagePath": "https://mytestaccountname.blob.core.windows.net/capture/pc1.cap",
      "filePath": "D:\\capture\\pc1.cap"
    },
    "filters": [
      {
        "protocol": "TCP",
        "localIPAddress": "10.0.0.4",
        "localPort": "80"
      }
    ]
  }
}

Определения

Имя	Описание
ErrorDetails	Представление сведений о распространенных ошибках.
ErrorResponse	Объект error.
PacketCapture	Параметры, определяющие операцию создания записи пакетов.
PacketCaptureFilter	Фильтр, применяемый к запросу на сбор пакетов. Можно применить несколько фильтров.
PacketCaptureMachineScope	Список экземпляров AzureVMSS, которые можно включить или исключить для выполнения записи пакетов. Если включенные и исключенные значения пусты, запись пакетов будет выполняться на всех экземплярах AzureVMSS.
PacketCaptureResult	Сведения о сеансе записи пакетов.
PacketCaptureStorageLocation	Место хранения для сеанса записи пакетов.
PacketCaptureTargetType	Целевой тип предоставленного ресурса.
PcProtocol	Протокол для фильтрации.
ProvisioningState	Текущее состояние подготовки.

ErrorDetails

Представление сведений о распространенных ошибках.

Имя	Тип	Описание
code	string	Код ошибки.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Объект error.

Имя	Тип	Описание
error	ErrorDetails	Ошибка Объект сведений об ошибке.

PacketCapture

Параметры, определяющие операцию создания записи пакетов.

Имя	Тип	Значение по умолчанию	Описание
properties.bytesToCapturePerPacket	integer	0	Количество байтов, захваченных на пакет, остальные байты усекаются.
properties.filters	PacketCaptureFilter[]		Список фильтров записи пакетов.
properties.scope	PacketCaptureMachineScope		Список экземпляров AzureVMSS, которые можно включить или исключить для выполнения записи пакетов. Если включенные и исключенные значения пусты, запись пакетов будет выполняться на всех экземплярах AzureVMSS.
properties.storageLocation	PacketCaptureStorageLocation		Место хранения для сеанса записи пакетов.
properties.target	string		В настоящее время поддерживаются идентификатор целевого ресурса, только AzureVM и AzureVMSS в качестве целевого типа.
properties.targetType	PacketCaptureTargetType		Целевой тип предоставленного ресурса.
properties.timeLimitInSeconds	integer	18000	Максимальная продолжительность сеанса записи в секундах.
properties.totalBytesPerSession	integer	1073741824	Максимальный размер выходных данных записи.

PacketCaptureFilter

Фильтр, применяемый к запросу на сбор пакетов. Можно применить несколько фильтров.

Имя	Тип	Значение по умолчанию	Описание
localIPAddress	string		Локальный IP-адрес для фильтрации. Нотация: "127.0.0.1" для записи с одним адресом. "127.0.0.1-127.0.0.255" для диапазона. "127.0.0.1; 127.0.0.5"? для нескольких записей. Несколько диапазонов в настоящее время не поддерживаются. Смешивание диапазонов с несколькими записями в настоящее время не поддерживается. По умолчанию = null.
localPort	string		Локальный порт для фильтрации. Нотация: "80" для входа с одним портом". 80–85 дюймов для диапазона. "80; 443;" для нескольких записей. Несколько диапазонов в настоящее время не поддерживаются. Смешивание диапазонов с несколькими записями в настоящее время не поддерживается. По умолчанию = null.
protocol	PcProtocol	Any	Протокол для фильтрации.
remoteIPAddress	string		Локальный IP-адрес для фильтрации. Нотация: "127.0.0.1" для записи с одним адресом. "127.0.0.1-127.0.0.255" для диапазона. "127.0.0.1; 127.0.0.5;" для нескольких записей. Несколько диапазонов в настоящее время не поддерживаются. Смешивание диапазонов с несколькими записями в настоящее время не поддерживается. По умолчанию = null.
remotePort	string		Удаленный порт для фильтрации. Нотация: "80" для входа с одним портом". 80–85 дюймов для диапазона. "80; 443;" для нескольких записей. Несколько диапазонов в настоящее время не поддерживаются. Смешивание диапазонов с несколькими записями в настоящее время не поддерживается. По умолчанию = null.

PacketCaptureMachineScope

Список экземпляров AzureVMSS, которые можно включить или исключить для выполнения записи пакетов. Если включенные и исключенные значения пусты, запись пакетов будет выполняться на всех экземплярах AzureVMSS.

Имя	Тип	Описание
exclude	string[]	Список экземпляров AzureVMSS, которые должны быть исключены из AzureVMSS из записи пакетов.
include	string[]	Список экземпляров AzureVMSS для записи пакетов.

PacketCaptureResult

Сведения о сеансе записи пакетов.

Имя	Тип	Значение по умолчанию	Описание
etag	string		Уникальная строка, доступная только для чтения, которая изменяется при каждом обновлении ресурса.
id	string		Идентификатор операции записи пакетов.
name	string		Имя сеанса записи пакетов.
properties.bytesToCapturePerPacket	integer	0	Количество байтов, захваченных на пакет, остальные байты усекаются.
properties.filters	PacketCaptureFilter[]		Список фильтров записи пакетов.
properties.provisioningState	ProvisioningState		Состояние подготовки сеанса записи пакетов.
properties.scope	PacketCaptureMachineScope		Список экземпляров AzureVMSS, которые можно включить или исключить для выполнения записи пакетов. Если включенные и исключенные значения пусты, запись пакетов будет выполняться на всех экземплярах AzureVMSS.
properties.storageLocation	PacketCaptureStorageLocation		Место хранения для сеанса записи пакетов.
properties.target	string		В настоящее время поддерживаются идентификатор целевого ресурса, только AzureVM и AzureVMSS в качестве целевого типа.
properties.targetType	PacketCaptureTargetType		Целевой тип предоставленного ресурса.
properties.timeLimitInSeconds	integer	18000	Максимальная продолжительность сеанса записи в секундах.
properties.totalBytesPerSession	integer	1073741824	Максимальный размер выходных данных записи.

PacketCaptureStorageLocation

Место хранения для сеанса записи пакетов.

Имя	Тип	Описание
filePath	string	Допустимый локальный путь на целевой виртуальной машине. Должно содержать имя файла записи (*.cap). Для виртуальной машины Linux она должна начинаться с /var/captures. Требуется, если идентификатор хранилища не указан, в противном случае — необязательный.
storageId	string	Идентификатор учетной записи хранения для сохранения сеанса записи пакетов. Требуется, если путь к локальному файлу не указан.
storagePath	string	Универсальный код ресурса (URI) пути к хранилищу для сохранения записи пакетов. Должен быть правильным универсальным кодом ресурса (URI), описывающим расположение для сохранения записи пакетов.

PacketCaptureTargetType

Целевой тип предоставленного ресурса.

Имя	Тип	Описание
AzureVM	string
AzureVMSS	string

PcProtocol

Протокол для фильтрации.

Имя	Тип	Описание
Any	string
TCP	string
UDP	string

ProvisioningState

Текущее состояние подготовки.

Имя	Тип	Описание
Deleting	string
Failed	string
Succeeded	string
Updating	string