networkwatcher

package
v8.1.1-beta+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 2, 2017 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Overview

Package networkwatcher implements the Azure ARM Networkwatcher service API version 2016-12-01.

The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.

Index

Constants

View Source
const (
	// APIVersion is the version of the Networkwatcher
	APIVersion = "2016-12-01"

	// DefaultBaseURI is the default URI used for the service Networkwatcher
	DefaultBaseURI = "https://management.azure.com"
)

Variables

This section is empty.

Functions

func UserAgent

func UserAgent() string

UserAgent returns the UserAgent string to use when sending http.Requests.

func Version

func Version() string

Version returns the semantic version (see http://semver.org) of the client.

Types

type Access

type Access string

Access enumerates the values for access.

const (
	// Allow specifies the allow state for access.
	Allow Access = "Allow"
	// Deny specifies the deny state for access.
	Deny Access = "Deny"
)

type AssociationType

type AssociationType string

AssociationType enumerates the values for association type.

const (
	// Associated specifies the associated state for association type.
	Associated AssociationType = "Associated"
	// Contains specifies the contains state for association type.
	Contains AssociationType = "Contains"
)

type Direction

type Direction string

Direction enumerates the values for direction.

const (
	// Inbound specifies the inbound state for direction.
	Inbound Direction = "Inbound"
	// Outbound specifies the outbound state for direction.
	Outbound Direction = "Outbound"
)

type EffectiveNetworkSecurityRule

type EffectiveNetworkSecurityRule struct {
	Name                             *string               `json:"name,omitempty"`
	Protocol                         SecurityRuleProtocol  `json:"protocol,omitempty"`
	SourcePortRange                  *string               `json:"sourcePortRange,omitempty"`
	DestinationPortRange             *string               `json:"destinationPortRange,omitempty"`
	SourceAddressPrefix              *string               `json:"sourceAddressPrefix,omitempty"`
	DestinationAddressPrefix         *string               `json:"destinationAddressPrefix,omitempty"`
	ExpandedSourceAddressPrefix      *[]string             `json:"expandedSourceAddressPrefix,omitempty"`
	ExpandedDestinationAddressPrefix *[]string             `json:"expandedDestinationAddressPrefix,omitempty"`
	Access                           SecurityRuleAccess    `json:"access,omitempty"`
	Priority                         *int32                `json:"priority,omitempty"`
	Direction                        SecurityRuleDirection `json:"direction,omitempty"`
}

EffectiveNetworkSecurityRule is effective network security rules.

type FlowLogInformation

type FlowLogInformation struct {
	autorest.Response  `json:"-"`
	TargetResourceID   *string `json:"targetResourceId,omitempty"`
	*FlowLogProperties `json:"properties,omitempty"`
}

FlowLogInformation is information on the configuration of flow log.

type FlowLogProperties

type FlowLogProperties struct {
	StorageID       *string                    `json:"storageId,omitempty"`
	Enabled         *bool                      `json:"enabled,omitempty"`
	RetentionPolicy *RetentionPolicyParameters `json:"retentionPolicy,omitempty"`
}

FlowLogProperties is parameters that define the configuration of flow log.

type FlowLogStatusParameters

type FlowLogStatusParameters struct {
	TargetResourceID *string `json:"targetResourceId,omitempty"`
}

FlowLogStatusParameters is parameters that define a resource to query flow log status.

type ListResult

type ListResult struct {
	autorest.Response `json:"-"`
	Value             *[]NetworkWatcher `json:"value,omitempty"`
}

ListResult is list of network watcher resources.

type ManagementClient

type ManagementClient struct {
	autorest.Client
	BaseURI        string
	APIVersion     string
	SubscriptionID string
}

ManagementClient is the base client for Networkwatcher.

func New

func New(subscriptionID string) ManagementClient

New creates an instance of the ManagementClient client.

func NewWithBaseURI

func NewWithBaseURI(baseURI string, subscriptionID string) ManagementClient

NewWithBaseURI creates an instance of the ManagementClient client.

type NetworkInterfaceAssociation

type NetworkInterfaceAssociation struct {
	ID            *string         `json:"id,omitempty"`
	SecurityRules *[]SecurityRule `json:"securityRules,omitempty"`
}

NetworkInterfaceAssociation is network interface and its custom security rules.

type NetworkWatcher

type NetworkWatcher struct {
	autorest.Response `json:"-"`
	ID                *string             `json:"id,omitempty"`
	Name              *string             `json:"name,omitempty"`
	Type              *string             `json:"type,omitempty"`
	Location          *string             `json:"location,omitempty"`
	Tags              *map[string]*string `json:"tags,omitempty"`
	Etag              *string             `json:"etag,omitempty"`
	*PropertiesFormat `json:"properties,omitempty"`
}

NetworkWatcher is network watcher in a resource group.

type NetworkWatchersClient

type NetworkWatchersClient struct {
	ManagementClient
}

NetworkWatchersClient is the the Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.

func NewNetworkWatchersClient

func NewNetworkWatchersClient(subscriptionID string) NetworkWatchersClient

NewNetworkWatchersClient creates an instance of the NetworkWatchersClient client.

func NewNetworkWatchersClientWithBaseURI

func NewNetworkWatchersClientWithBaseURI(baseURI string, subscriptionID string) NetworkWatchersClient

NewNetworkWatchersClientWithBaseURI creates an instance of the NetworkWatchersClient client.

func (NetworkWatchersClient) CreateOrUpdate

func (client NetworkWatchersClient) CreateOrUpdate(resourceGroupName string, networkWatcherName string, parameters NetworkWatcher) (result NetworkWatcher, err error)

CreateOrUpdate creates or updates a network watcher in the specified resource group.

resourceGroupName is the name of the resource group. networkWatcherName is the name of the network watcher. parameters is parameters that define the network watcher resource.

func (NetworkWatchersClient) CreateOrUpdatePreparer

func (client NetworkWatchersClient) CreateOrUpdatePreparer(resourceGroupName string, networkWatcherName string, parameters NetworkWatcher) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (NetworkWatchersClient) CreateOrUpdateResponder

func (client NetworkWatchersClient) CreateOrUpdateResponder(resp *http.Response) (result NetworkWatcher, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (NetworkWatchersClient) CreateOrUpdateSender

func (client NetworkWatchersClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (NetworkWatchersClient) Delete

func (client NetworkWatchersClient) Delete(resourceGroupName string, networkWatcherName string, cancel <-chan struct{}) (result autorest.Response, err error)

Delete deletes the specified network watcher resource. This method may poll for completion. Polling can be canceled by passing the cancel channel argument. The channel will be used to cancel polling and any outstanding HTTP requests.

resourceGroupName is the name of the resource group. networkWatcherName is the name of the network watcher.

func (NetworkWatchersClient) DeletePreparer

func (client NetworkWatchersClient) DeletePreparer(resourceGroupName string, networkWatcherName string, cancel <-chan struct{}) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (NetworkWatchersClient) DeleteResponder

func (client NetworkWatchersClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (NetworkWatchersClient) DeleteSender

func (client NetworkWatchersClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (NetworkWatchersClient) Get

func (client NetworkWatchersClient) Get(resourceGroupName string, networkWatcherName string) (result NetworkWatcher, err error)

Get gets the specified network watcher by resource group.

resourceGroupName is the name of the resource group. networkWatcherName is the name of the network watcher.

func (NetworkWatchersClient) GetFlowLogStatus

func (client NetworkWatchersClient) GetFlowLogStatus(resourceGroupName string, networkWatcherName string, parameters FlowLogStatusParameters, cancel <-chan struct{}) (result autorest.Response, err error)

GetFlowLogStatus queries status of flow log on a specified resource. This method may poll for completion. Polling can be canceled by passing the cancel channel argument. The channel will be used to cancel polling and any outstanding HTTP requests.

resourceGroupName is the name of the network watcher resource group. networkWatcherName is the name of the network watcher resource. parameters is parameters that define a resource to query flow log status.

func (NetworkWatchersClient) GetFlowLogStatusPreparer

func (client NetworkWatchersClient) GetFlowLogStatusPreparer(resourceGroupName string, networkWatcherName string, parameters FlowLogStatusParameters, cancel <-chan struct{}) (*http.Request, error)

GetFlowLogStatusPreparer prepares the GetFlowLogStatus request.

func (NetworkWatchersClient) GetFlowLogStatusResponder

func (client NetworkWatchersClient) GetFlowLogStatusResponder(resp *http.Response) (result autorest.Response, err error)

GetFlowLogStatusResponder handles the response to the GetFlowLogStatus request. The method always closes the http.Response Body.

func (NetworkWatchersClient) GetFlowLogStatusSender

func (client NetworkWatchersClient) GetFlowLogStatusSender(req *http.Request) (*http.Response, error)

GetFlowLogStatusSender sends the GetFlowLogStatus request. The method will close the http.Response Body if it receives an error.

func (NetworkWatchersClient) GetNextHop

func (client NetworkWatchersClient) GetNextHop(resourceGroupName string, networkWatcherName string, parameters NextHopParameters, cancel <-chan struct{}) (result autorest.Response, err error)

GetNextHop gets the next hop from the specified VM. This method may poll for completion. Polling can be canceled by passing the cancel channel argument. The channel will be used to cancel polling and any outstanding HTTP requests.

resourceGroupName is the name of the resource group. networkWatcherName is the name of the network watcher. parameters is parameters that define the source and destination endpoint.

func (NetworkWatchersClient) GetNextHopPreparer

func (client NetworkWatchersClient) GetNextHopPreparer(resourceGroupName string, networkWatcherName string, parameters NextHopParameters, cancel <-chan struct{}) (*http.Request, error)

GetNextHopPreparer prepares the GetNextHop request.

func (NetworkWatchersClient) GetNextHopResponder

func (client NetworkWatchersClient) GetNextHopResponder(resp *http.Response) (result autorest.Response, err error)

GetNextHopResponder handles the response to the GetNextHop request. The method always closes the http.Response Body.

func (NetworkWatchersClient) GetNextHopSender

func (client NetworkWatchersClient) GetNextHopSender(req *http.Request) (*http.Response, error)

GetNextHopSender sends the GetNextHop request. The method will close the http.Response Body if it receives an error.

func (NetworkWatchersClient) GetPreparer

func (client NetworkWatchersClient) GetPreparer(resourceGroupName string, networkWatcherName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (NetworkWatchersClient) GetResponder

func (client NetworkWatchersClient) GetResponder(resp *http.Response) (result NetworkWatcher, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (NetworkWatchersClient) GetSender

func (client NetworkWatchersClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (NetworkWatchersClient) GetTopology

func (client NetworkWatchersClient) GetTopology(resourceGroupName string, networkWatcherName string, parameters TopologyParameters) (result Topology, err error)

GetTopology gets the current network topology by resource group.

resourceGroupName is the name of the resource group. networkWatcherName is the name of the network watcher. parameters is parameters that define the representation of topology.

func (NetworkWatchersClient) GetTopologyPreparer

func (client NetworkWatchersClient) GetTopologyPreparer(resourceGroupName string, networkWatcherName string, parameters TopologyParameters) (*http.Request, error)

GetTopologyPreparer prepares the GetTopology request.

func (NetworkWatchersClient) GetTopologyResponder

func (client NetworkWatchersClient) GetTopologyResponder(resp *http.Response) (result Topology, err error)

GetTopologyResponder handles the response to the GetTopology request. The method always closes the http.Response Body.

func (NetworkWatchersClient) GetTopologySender

func (client NetworkWatchersClient) GetTopologySender(req *http.Request) (*http.Response, error)

GetTopologySender sends the GetTopology request. The method will close the http.Response Body if it receives an error.

func (NetworkWatchersClient) GetTroubleshooting

func (client NetworkWatchersClient) GetTroubleshooting(resourceGroupName string, networkWatcherName string, parameters TroubleshootingParameters, cancel <-chan struct{}) (result autorest.Response, err error)

GetTroubleshooting initiate troubleshooting on a specified resource This method may poll for completion. Polling can be canceled by passing the cancel channel argument. The channel will be used to cancel polling and any outstanding HTTP requests.

resourceGroupName is the name of the resource group. networkWatcherName is the name of the network watcher resource. parameters is parameters that define the resource to troubleshoot.

func (NetworkWatchersClient) GetTroubleshootingPreparer

func (client NetworkWatchersClient) GetTroubleshootingPreparer(resourceGroupName string, networkWatcherName string, parameters TroubleshootingParameters, cancel <-chan struct{}) (*http.Request, error)

GetTroubleshootingPreparer prepares the GetTroubleshooting request.

func (NetworkWatchersClient) GetTroubleshootingResponder

func (client NetworkWatchersClient) GetTroubleshootingResponder(resp *http.Response) (result autorest.Response, err error)

GetTroubleshootingResponder handles the response to the GetTroubleshooting request. The method always closes the http.Response Body.

func (NetworkWatchersClient) GetTroubleshootingResult

func (client NetworkWatchersClient) GetTroubleshootingResult(resourceGroupName string, networkWatcherName string, parameters QueryTroubleshootingParameters, cancel <-chan struct{}) (result autorest.Response, err error)

GetTroubleshootingResult get the last completed troubleshooting result on a specified resource This method may poll for completion. Polling can be canceled by passing the cancel channel argument. The channel will be used to cancel polling and any outstanding HTTP requests.

resourceGroupName is the name of the resource group. networkWatcherName is the name of the network watcher resource. parameters is parameters that define the resource to query the troubleshooting result.

func (NetworkWatchersClient) GetTroubleshootingResultPreparer

func (client NetworkWatchersClient) GetTroubleshootingResultPreparer(resourceGroupName string, networkWatcherName string, parameters QueryTroubleshootingParameters, cancel <-chan struct{}) (*http.Request, error)

GetTroubleshootingResultPreparer prepares the GetTroubleshootingResult request.

func (NetworkWatchersClient) GetTroubleshootingResultResponder

func (client NetworkWatchersClient) GetTroubleshootingResultResponder(resp *http.Response) (result autorest.Response, err error)

GetTroubleshootingResultResponder handles the response to the GetTroubleshootingResult request. The method always closes the http.Response Body.

func (NetworkWatchersClient) GetTroubleshootingResultSender

func (client NetworkWatchersClient) GetTroubleshootingResultSender(req *http.Request) (*http.Response, error)

GetTroubleshootingResultSender sends the GetTroubleshootingResult request. The method will close the http.Response Body if it receives an error.

func (NetworkWatchersClient) GetTroubleshootingSender

func (client NetworkWatchersClient) GetTroubleshootingSender(req *http.Request) (*http.Response, error)

GetTroubleshootingSender sends the GetTroubleshooting request. The method will close the http.Response Body if it receives an error.

func (NetworkWatchersClient) GetVMSecurityRules

func (client NetworkWatchersClient) GetVMSecurityRules(resourceGroupName string, networkWatcherName string, parameters SecurityGroupViewParameters, cancel <-chan struct{}) (result autorest.Response, err error)

GetVMSecurityRules gets the configured and effective security group rules on the specified VM. This method may poll for completion. Polling can be canceled by passing the cancel channel argument. The channel will be used to cancel polling and any outstanding HTTP requests.

resourceGroupName is the name of the resource group. networkWatcherName is the name of the network watcher. parameters is parameters that define the VM to check security groups for.

func (NetworkWatchersClient) GetVMSecurityRulesPreparer

func (client NetworkWatchersClient) GetVMSecurityRulesPreparer(resourceGroupName string, networkWatcherName string, parameters SecurityGroupViewParameters, cancel <-chan struct{}) (*http.Request, error)

GetVMSecurityRulesPreparer prepares the GetVMSecurityRules request.

func (NetworkWatchersClient) GetVMSecurityRulesResponder

func (client NetworkWatchersClient) GetVMSecurityRulesResponder(resp *http.Response) (result autorest.Response, err error)

GetVMSecurityRulesResponder handles the response to the GetVMSecurityRules request. The method always closes the http.Response Body.

func (NetworkWatchersClient) GetVMSecurityRulesSender

func (client NetworkWatchersClient) GetVMSecurityRulesSender(req *http.Request) (*http.Response, error)

GetVMSecurityRulesSender sends the GetVMSecurityRules request. The method will close the http.Response Body if it receives an error.

func (NetworkWatchersClient) List

func (client NetworkWatchersClient) List(resourceGroupName string) (result ListResult, err error)

List gets all network watchers by resource group.

resourceGroupName is the name of the resource group.

func (NetworkWatchersClient) ListAll

func (client NetworkWatchersClient) ListAll() (result ListResult, err error)

ListAll gets all network watchers by subscription.

func (NetworkWatchersClient) ListAllPreparer

func (client NetworkWatchersClient) ListAllPreparer() (*http.Request, error)

ListAllPreparer prepares the ListAll request.

func (NetworkWatchersClient) ListAllResponder

func (client NetworkWatchersClient) ListAllResponder(resp *http.Response) (result ListResult, err error)

ListAllResponder handles the response to the ListAll request. The method always closes the http.Response Body.

func (NetworkWatchersClient) ListAllSender

func (client NetworkWatchersClient) ListAllSender(req *http.Request) (*http.Response, error)

ListAllSender sends the ListAll request. The method will close the http.Response Body if it receives an error.

func (NetworkWatchersClient) ListPreparer

func (client NetworkWatchersClient) ListPreparer(resourceGroupName string) (*http.Request, error)

ListPreparer prepares the List request.

func (NetworkWatchersClient) ListResponder

func (client NetworkWatchersClient) ListResponder(resp *http.Response) (result ListResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (NetworkWatchersClient) ListSender

func (client NetworkWatchersClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

func (NetworkWatchersClient) SetFlowLogConfiguration

func (client NetworkWatchersClient) SetFlowLogConfiguration(resourceGroupName string, networkWatcherName string, parameters FlowLogInformation, cancel <-chan struct{}) (result autorest.Response, err error)

SetFlowLogConfiguration configures flow log on a specified resource. This method may poll for completion. Polling can be canceled by passing the cancel channel argument. The channel will be used to cancel polling and any outstanding HTTP requests.

resourceGroupName is the name of the network watcher resource group. networkWatcherName is the name of the network watcher resource. parameters is parameters that define the configuration of flow log.

func (NetworkWatchersClient) SetFlowLogConfigurationPreparer

func (client NetworkWatchersClient) SetFlowLogConfigurationPreparer(resourceGroupName string, networkWatcherName string, parameters FlowLogInformation, cancel <-chan struct{}) (*http.Request, error)

SetFlowLogConfigurationPreparer prepares the SetFlowLogConfiguration request.

func (NetworkWatchersClient) SetFlowLogConfigurationResponder

func (client NetworkWatchersClient) SetFlowLogConfigurationResponder(resp *http.Response) (result autorest.Response, err error)

SetFlowLogConfigurationResponder handles the response to the SetFlowLogConfiguration request. The method always closes the http.Response Body.

func (NetworkWatchersClient) SetFlowLogConfigurationSender

func (client NetworkWatchersClient) SetFlowLogConfigurationSender(req *http.Request) (*http.Response, error)

SetFlowLogConfigurationSender sends the SetFlowLogConfiguration request. The method will close the http.Response Body if it receives an error.

func (NetworkWatchersClient) VerifyIPFlow

func (client NetworkWatchersClient) VerifyIPFlow(resourceGroupName string, networkWatcherName string, parameters VerificationIPFlowParameters, cancel <-chan struct{}) (result autorest.Response, err error)

VerifyIPFlow verify IP flow from the specified VM to a location given the currently configured NSG rules. This method may poll for completion. Polling can be canceled by passing the cancel channel argument. The channel will be used to cancel polling and any outstanding HTTP requests.

resourceGroupName is the name of the resource group. networkWatcherName is the name of the network watcher. parameters is parameters that define the IP flow to be verified.

func (NetworkWatchersClient) VerifyIPFlowPreparer

func (client NetworkWatchersClient) VerifyIPFlowPreparer(resourceGroupName string, networkWatcherName string, parameters VerificationIPFlowParameters, cancel <-chan struct{}) (*http.Request, error)

VerifyIPFlowPreparer prepares the VerifyIPFlow request.

func (NetworkWatchersClient) VerifyIPFlowResponder

func (client NetworkWatchersClient) VerifyIPFlowResponder(resp *http.Response) (result autorest.Response, err error)

VerifyIPFlowResponder handles the response to the VerifyIPFlow request. The method always closes the http.Response Body.

func (NetworkWatchersClient) VerifyIPFlowSender

func (client NetworkWatchersClient) VerifyIPFlowSender(req *http.Request) (*http.Response, error)

VerifyIPFlowSender sends the VerifyIPFlow request. The method will close the http.Response Body if it receives an error.

type NextHopParameters

type NextHopParameters struct {
	TargetResourceID     *string `json:"targetResourceId,omitempty"`
	SourceIPAddress      *string `json:"sourceIPAddress,omitempty"`
	DestinationIPAddress *string `json:"destinationIPAddress,omitempty"`
	TargetNicResourceID  *string `json:"targetNicResourceId,omitempty"`
}

NextHopParameters is parameters that define the source and destination endpoint.

type NextHopResult

type NextHopResult struct {
	autorest.Response `json:"-"`
	NextHopType       NextHopType `json:"nextHopType,omitempty"`
	NextHopIPAddress  *string     `json:"nextHopIpAddress,omitempty"`
	RouteTableID      *string     `json:"routeTableId,omitempty"`
}

NextHopResult is the information about next hop from the specified VM.

type NextHopType

type NextHopType string

NextHopType enumerates the values for next hop type.

const (
	// HyperNetGateway specifies the hyper net gateway state for next hop type.
	HyperNetGateway NextHopType = "HyperNetGateway"
	// Internet specifies the internet state for next hop type.
	Internet NextHopType = "Internet"
	// None specifies the none state for next hop type.
	None NextHopType = "None"
	// VirtualAppliance specifies the virtual appliance state for next hop
	// type.
	VirtualAppliance NextHopType = "VirtualAppliance"
	// VirtualNetworkGateway specifies the virtual network gateway state for
	// next hop type.
	VirtualNetworkGateway NextHopType = "VirtualNetworkGateway"
	// VnetLocal specifies the vnet local state for next hop type.
	VnetLocal NextHopType = "VnetLocal"
)

type PacketCapture

type PacketCapture struct {
	*PacketCaptureParameters `json:"properties,omitempty"`
}

PacketCapture is parameters that define the create packet capture operation.

type PacketCaptureFilter

type PacketCaptureFilter struct {
	Protocol        PcProtocol `json:"protocol,omitempty"`
	LocalIPAddress  *string    `json:"localIPAddress,omitempty"`
	RemoteIPAddress *string    `json:"remoteIPAddress,omitempty"`
	LocalPort       *string    `json:"localPort,omitempty"`
	RemotePort      *string    `json:"remotePort,omitempty"`
}

PacketCaptureFilter is filter that is applied to packet capture request. Multiple filters can be applied.

type PacketCaptureListResult

type PacketCaptureListResult struct {
	autorest.Response `json:"-"`
	Value             *[]PacketCaptureResult `json:"value,omitempty"`
}

PacketCaptureListResult is list of packet capture sessions.

type PacketCaptureParameters

type PacketCaptureParameters struct {
	Target                  *string                       `json:"target,omitempty"`
	BytesToCapturePerPacket *int32                        `json:"bytesToCapturePerPacket,omitempty"`
	TotalBytesPerSession    *int32                        `json:"totalBytesPerSession,omitempty"`
	TimeLimitInSeconds      *int32                        `json:"timeLimitInSeconds,omitempty"`
	StorageLocation         *PacketCaptureStorageLocation `json:"storageLocation,omitempty"`
	Filters                 *[]PacketCaptureFilter        `json:"filters,omitempty"`
}

PacketCaptureParameters is parameters that define the create packet capture operation.

type PacketCaptureQueryStatusResult

type PacketCaptureQueryStatusResult struct {
	autorest.Response   `json:"-"`
	Name                *string    `json:"name,omitempty"`
	ID                  *string    `json:"id,omitempty"`
	CaptureStartTime    *date.Time `json:"captureStartTime,omitempty"`
	PacketCaptureStatus PcStatus   `json:"packetCaptureStatus,omitempty"`
	StopReason          *string    `json:"stopReason,omitempty"`
	PacketCaptureError  *[]PcError `json:"packetCaptureError,omitempty"`
}

PacketCaptureQueryStatusResult is status of packet capture session.

type PacketCaptureResult

type PacketCaptureResult struct {
	autorest.Response              `json:"-"`
	Name                           *string `json:"name,omitempty"`
	ID                             *string `json:"id,omitempty"`
	Etag                           *string `json:"etag,omitempty"`
	*PacketCaptureResultProperties `json:"properties,omitempty"`
}

PacketCaptureResult is information about packet capture session.

type PacketCaptureResultProperties

type PacketCaptureResultProperties struct {
	Target                  *string                       `json:"target,omitempty"`
	BytesToCapturePerPacket *int32                        `json:"bytesToCapturePerPacket,omitempty"`
	TotalBytesPerSession    *int32                        `json:"totalBytesPerSession,omitempty"`
	TimeLimitInSeconds      *int32                        `json:"timeLimitInSeconds,omitempty"`
	StorageLocation         *PacketCaptureStorageLocation `json:"storageLocation,omitempty"`
	Filters                 *[]PacketCaptureFilter        `json:"filters,omitempty"`
	ProvisioningState       ProvisioningState             `json:"provisioningState,omitempty"`
}

PacketCaptureResultProperties is describes the properties of a packet capture session.

type PacketCaptureStorageLocation

type PacketCaptureStorageLocation struct {
	StorageID   *string `json:"storageId,omitempty"`
	StoragePath *string `json:"storagePath,omitempty"`
	FilePath    *string `json:"filePath,omitempty"`
}

PacketCaptureStorageLocation is describes the storage location for a packet capture session.

type PacketCapturesClient

type PacketCapturesClient struct {
	ManagementClient
}

PacketCapturesClient is the the Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.

func NewPacketCapturesClient

func NewPacketCapturesClient(subscriptionID string) PacketCapturesClient

NewPacketCapturesClient creates an instance of the PacketCapturesClient client.

func NewPacketCapturesClientWithBaseURI

func NewPacketCapturesClientWithBaseURI(baseURI string, subscriptionID string) PacketCapturesClient

NewPacketCapturesClientWithBaseURI creates an instance of the PacketCapturesClient client.

func (PacketCapturesClient) Create

func (client PacketCapturesClient) Create(resourceGroupName string, networkWatcherName string, packetCaptureName string, parameters PacketCapture, cancel <-chan struct{}) (result autorest.Response, err error)

Create create and start a packet capture on the specified VM. This method may poll for completion. Polling can be canceled by passing the cancel channel argument. The channel will be used to cancel polling and any outstanding HTTP requests.

resourceGroupName is the name of the resource group. networkWatcherName is the name of the network watcher. packetCaptureName is the name of the packet capture session. parameters is parameters that define the create packet capture operation.

func (PacketCapturesClient) CreatePreparer

func (client PacketCapturesClient) CreatePreparer(resourceGroupName string, networkWatcherName string, packetCaptureName string, parameters PacketCapture, cancel <-chan struct{}) (*http.Request, error)

CreatePreparer prepares the Create request.

func (PacketCapturesClient) CreateResponder

func (client PacketCapturesClient) CreateResponder(resp *http.Response) (result autorest.Response, err error)

CreateResponder handles the response to the Create request. The method always closes the http.Response Body.

func (PacketCapturesClient) CreateSender

func (client PacketCapturesClient) CreateSender(req *http.Request) (*http.Response, error)

CreateSender sends the Create request. The method will close the http.Response Body if it receives an error.

func (PacketCapturesClient) Delete

func (client PacketCapturesClient) Delete(resourceGroupName string, networkWatcherName string, packetCaptureName string, cancel <-chan struct{}) (result autorest.Response, err error)

Delete deletes the specified packet capture session. This method may poll for completion. Polling can be canceled by passing the cancel channel argument. The channel will be used to cancel polling and any outstanding HTTP requests.

resourceGroupName is the name of the resource group. networkWatcherName is the name of the network watcher. packetCaptureName is the name of the packet capture session.

func (PacketCapturesClient) DeletePreparer

func (client PacketCapturesClient) DeletePreparer(resourceGroupName string, networkWatcherName string, packetCaptureName string, cancel <-chan struct{}) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (PacketCapturesClient) DeleteResponder

func (client PacketCapturesClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (PacketCapturesClient) DeleteSender

func (client PacketCapturesClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (PacketCapturesClient) Get

func (client PacketCapturesClient) Get(resourceGroupName string, networkWatcherName string, packetCaptureName string) (result PacketCaptureResult, err error)

Get gets a packet capture session by name.

resourceGroupName is the name of the resource group. networkWatcherName is the name of the network watcher. packetCaptureName is the name of the packet capture session.

func (PacketCapturesClient) GetPreparer

func (client PacketCapturesClient) GetPreparer(resourceGroupName string, networkWatcherName string, packetCaptureName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (PacketCapturesClient) GetResponder

func (client PacketCapturesClient) GetResponder(resp *http.Response) (result PacketCaptureResult, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (PacketCapturesClient) GetSender

func (client PacketCapturesClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (PacketCapturesClient) GetStatus

func (client PacketCapturesClient) GetStatus(resourceGroupName string, networkWatcherName string, packetCaptureName string, cancel <-chan struct{}) (result autorest.Response, err error)

GetStatus query the status of a running packet capture session. This method may poll for completion. Polling can be canceled by passing the cancel channel argument. The channel will be used to cancel polling and any outstanding HTTP requests.

resourceGroupName is the name of the resource group. networkWatcherName is the name of the Network Watcher resource. packetCaptureName is the name given to the packet capture session.

func (PacketCapturesClient) GetStatusPreparer

func (client PacketCapturesClient) GetStatusPreparer(resourceGroupName string, networkWatcherName string, packetCaptureName string, cancel <-chan struct{}) (*http.Request, error)

GetStatusPreparer prepares the GetStatus request.

func (PacketCapturesClient) GetStatusResponder

func (client PacketCapturesClient) GetStatusResponder(resp *http.Response) (result autorest.Response, err error)

GetStatusResponder handles the response to the GetStatus request. The method always closes the http.Response Body.

func (PacketCapturesClient) GetStatusSender

func (client PacketCapturesClient) GetStatusSender(req *http.Request) (*http.Response, error)

GetStatusSender sends the GetStatus request. The method will close the http.Response Body if it receives an error.

func (PacketCapturesClient) List

func (client PacketCapturesClient) List(resourceGroupName string, networkWatcherName string) (result PacketCaptureListResult, err error)

List lists all packet capture sessions within the specified resource group.

resourceGroupName is the name of the resource group. networkWatcherName is the name of the Network Watcher resource.

func (PacketCapturesClient) ListPreparer

func (client PacketCapturesClient) ListPreparer(resourceGroupName string, networkWatcherName string) (*http.Request, error)

ListPreparer prepares the List request.

func (PacketCapturesClient) ListResponder

func (client PacketCapturesClient) ListResponder(resp *http.Response) (result PacketCaptureListResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (PacketCapturesClient) ListSender

func (client PacketCapturesClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

func (PacketCapturesClient) Stop

func (client PacketCapturesClient) Stop(resourceGroupName string, networkWatcherName string, packetCaptureName string, cancel <-chan struct{}) (result autorest.Response, err error)

Stop stops a specified packet capture session. This method may poll for completion. Polling can be canceled by passing the cancel channel argument. The channel will be used to cancel polling and any outstanding HTTP requests.

resourceGroupName is the name of the resource group. networkWatcherName is the name of the network watcher. packetCaptureName is the name of the packet capture session.

func (PacketCapturesClient) StopPreparer

func (client PacketCapturesClient) StopPreparer(resourceGroupName string, networkWatcherName string, packetCaptureName string, cancel <-chan struct{}) (*http.Request, error)

StopPreparer prepares the Stop request.

func (PacketCapturesClient) StopResponder

func (client PacketCapturesClient) StopResponder(resp *http.Response) (result autorest.Response, err error)

StopResponder handles the response to the Stop request. The method always closes the http.Response Body.

func (PacketCapturesClient) StopSender

func (client PacketCapturesClient) StopSender(req *http.Request) (*http.Response, error)

StopSender sends the Stop request. The method will close the http.Response Body if it receives an error.

type PcError

type PcError string

PcError enumerates the values for pc error.

const (
	// AgentStopped specifies the agent stopped state for pc error.
	AgentStopped PcError = "AgentStopped"
	// CaptureFailed specifies the capture failed state for pc error.
	CaptureFailed PcError = "CaptureFailed"
	// InternalError specifies the internal error state for pc error.
	InternalError PcError = "InternalError"
	// LocalFileFailed specifies the local file failed state for pc error.
	LocalFileFailed PcError = "LocalFileFailed"
	// StorageFailed specifies the storage failed state for pc error.
	StorageFailed PcError = "StorageFailed"
)

type PcProtocol

type PcProtocol string

PcProtocol enumerates the values for pc protocol.

const (
	// Any specifies the any state for pc protocol.
	Any PcProtocol = "Any"
	// TCP specifies the tcp state for pc protocol.
	TCP PcProtocol = "TCP"
	// UDP specifies the udp state for pc protocol.
	UDP PcProtocol = "UDP"
)

type PcStatus

type PcStatus string

PcStatus enumerates the values for pc status.

const (
	// Error specifies the error state for pc status.
	Error PcStatus = "Error"
	// NotStarted specifies the not started state for pc status.
	NotStarted PcStatus = "NotStarted"
	// Running specifies the running state for pc status.
	Running PcStatus = "Running"
	// Stopped specifies the stopped state for pc status.
	Stopped PcStatus = "Stopped"
	// Unknown specifies the unknown state for pc status.
	Unknown PcStatus = "Unknown"
)

type PropertiesFormat

type PropertiesFormat struct {
	ProvisioningState ProvisioningState `json:"provisioningState,omitempty"`
}

PropertiesFormat is the network watcher properties.

type Protocol

type Protocol string

Protocol enumerates the values for protocol.

const (
	// ProtocolTCP specifies the protocol tcp state for protocol.
	ProtocolTCP Protocol = "TCP"
	// ProtocolUDP specifies the protocol udp state for protocol.
	ProtocolUDP Protocol = "UDP"
)

type ProvisioningState

type ProvisioningState string

ProvisioningState enumerates the values for provisioning state.

const (
	// Deleting specifies the deleting state for provisioning state.
	Deleting ProvisioningState = "Deleting"
	// Failed specifies the failed state for provisioning state.
	Failed ProvisioningState = "Failed"
	// Succeeded specifies the succeeded state for provisioning state.
	Succeeded ProvisioningState = "Succeeded"
	// Updating specifies the updating state for provisioning state.
	Updating ProvisioningState = "Updating"
)

type QueryTroubleshootingParameters

type QueryTroubleshootingParameters struct {
	TargetResourceID *string `json:"targetResourceId,omitempty"`
}

QueryTroubleshootingParameters is parameters that define the resource to query the troubleshooting result.

type Resource

type Resource struct {
	ID       *string             `json:"id,omitempty"`
	Name     *string             `json:"name,omitempty"`
	Type     *string             `json:"type,omitempty"`
	Location *string             `json:"location,omitempty"`
	Tags     *map[string]*string `json:"tags,omitempty"`
}

Resource is

type RetentionPolicyParameters

type RetentionPolicyParameters struct {
	Days    *int32 `json:"days,omitempty"`
	Enabled *bool  `json:"enabled,omitempty"`
}

RetentionPolicyParameters is parameters that define the retention policy for flow log.

type SecurityGroupNetworkInterface

type SecurityGroupNetworkInterface struct {
	ID                       *string                   `json:"id,omitempty"`
	SecurityRuleAssociations *SecurityRuleAssociations `json:"securityRuleAssociations,omitempty"`
}

SecurityGroupNetworkInterface is network interface and all its associated security rules.

type SecurityGroupViewParameters

type SecurityGroupViewParameters struct {
	TargetResourceID *string `json:"targetResourceId,omitempty"`
}

SecurityGroupViewParameters is parameters that define the VM to check security groups for.

type SecurityGroupViewResult

type SecurityGroupViewResult struct {
	autorest.Response `json:"-"`
	NetworkInterfaces *[]SecurityGroupNetworkInterface `json:"networkInterfaces,omitempty"`
}

SecurityGroupViewResult is the information about security rules applied to the specified VM.

type SecurityRule

type SecurityRule struct {
	ID                            *string `json:"id,omitempty"`
	*SecurityRulePropertiesFormat `json:"properties,omitempty"`
	Name                          *string `json:"name,omitempty"`
	Etag                          *string `json:"etag,omitempty"`
}

SecurityRule is network security rule.

type SecurityRuleAccess

type SecurityRuleAccess string

SecurityRuleAccess enumerates the values for security rule access.

const (
	// SecurityRuleAccessAllow specifies the security rule access allow state
	// for security rule access.
	SecurityRuleAccessAllow SecurityRuleAccess = "Allow"
	// SecurityRuleAccessDeny specifies the security rule access deny state for
	// security rule access.
	SecurityRuleAccessDeny SecurityRuleAccess = "Deny"
)

type SecurityRuleAssociations

type SecurityRuleAssociations struct {
	NetworkInterfaceAssociation *NetworkInterfaceAssociation    `json:"networkInterfaceAssociation,omitempty"`
	SubnetAssociation           *SubnetAssociation              `json:"subnetAssociation,omitempty"`
	DefaultSecurityRules        *[]SecurityRule                 `json:"defaultSecurityRules,omitempty"`
	EffectiveSecurityRules      *[]EffectiveNetworkSecurityRule `json:"effectiveSecurityRules,omitempty"`
}

SecurityRuleAssociations is all security rules associated with the network interface.

type SecurityRuleDirection

type SecurityRuleDirection string

SecurityRuleDirection enumerates the values for security rule direction.

const (
	// SecurityRuleDirectionInbound specifies the security rule direction
	// inbound state for security rule direction.
	SecurityRuleDirectionInbound SecurityRuleDirection = "Inbound"
	// SecurityRuleDirectionOutbound specifies the security rule direction
	// outbound state for security rule direction.
	SecurityRuleDirectionOutbound SecurityRuleDirection = "Outbound"
)

type SecurityRulePropertiesFormat

type SecurityRulePropertiesFormat struct {
	Description              *string               `json:"description,omitempty"`
	Protocol                 SecurityRuleProtocol  `json:"protocol,omitempty"`
	SourcePortRange          *string               `json:"sourcePortRange,omitempty"`
	DestinationPortRange     *string               `json:"destinationPortRange,omitempty"`
	SourceAddressPrefix      *string               `json:"sourceAddressPrefix,omitempty"`
	DestinationAddressPrefix *string               `json:"destinationAddressPrefix,omitempty"`
	Access                   SecurityRuleAccess    `json:"access,omitempty"`
	Priority                 *int32                `json:"priority,omitempty"`
	Direction                SecurityRuleDirection `json:"direction,omitempty"`
	ProvisioningState        *string               `json:"provisioningState,omitempty"`
}

SecurityRulePropertiesFormat is

type SecurityRuleProtocol

type SecurityRuleProtocol string

SecurityRuleProtocol enumerates the values for security rule protocol.

const (
	// SecurityRuleProtocolAsterisk specifies the security rule protocol
	// asterisk state for security rule protocol.
	SecurityRuleProtocolAsterisk SecurityRuleProtocol = "*"
	// SecurityRuleProtocolTCP specifies the security rule protocol tcp state
	// for security rule protocol.
	SecurityRuleProtocolTCP SecurityRuleProtocol = "Tcp"
	// SecurityRuleProtocolUDP specifies the security rule protocol udp state
	// for security rule protocol.
	SecurityRuleProtocolUDP SecurityRuleProtocol = "Udp"
)

type SubResource

type SubResource struct {
	ID *string `json:"id,omitempty"`
}

SubResource is

type SubnetAssociation

type SubnetAssociation struct {
	ID            *string         `json:"id,omitempty"`
	SecurityRules *[]SecurityRule `json:"securityRules,omitempty"`
}

SubnetAssociation is network interface and its custom security rules.

type Topology

type Topology struct {
	autorest.Response `json:"-"`
	ID                *string             `json:"id,omitempty"`
	CreatedDateTime   *date.Time          `json:"createdDateTime,omitempty"`
	LastModified      *date.Time          `json:"lastModified,omitempty"`
	Resources         *[]TopologyResource `json:"resources,omitempty"`
}

Topology is topology of the specified resource group.

type TopologyAssociation

type TopologyAssociation struct {
	Name            *string         `json:"name,omitempty"`
	ResourceID      *string         `json:"resourceId,omitempty"`
	AssociationType AssociationType `json:"associationType,omitempty"`
}

TopologyAssociation is resources that have an association with the parent resource.

type TopologyParameters

type TopologyParameters struct {
	TargetResourceGroupName *string `json:"targetResourceGroupName,omitempty"`
}

TopologyParameters is parameters that define the representation of topology.

type TopologyResource

type TopologyResource struct {
	Name         *string                `json:"name,omitempty"`
	ID           *string                `json:"id,omitempty"`
	Location     *string                `json:"location,omitempty"`
	Associations *[]TopologyAssociation `json:"associations,omitempty"`
}

TopologyResource is the network resource topology information for the given resource group.

type TroubleshootingDetails

type TroubleshootingDetails struct {
	ID                 *string                              `json:"id,omitempty"`
	ReasonType         *string                              `json:"reasonType,omitempty"`
	Summary            *string                              `json:"summary,omitempty"`
	Detail             *string                              `json:"detail,omitempty"`
	RecommendedActions *[]TroubleshootingRecommendedActions `json:"recommendedActions,omitempty"`
}

TroubleshootingDetails is information gained from troubleshooting of specified resource.

type TroubleshootingParameters

type TroubleshootingParameters struct {
	TargetResourceID           *string `json:"targetResourceId,omitempty"`
	*TroubleshootingProperties `json:"properties,omitempty"`
}

TroubleshootingParameters is parameters that define the resource to troubleshoot.

type TroubleshootingProperties

type TroubleshootingProperties struct {
	StorageID   *string `json:"storageId,omitempty"`
	StoragePath *string `json:"storagePath,omitempty"`
}

TroubleshootingProperties is storage location provided for troubleshoot.

type TroubleshootingRecommendedActions

type TroubleshootingRecommendedActions struct {
	ActionID      *string `json:"actionId,omitempty"`
	ActionText    *string `json:"actionText,omitempty"`
	ActionURI     *string `json:"actionUri,omitempty"`
	ActionURIText *string `json:"actionUriText,omitempty"`
}

TroubleshootingRecommendedActions is recommended actions based on discovered issues.

type TroubleshootingResult

type TroubleshootingResult struct {
	autorest.Response `json:"-"`
	StartTime         *date.Time                `json:"startTime,omitempty"`
	EndTime           *date.Time                `json:"endTime,omitempty"`
	Code              *string                   `json:"code,omitempty"`
	Results           *[]TroubleshootingDetails `json:"results,omitempty"`
}

TroubleshootingResult is troubleshooting information gained from specified resource.

type VerificationIPFlowParameters

type VerificationIPFlowParameters struct {
	TargetResourceID    *string   `json:"targetResourceId,omitempty"`
	Direction           Direction `json:"direction,omitempty"`
	Protocol            Protocol  `json:"protocol,omitempty"`
	LocalPort           *string   `json:"localPort,omitempty"`
	RemotePort          *string   `json:"remotePort,omitempty"`
	LocalIPAddress      *string   `json:"localIPAddress,omitempty"`
	RemoteIPAddress     *string   `json:"remoteIPAddress,omitempty"`
	TargetNicResourceID *string   `json:"targetNicResourceId,omitempty"`
}

VerificationIPFlowParameters is parameters that define the IP flow to be verified.

type VerificationIPFlowResult

type VerificationIPFlowResult struct {
	autorest.Response `json:"-"`
	Access            Access  `json:"access,omitempty"`
	RuleName          *string `json:"ruleName,omitempty"`
}

VerificationIPFlowResult is results of IP flow verification on the target resource.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL