README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/network/2023-11-01/packetcaptures
Documentation
The packetcaptures
SDK allows for interaction with Azure Resource Manager network
(API Version 2023-11-01
).
This readme covers example usages, but further information on using this SDK can be found in the project root.
Import Path
import "github.com/hashicorp/go-azure-sdk/resource-manager/network/2023-11-01/packetcaptures"
Client Initialization
client := packetcaptures.NewPacketCapturesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: PacketCapturesClient.Create
ctx := context.TODO()
id := packetcaptures.NewPacketCaptureID("12345678-1234-9876-4563-123456789012", "example-resource-group", "networkWatcherName", "packetCaptureName")
payload := packetcaptures.PacketCapture{
// ...
}
if err := client.CreateThenPoll(ctx, id, payload); err != nil {
// handle the error
}
Example Usage: PacketCapturesClient.Delete
ctx := context.TODO()
id := packetcaptures.NewPacketCaptureID("12345678-1234-9876-4563-123456789012", "example-resource-group", "networkWatcherName", "packetCaptureName")
if err := client.DeleteThenPoll(ctx, id); err != nil {
// handle the error
}
Example Usage: PacketCapturesClient.Get
ctx := context.TODO()
id := packetcaptures.NewPacketCaptureID("12345678-1234-9876-4563-123456789012", "example-resource-group", "networkWatcherName", "packetCaptureName")
read, err := client.Get(ctx, id)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: PacketCapturesClient.GetStatus
ctx := context.TODO()
id := packetcaptures.NewPacketCaptureID("12345678-1234-9876-4563-123456789012", "example-resource-group", "networkWatcherName", "packetCaptureName")
if err := client.GetStatusThenPoll(ctx, id); err != nil {
// handle the error
}
Example Usage: PacketCapturesClient.List
ctx := context.TODO()
id := packetcaptures.NewNetworkWatcherID("12345678-1234-9876-4563-123456789012", "example-resource-group", "networkWatcherName")
read, err := client.List(ctx, id)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: PacketCapturesClient.Stop
ctx := context.TODO()
id := packetcaptures.NewPacketCaptureID("12345678-1234-9876-4563-123456789012", "example-resource-group", "networkWatcherName", "packetCaptureName")
if err := client.StopThenPoll(ctx, id); err != nil {
// handle the error
}
Documentation ¶
Index ¶
- func PossibleValuesForPacketCaptureTargetType() []string
- func PossibleValuesForPcError() []string
- func PossibleValuesForPcProtocol() []string
- func PossibleValuesForPcStatus() []string
- func PossibleValuesForProvisioningState() []string
- func ValidateNetworkWatcherID(input interface{}, key string) (warnings []string, errors []error)
- func ValidatePacketCaptureID(input interface{}, key string) (warnings []string, errors []error)
- type CreateOperationResponse
- type DeleteOperationResponse
- type GetOperationResponse
- type GetStatusOperationResponse
- type ListOperationResponse
- type NetworkWatcherId
- type PacketCapture
- type PacketCaptureFilter
- type PacketCaptureId
- type PacketCaptureListResult
- type PacketCaptureMachineScope
- type PacketCaptureParameters
- type PacketCaptureQueryStatusResult
- type PacketCaptureResult
- type PacketCaptureResultProperties
- type PacketCaptureSettings
- type PacketCaptureStorageLocation
- type PacketCaptureTargetType
- type PacketCapturesClient
- func (c PacketCapturesClient) Create(ctx context.Context, id PacketCaptureId, input PacketCapture) (result CreateOperationResponse, err error)
- func (c PacketCapturesClient) CreateThenPoll(ctx context.Context, id PacketCaptureId, input PacketCapture) error
- func (c PacketCapturesClient) Delete(ctx context.Context, id PacketCaptureId) (result DeleteOperationResponse, err error)
- func (c PacketCapturesClient) DeleteThenPoll(ctx context.Context, id PacketCaptureId) error
- func (c PacketCapturesClient) Get(ctx context.Context, id PacketCaptureId) (result GetOperationResponse, err error)
- func (c PacketCapturesClient) GetStatus(ctx context.Context, id PacketCaptureId) (result GetStatusOperationResponse, err error)
- func (c PacketCapturesClient) GetStatusThenPoll(ctx context.Context, id PacketCaptureId) error
- func (c PacketCapturesClient) List(ctx context.Context, id NetworkWatcherId) (result ListOperationResponse, err error)
- func (c PacketCapturesClient) Stop(ctx context.Context, id PacketCaptureId) (result StopOperationResponse, err error)
- func (c PacketCapturesClient) StopThenPoll(ctx context.Context, id PacketCaptureId) error
- type PcError
- type PcProtocol
- type PcStatus
- type ProvisioningState
- type StopOperationResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func PossibleValuesForPacketCaptureTargetType ¶
func PossibleValuesForPacketCaptureTargetType() []string
func PossibleValuesForPcError ¶
func PossibleValuesForPcError() []string
func PossibleValuesForPcProtocol ¶
func PossibleValuesForPcProtocol() []string
func PossibleValuesForPcStatus ¶
func PossibleValuesForPcStatus() []string
func PossibleValuesForProvisioningState ¶
func PossibleValuesForProvisioningState() []string
func ValidateNetworkWatcherID ¶
ValidateNetworkWatcherID checks that 'input' can be parsed as a Network Watcher ID
func ValidatePacketCaptureID ¶
ValidatePacketCaptureID checks that 'input' can be parsed as a Packet Capture ID
Types ¶
type CreateOperationResponse ¶
type DeleteOperationResponse ¶
type GetOperationResponse ¶
type GetOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *PacketCaptureResult }
type ListOperationResponse ¶
type ListOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *PacketCaptureListResult }
type NetworkWatcherId ¶
type NetworkWatcherId struct { SubscriptionId string ResourceGroupName string NetworkWatcherName string }
NetworkWatcherId is a struct representing the Resource ID for a Network Watcher
func NewNetworkWatcherID ¶
func NewNetworkWatcherID(subscriptionId string, resourceGroupName string, networkWatcherName string) NetworkWatcherId
NewNetworkWatcherID returns a new NetworkWatcherId struct
func ParseNetworkWatcherID ¶
func ParseNetworkWatcherID(input string) (*NetworkWatcherId, error)
ParseNetworkWatcherID parses 'input' into a NetworkWatcherId
func ParseNetworkWatcherIDInsensitively ¶
func ParseNetworkWatcherIDInsensitively(input string) (*NetworkWatcherId, error)
ParseNetworkWatcherIDInsensitively parses 'input' case-insensitively into a NetworkWatcherId note: this method should only be used for API response data and not user input
func (*NetworkWatcherId) FromParseResult ¶
func (id *NetworkWatcherId) FromParseResult(input resourceids.ParseResult) error
func (NetworkWatcherId) ID ¶
func (id NetworkWatcherId) ID() string
ID returns the formatted Network Watcher ID
func (NetworkWatcherId) Segments ¶
func (id NetworkWatcherId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Network Watcher ID
func (NetworkWatcherId) String ¶
func (id NetworkWatcherId) String() string
String returns a human-readable description of this Network Watcher ID
type PacketCapture ¶
type PacketCapture struct {
Properties PacketCaptureParameters `json:"properties"`
}
type PacketCaptureFilter ¶
type PacketCaptureFilter struct { LocalIPAddress *string `json:"localIPAddress,omitempty"` LocalPort *string `json:"localPort,omitempty"` Protocol *PcProtocol `json:"protocol,omitempty"` RemoteIPAddress *string `json:"remoteIPAddress,omitempty"` RemotePort *string `json:"remotePort,omitempty"` }
type PacketCaptureId ¶
type PacketCaptureId struct { SubscriptionId string ResourceGroupName string NetworkWatcherName string PacketCaptureName string }
PacketCaptureId is a struct representing the Resource ID for a Packet Capture
func NewPacketCaptureID ¶
func NewPacketCaptureID(subscriptionId string, resourceGroupName string, networkWatcherName string, packetCaptureName string) PacketCaptureId
NewPacketCaptureID returns a new PacketCaptureId struct
func ParsePacketCaptureID ¶
func ParsePacketCaptureID(input string) (*PacketCaptureId, error)
ParsePacketCaptureID parses 'input' into a PacketCaptureId
func ParsePacketCaptureIDInsensitively ¶
func ParsePacketCaptureIDInsensitively(input string) (*PacketCaptureId, error)
ParsePacketCaptureIDInsensitively parses 'input' case-insensitively into a PacketCaptureId note: this method should only be used for API response data and not user input
func (*PacketCaptureId) FromParseResult ¶
func (id *PacketCaptureId) FromParseResult(input resourceids.ParseResult) error
func (PacketCaptureId) ID ¶
func (id PacketCaptureId) ID() string
ID returns the formatted Packet Capture ID
func (PacketCaptureId) Segments ¶
func (id PacketCaptureId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Packet Capture ID
func (PacketCaptureId) String ¶
func (id PacketCaptureId) String() string
String returns a human-readable description of this Packet Capture ID
type PacketCaptureListResult ¶
type PacketCaptureListResult struct {
Value *[]PacketCaptureResult `json:"value,omitempty"`
}
type PacketCaptureParameters ¶
type PacketCaptureParameters struct { BytesToCapturePerPacket *int64 `json:"bytesToCapturePerPacket,omitempty"` CaptureSettings *PacketCaptureSettings `json:"captureSettings,omitempty"` ContinuousCapture *bool `json:"continuousCapture,omitempty"` Filters *[]PacketCaptureFilter `json:"filters,omitempty"` Scope *PacketCaptureMachineScope `json:"scope,omitempty"` StorageLocation PacketCaptureStorageLocation `json:"storageLocation"` Target string `json:"target"` TargetType *PacketCaptureTargetType `json:"targetType,omitempty"` TimeLimitInSeconds *int64 `json:"timeLimitInSeconds,omitempty"` TotalBytesPerSession *int64 `json:"totalBytesPerSession,omitempty"` }
type PacketCaptureQueryStatusResult ¶
type PacketCaptureQueryStatusResult struct { CaptureStartTime *string `json:"captureStartTime,omitempty"` Id *string `json:"id,omitempty"` Name *string `json:"name,omitempty"` PacketCaptureError *[]PcError `json:"packetCaptureError,omitempty"` PacketCaptureStatus *PcStatus `json:"packetCaptureStatus,omitempty"` StopReason *string `json:"stopReason,omitempty"` }
func (*PacketCaptureQueryStatusResult) GetCaptureStartTimeAsTime ¶
func (o *PacketCaptureQueryStatusResult) GetCaptureStartTimeAsTime() (*time.Time, error)
func (*PacketCaptureQueryStatusResult) SetCaptureStartTimeAsTime ¶
func (o *PacketCaptureQueryStatusResult) SetCaptureStartTimeAsTime(input time.Time)
type PacketCaptureResult ¶
type PacketCaptureResult struct { Etag *string `json:"etag,omitempty"` Id *string `json:"id,omitempty"` Name *string `json:"name,omitempty"` Properties *PacketCaptureResultProperties `json:"properties,omitempty"` }
type PacketCaptureResultProperties ¶
type PacketCaptureResultProperties struct { BytesToCapturePerPacket *int64 `json:"bytesToCapturePerPacket,omitempty"` CaptureSettings *PacketCaptureSettings `json:"captureSettings,omitempty"` ContinuousCapture *bool `json:"continuousCapture,omitempty"` Filters *[]PacketCaptureFilter `json:"filters,omitempty"` ProvisioningState *ProvisioningState `json:"provisioningState,omitempty"` Scope *PacketCaptureMachineScope `json:"scope,omitempty"` StorageLocation PacketCaptureStorageLocation `json:"storageLocation"` Target string `json:"target"` TargetType *PacketCaptureTargetType `json:"targetType,omitempty"` TimeLimitInSeconds *int64 `json:"timeLimitInSeconds,omitempty"` TotalBytesPerSession *int64 `json:"totalBytesPerSession,omitempty"` }
type PacketCaptureSettings ¶
type PacketCaptureTargetType ¶
type PacketCaptureTargetType string
const ( PacketCaptureTargetTypeAzureVM PacketCaptureTargetType = "AzureVM" PacketCaptureTargetTypeAzureVMSS PacketCaptureTargetType = "AzureVMSS" )
func (*PacketCaptureTargetType) UnmarshalJSON ¶
func (s *PacketCaptureTargetType) UnmarshalJSON(bytes []byte) error
type PacketCapturesClient ¶
type PacketCapturesClient struct {
Client *resourcemanager.Client
}
func NewPacketCapturesClientWithBaseURI ¶
func NewPacketCapturesClientWithBaseURI(sdkApi sdkEnv.Api) (*PacketCapturesClient, error)
func (PacketCapturesClient) Create ¶
func (c PacketCapturesClient) Create(ctx context.Context, id PacketCaptureId, input PacketCapture) (result CreateOperationResponse, err error)
Create ...
func (PacketCapturesClient) CreateThenPoll ¶
func (c PacketCapturesClient) CreateThenPoll(ctx context.Context, id PacketCaptureId, input PacketCapture) error
CreateThenPoll performs Create then polls until it's completed
func (PacketCapturesClient) Delete ¶
func (c PacketCapturesClient) Delete(ctx context.Context, id PacketCaptureId) (result DeleteOperationResponse, err error)
Delete ...
func (PacketCapturesClient) DeleteThenPoll ¶
func (c PacketCapturesClient) DeleteThenPoll(ctx context.Context, id PacketCaptureId) error
DeleteThenPoll performs Delete then polls until it's completed
func (PacketCapturesClient) Get ¶
func (c PacketCapturesClient) Get(ctx context.Context, id PacketCaptureId) (result GetOperationResponse, err error)
Get ...
func (PacketCapturesClient) GetStatus ¶
func (c PacketCapturesClient) GetStatus(ctx context.Context, id PacketCaptureId) (result GetStatusOperationResponse, err error)
GetStatus ...
func (PacketCapturesClient) GetStatusThenPoll ¶
func (c PacketCapturesClient) GetStatusThenPoll(ctx context.Context, id PacketCaptureId) error
GetStatusThenPoll performs GetStatus then polls until it's completed
func (PacketCapturesClient) List ¶
func (c PacketCapturesClient) List(ctx context.Context, id NetworkWatcherId) (result ListOperationResponse, err error)
List ...
func (PacketCapturesClient) Stop ¶
func (c PacketCapturesClient) Stop(ctx context.Context, id PacketCaptureId) (result StopOperationResponse, err error)
Stop ...
func (PacketCapturesClient) StopThenPoll ¶
func (c PacketCapturesClient) StopThenPoll(ctx context.Context, id PacketCaptureId) error
StopThenPoll performs Stop then polls until it's completed
type PcProtocol ¶
type PcProtocol string
const ( PcProtocolAny PcProtocol = "Any" PcProtocolTCP PcProtocol = "TCP" PcProtocolUDP PcProtocol = "UDP" )
func (*PcProtocol) UnmarshalJSON ¶
func (s *PcProtocol) UnmarshalJSON(bytes []byte) error
type ProvisioningState ¶
type ProvisioningState string
const ( ProvisioningStateDeleting ProvisioningState = "Deleting" ProvisioningStateFailed ProvisioningState = "Failed" ProvisioningStateSucceeded ProvisioningState = "Succeeded" ProvisioningStateUpdating ProvisioningState = "Updating" )
func (*ProvisioningState) UnmarshalJSON ¶
func (s *ProvisioningState) UnmarshalJSON(bytes []byte) error
Source Files ¶
- client.go
- constants.go
- id_networkwatcher.go
- id_packetcapture.go
- method_create.go
- method_delete.go
- method_get.go
- method_getstatus.go
- method_list.go
- method_stop.go
- model_packetcapture.go
- model_packetcapturefilter.go
- model_packetcapturelistresult.go
- model_packetcapturemachinescope.go
- model_packetcaptureparameters.go
- model_packetcapturequerystatusresult.go
- model_packetcaptureresult.go
- model_packetcaptureresultproperties.go
- model_packetcapturesettings.go
- model_packetcapturestoragelocation.go
- version.go