import "github.com/Azure/azure-sdk-for-go/services/network/mgmt/2017-03-01/network"
Package network implements the Azure ARM Network service API version .
Network Client
applicationgateways.go bgpservicecommunities.go client.go enums.go expressroutecircuitauthorizations.go expressroutecircuitpeerings.go expressroutecircuits.go expressrouteserviceproviders.go interfacesgroup.go loadbalancers.go localnetworkgateways.go models.go packetcaptures.go publicipaddresses.go routefilterrules.go routefilters.go routes.go routetables.go securitygroups.go securityrules.go subnets.go usages.go version.go virtualnetworkgatewayconnections.go virtualnetworkgateways.go virtualnetworkpeerings.go virtualnetworks.go watchers.go
const (
// DefaultBaseURI is the default URI used for the service Network
DefaultBaseURI = "https://management.azure.com"
)UserAgent returns the UserAgent string to use when sending http.Requests.
Version returns the semantic version (see http://semver.org) of the client.
Access enumerates the values for access.
PossibleAccessValues returns an array of possible values for the Access const type.
type AddressSpace struct {
// AddressPrefixes - A list of address blocks reserved for this virtual network in CIDR notation.
AddressPrefixes *[]string `json:"addressPrefixes,omitempty"`
}AddressSpace addressSpace contains an array of IP address ranges that can be used by subnets of the virtual network.
type ApplicationGateway struct {
autorest.Response `json:"-"`
*ApplicationGatewayPropertiesFormat `json:"properties,omitempty"`
// Etag - A unique read-only string that changes whenever the resource is updated.
Etag *string `json:"etag,omitempty"`
// ID - Resource ID.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; Resource name.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; Resource type.
Type *string `json:"type,omitempty"`
// Location - Resource location.
Location *string `json:"location,omitempty"`
// Tags - Resource tags.
Tags map[string]*string `json:"tags"`
}ApplicationGateway application gateway resource
func (ag ApplicationGateway) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ApplicationGateway.
func (ag *ApplicationGateway) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ApplicationGateway struct.
type ApplicationGatewayAuthenticationCertificate struct {
*ApplicationGatewayAuthenticationCertificatePropertiesFormat `json:"properties,omitempty"`
// Name - Name of the resource that is unique within a resource group. This name can be used to access the resource.
Name *string `json:"name,omitempty"`
// Etag - A unique read-only string that changes whenever the resource is updated.
Etag *string `json:"etag,omitempty"`
// ID - Resource ID.
ID *string `json:"id,omitempty"`
}ApplicationGatewayAuthenticationCertificate authentication certificates of an application gateway.
func (agac ApplicationGatewayAuthenticationCertificate) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ApplicationGatewayAuthenticationCertificate.
func (agac *ApplicationGatewayAuthenticationCertificate) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ApplicationGatewayAuthenticationCertificate struct.
type ApplicationGatewayAuthenticationCertificatePropertiesFormat struct {
// Data - Certificate public data.
Data *string `json:"data,omitempty"`
// ProvisioningState - Provisioning state of the authentication certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.
ProvisioningState *string `json:"provisioningState,omitempty"`
}ApplicationGatewayAuthenticationCertificatePropertiesFormat authentication certificates properties of an application gateway.
type ApplicationGatewayAvailableWafRuleSetsResult struct {
autorest.Response `json:"-"`
// Value - The list of application gateway rule sets.
Value *[]ApplicationGatewayFirewallRuleSet `json:"value,omitempty"`
}ApplicationGatewayAvailableWafRuleSetsResult response for ApplicationGatewayAvailableWafRuleSets API service call.
type ApplicationGatewayBackendAddress struct {
// Fqdn - Fully qualified domain name (FQDN).
Fqdn *string `json:"fqdn,omitempty"`
// IPAddress - IP address
IPAddress *string `json:"ipAddress,omitempty"`
}ApplicationGatewayBackendAddress backend address of an application gateway.
type ApplicationGatewayBackendAddressPool struct {
*ApplicationGatewayBackendAddressPoolPropertiesFormat `json:"properties,omitempty"`
// Name - Resource that is unique within a resource group. This name can be used to access the resource.
Name *string `json:"name,omitempty"`
// Etag - A unique read-only string that changes whenever the resource is updated.
Etag *string `json:"etag,omitempty"`
// ID - Resource ID.
ID *string `json:"id,omitempty"`
}ApplicationGatewayBackendAddressPool backend Address Pool of an application gateway.
func (agbap ApplicationGatewayBackendAddressPool) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ApplicationGatewayBackendAddressPool.
func (agbap *ApplicationGatewayBackendAddressPool) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ApplicationGatewayBackendAddressPool struct.
type ApplicationGatewayBackendAddressPoolPropertiesFormat struct {
// BackendIPConfigurations - Collection of references to IPs defined in network interfaces.
BackendIPConfigurations *[]InterfaceIPConfiguration `json:"backendIPConfigurations,omitempty"`
// BackendAddresses - Backend addresses
BackendAddresses *[]ApplicationGatewayBackendAddress `json:"backendAddresses,omitempty"`
// ProvisioningState - Provisioning state of the backend address pool resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.
ProvisioningState *string `json:"provisioningState,omitempty"`
}ApplicationGatewayBackendAddressPoolPropertiesFormat properties of Backend Address Pool of an application gateway.
type ApplicationGatewayBackendHTTPSettings struct {
*ApplicationGatewayBackendHTTPSettingsPropertiesFormat `json:"properties,omitempty"`
// Name - Name of the resource that is unique within a resource group. This name can be used to access the resource.
Name *string `json:"name,omitempty"`
// Etag - A unique read-only string that changes whenever the resource is updated.
Etag *string `json:"etag,omitempty"`
// ID - Resource ID.
ID *string `json:"id,omitempty"`
}ApplicationGatewayBackendHTTPSettings backend address pool settings of an application gateway.
func (agbhs ApplicationGatewayBackendHTTPSettings) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ApplicationGatewayBackendHTTPSettings.
func (agbhs *ApplicationGatewayBackendHTTPSettings) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ApplicationGatewayBackendHTTPSettings struct.
type ApplicationGatewayBackendHTTPSettingsPropertiesFormat struct {
// Port - Port
Port *int32 `json:"port,omitempty"`
// Protocol - Protocol. Possible values include: 'HTTP', 'HTTPS'
Protocol ApplicationGatewayProtocol `json:"protocol,omitempty"`
// CookieBasedAffinity - Cookie based affinity. Possible values include: 'Enabled', 'Disabled'
CookieBasedAffinity ApplicationGatewayCookieBasedAffinity `json:"cookieBasedAffinity,omitempty"`
// RequestTimeout - Request timeout in seconds. Application Gateway will fail the request if response is not received within RequestTimeout. Acceptable values are from 1 second to 86400 seconds.
RequestTimeout *int32 `json:"requestTimeout,omitempty"`
// Probe - Probe resource of an application gateway.
Probe *SubResource `json:"probe,omitempty"`
// AuthenticationCertificates - Array of references to application gateway authentication certificates.
AuthenticationCertificates *[]SubResource `json:"authenticationCertificates,omitempty"`
// ProvisioningState - Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.
ProvisioningState *string `json:"provisioningState,omitempty"`
// ConnectionDraining - Connection draining of the backend http settings resource.
ConnectionDraining *ApplicationGatewayConnectionDraining `json:"connectionDraining,omitempty"`
}ApplicationGatewayBackendHTTPSettingsPropertiesFormat properties of Backend address pool settings of an application gateway.
type ApplicationGatewayBackendHealth struct {
autorest.Response `json:"-"`
BackendAddressPools *[]ApplicationGatewayBackendHealthPool `json:"backendAddressPools,omitempty"`
}ApplicationGatewayBackendHealth list of ApplicationGatewayBackendHealthPool resources.
type ApplicationGatewayBackendHealthHTTPSettings struct {
// BackendHTTPSettings - Reference of an ApplicationGatewayBackendHttpSettings resource.
BackendHTTPSettings *ApplicationGatewayBackendHTTPSettings `json:"backendHttpSettings,omitempty"`
// Servers - List of ApplicationGatewayBackendHealthServer resources.
Servers *[]ApplicationGatewayBackendHealthServer `json:"servers,omitempty"`
}ApplicationGatewayBackendHealthHTTPSettings application gateway BackendHealthHttp settings.
type ApplicationGatewayBackendHealthPool struct {
// BackendAddressPool - Reference of an ApplicationGatewayBackendAddressPool resource.
BackendAddressPool *ApplicationGatewayBackendAddressPool `json:"backendAddressPool,omitempty"`
// BackendHTTPSettingsCollection - List of ApplicationGatewayBackendHealthHttpSettings resources.
BackendHTTPSettingsCollection *[]ApplicationGatewayBackendHealthHTTPSettings `json:"backendHttpSettingsCollection,omitempty"`
}ApplicationGatewayBackendHealthPool application gateway BackendHealth pool.
type ApplicationGatewayBackendHealthServer struct {
// Address - IP address or FQDN of backend server.
Address *string `json:"address,omitempty"`
// IPConfiguration - Reference of IP configuration of backend server.
IPConfiguration *SubResource `json:"ipConfiguration,omitempty"`
// Health - Health of backend server. Possible values include: 'Unknown', 'Up', 'Down', 'Partial', 'Draining'
Health ApplicationGatewayBackendHealthServerHealth `json:"health,omitempty"`
}ApplicationGatewayBackendHealthServer application gateway backendhealth http settings.
ApplicationGatewayBackendHealthServerHealth enumerates the values for application gateway backend health server health.
const (
// Down ...
Down ApplicationGatewayBackendHealthServerHealth = "Down"
// Draining ...
Draining ApplicationGatewayBackendHealthServerHealth = "Draining"
// Partial ...
Partial ApplicationGatewayBackendHealthServerHealth = "Partial"
// Unknown ...
Unknown ApplicationGatewayBackendHealthServerHealth = "Unknown"
// Up ...
Up ApplicationGatewayBackendHealthServerHealth = "Up"
)func PossibleApplicationGatewayBackendHealthServerHealthValues() []ApplicationGatewayBackendHealthServerHealth
PossibleApplicationGatewayBackendHealthServerHealthValues returns an array of possible values for the ApplicationGatewayBackendHealthServerHealth const type.
type ApplicationGatewayConnectionDraining struct {
// Enabled - Whether connection draining is enabled or not.
Enabled *bool `json:"enabled,omitempty"`
// DrainTimeoutInSec - The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds.
DrainTimeoutInSec *int32 `json:"drainTimeoutInSec,omitempty"`
}ApplicationGatewayConnectionDraining connection draining allows open connections to a backend server to be active for a specified time after the backend server got removed from the configuration.
ApplicationGatewayCookieBasedAffinity enumerates the values for application gateway cookie based affinity.
const (
// Disabled ...
Disabled ApplicationGatewayCookieBasedAffinity = "Disabled"
// Enabled ...
Enabled ApplicationGatewayCookieBasedAffinity = "Enabled"
)func PossibleApplicationGatewayCookieBasedAffinityValues() []ApplicationGatewayCookieBasedAffinity
PossibleApplicationGatewayCookieBasedAffinityValues returns an array of possible values for the ApplicationGatewayCookieBasedAffinity const type.
type ApplicationGatewayFirewallDisabledRuleGroup struct {
// RuleGroupName - The name of the rule group that will be disabled.
RuleGroupName *string `json:"ruleGroupName,omitempty"`
// Rules - The list of rules that will be disabled. If null, all rules of the rule group will be disabled.
Rules *[]int32 `json:"rules,omitempty"`
}ApplicationGatewayFirewallDisabledRuleGroup allows to disable rules within a rule group or an entire rule group.
ApplicationGatewayFirewallMode enumerates the values for application gateway firewall mode.
const (
// Detection ...
Detection ApplicationGatewayFirewallMode = "Detection"
// Prevention ...
Prevention ApplicationGatewayFirewallMode = "Prevention"
)func PossibleApplicationGatewayFirewallModeValues() []ApplicationGatewayFirewallMode
PossibleApplicationGatewayFirewallModeValues returns an array of possible values for the ApplicationGatewayFirewallMode const type.
type ApplicationGatewayFirewallRule struct {
// RuleID - The identifier of the web application firewall rule.
RuleID *int32 `json:"ruleId,omitempty"`
// Description - The description of the web application firewall rule.
Description *string `json:"description,omitempty"`
}ApplicationGatewayFirewallRule a web application firewall rule.
type ApplicationGatewayFirewallRuleGroup struct {
// RuleGroupName - The name of the web application firewall rule group.
RuleGroupName *string `json:"ruleGroupName,omitempty"`
// Description - The description of the web application firewall rule group.
Description *string `json:"description,omitempty"`
// Rules - The rules of the web application firewall rule group.
Rules *[]ApplicationGatewayFirewallRule `json:"rules,omitempty"`
}ApplicationGatewayFirewallRuleGroup a web application firewall rule group.
type ApplicationGatewayFirewallRuleSet struct {
*ApplicationGatewayFirewallRuleSetPropertiesFormat `json:"properties,omitempty"`
// ID - Resource ID.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; Resource name.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; Resource type.
Type *string `json:"type,omitempty"`
// Location - Resource location.
Location *string `json:"location,omitempty"`
// Tags - Resource tags.
Tags map[string]*string `json:"tags"`
}ApplicationGatewayFirewallRuleSet a web application firewall rule set.
func (agfrs ApplicationGatewayFirewallRuleSet) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ApplicationGatewayFirewallRuleSet.
func (agfrs *ApplicationGatewayFirewallRuleSet) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ApplicationGatewayFirewallRuleSet struct.
type ApplicationGatewayFirewallRuleSetPropertiesFormat struct {
// ProvisioningState - The provisioning state of the web application firewall rule set.
ProvisioningState *string `json:"provisioningState,omitempty"`
// RuleSetType - The type of the web application firewall rule set.
RuleSetType *string `json:"ruleSetType,omitempty"`
// RuleSetVersion - The version of the web application firewall rule set type.
RuleSetVersion *string `json:"ruleSetVersion,omitempty"`
// RuleGroups - The rule groups of the web application firewall rule set.
RuleGroups *[]ApplicationGatewayFirewallRuleGroup `json:"ruleGroups,omitempty"`
}ApplicationGatewayFirewallRuleSetPropertiesFormat properties of the web application firewall rule set.
type ApplicationGatewayFrontendIPConfiguration struct {
*ApplicationGatewayFrontendIPConfigurationPropertiesFormat `json:"properties,omitempty"`
// Name - Name of the resource that is unique within a resource group. This name can be used to access the resource.
Name *string `json:"name,omitempty"`
// Etag - A unique read-only string that changes whenever the resource is updated.
Etag *string `json:"etag,omitempty"`
// ID - Resource ID.
ID *string `json:"id,omitempty"`
}ApplicationGatewayFrontendIPConfiguration frontend IP configuration of an application gateway.
func (agfic ApplicationGatewayFrontendIPConfiguration) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ApplicationGatewayFrontendIPConfiguration.
func (agfic *ApplicationGatewayFrontendIPConfiguration) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ApplicationGatewayFrontendIPConfiguration struct.
type ApplicationGatewayFrontendIPConfigurationPropertiesFormat struct {
// PrivateIPAddress - PrivateIPAddress of the network interface IP Configuration.
PrivateIPAddress *string `json:"privateIPAddress,omitempty"`
// PrivateIPAllocationMethod - PrivateIP allocation method. Possible values include: 'Static', 'Dynamic'
PrivateIPAllocationMethod IPAllocationMethod `json:"privateIPAllocationMethod,omitempty"`
// Subnet - Reference of the subnet resource.
Subnet *SubResource `json:"subnet,omitempty"`
// PublicIPAddress - Reference of the PublicIP resource.
PublicIPAddress *SubResource `json:"publicIPAddress,omitempty"`
// ProvisioningState - Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.
ProvisioningState *string `json:"provisioningState,omitempty"`
}ApplicationGatewayFrontendIPConfigurationPropertiesFormat properties of Frontend IP configuration of an application gateway.
type ApplicationGatewayFrontendPort struct {
*ApplicationGatewayFrontendPortPropertiesFormat `json:"properties,omitempty"`
// Name - Name of the resource that is unique within a resource group. This name can be used to access the resource.
Name *string `json:"name,omitempty"`
// Etag - A unique read-only string that changes whenever the resource is updated.
Etag *string `json:"etag,omitempty"`
// ID - Resource ID.
ID *string `json:"id,omitempty"`
}ApplicationGatewayFrontendPort frontend port of an application gateway.
func (agfp ApplicationGatewayFrontendPort) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ApplicationGatewayFrontendPort.
func (agfp *ApplicationGatewayFrontendPort) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ApplicationGatewayFrontendPort struct.
type ApplicationGatewayFrontendPortPropertiesFormat struct {
// Port - Frontend port
Port *int32 `json:"port,omitempty"`
// ProvisioningState - Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.
ProvisioningState *string `json:"provisioningState,omitempty"`
}ApplicationGatewayFrontendPortPropertiesFormat properties of Frontend port of an application gateway.
type ApplicationGatewayHTTPListener struct {
*ApplicationGatewayHTTPListenerPropertiesFormat `json:"properties,omitempty"`
// Name - Name of the resource that is unique within a resource group. This name can be used to access the resource.
Name *string `json:"name,omitempty"`
// Etag - A unique read-only string that changes whenever the resource is updated.
Etag *string `json:"etag,omitempty"`
// ID - Resource ID.
ID *string `json:"id,omitempty"`
}ApplicationGatewayHTTPListener http listener of an application gateway.
func (aghl ApplicationGatewayHTTPListener) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ApplicationGatewayHTTPListener.
func (aghl *ApplicationGatewayHTTPListener) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ApplicationGatewayHTTPListener struct.
type ApplicationGatewayHTTPListenerPropertiesFormat struct {
// FrontendIPConfiguration - Frontend IP configuration resource of an application gateway.
FrontendIPConfiguration *SubResource `json:"frontendIPConfiguration,omitempty"`
// FrontendPort - Frontend port resource of an application gateway.
FrontendPort *SubResource `json:"frontendPort,omitempty"`
// Protocol - Protocol. Possible values include: 'HTTP', 'HTTPS'
Protocol ApplicationGatewayProtocol `json:"protocol,omitempty"`
// HostName - Host name of HTTP listener.
HostName *string `json:"hostName,omitempty"`
// SslCertificate - SSL certificate resource of an application gateway.
SslCertificate *SubResource `json:"sslCertificate,omitempty"`
// RequireServerNameIndication - Applicable only if protocol is https. Enables SNI for multi-hosting.
RequireServerNameIndication *bool `json:"requireServerNameIndication,omitempty"`
// ProvisioningState - Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.
ProvisioningState *string `json:"provisioningState,omitempty"`
}ApplicationGatewayHTTPListenerPropertiesFormat properties of HTTP listener of an application gateway.
type ApplicationGatewayIPConfiguration struct {
*ApplicationGatewayIPConfigurationPropertiesFormat `json:"properties,omitempty"`
// Name - Name of the resource that is unique within a resource group. This name can be used to access the resource.
Name *string `json:"name,omitempty"`
// Etag - A unique read-only string that changes whenever the resource is updated.
Etag *string `json:"etag,omitempty"`
// ID - Resource ID.
ID *string `json:"id,omitempty"`
}ApplicationGatewayIPConfiguration IP configuration of an application gateway. Currently 1 public and 1 private IP configuration is allowed.
func (agic ApplicationGatewayIPConfiguration) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ApplicationGatewayIPConfiguration.
func (agic *ApplicationGatewayIPConfiguration) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ApplicationGatewayIPConfiguration struct.
type ApplicationGatewayIPConfigurationPropertiesFormat struct {
// Subnet - Reference of the subnet resource. A subnet from where application gateway gets its private address.
Subnet *SubResource `json:"subnet,omitempty"`
// ProvisioningState - Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.
ProvisioningState *string `json:"provisioningState,omitempty"`
}ApplicationGatewayIPConfigurationPropertiesFormat properties of IP configuration of an application gateway.
type ApplicationGatewayListResult struct {
autorest.Response `json:"-"`
// Value - List of an application gateways in a resource group.
Value *[]ApplicationGateway `json:"value,omitempty"`
// NextLink - URL to get the next set of results.
NextLink *string `json:"nextLink,omitempty"`
}ApplicationGatewayListResult response for ListApplicationGateways API service call.
func (aglr ApplicationGatewayListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type ApplicationGatewayListResultIterator struct {
// contains filtered or unexported fields
}ApplicationGatewayListResultIterator provides access to a complete listing of ApplicationGateway values.
func NewApplicationGatewayListResultIterator(page ApplicationGatewayListResultPage) ApplicationGatewayListResultIterator
Creates a new instance of the ApplicationGatewayListResultIterator type.
func (iter *ApplicationGatewayListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *ApplicationGatewayListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter ApplicationGatewayListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter ApplicationGatewayListResultIterator) Response() ApplicationGatewayListResult
Response returns the raw server response from the last page request.
func (iter ApplicationGatewayListResultIterator) Value() ApplicationGateway
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type ApplicationGatewayListResultPage struct {
// contains filtered or unexported fields
}ApplicationGatewayListResultPage contains a page of ApplicationGateway values.
func NewApplicationGatewayListResultPage(cur ApplicationGatewayListResult, getNextPage func(context.Context, ApplicationGatewayListResult) (ApplicationGatewayListResult, error)) ApplicationGatewayListResultPage
Creates a new instance of the ApplicationGatewayListResultPage type.
func (page *ApplicationGatewayListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *ApplicationGatewayListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page ApplicationGatewayListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page ApplicationGatewayListResultPage) Response() ApplicationGatewayListResult
Response returns the raw server response from the last page request.
func (page ApplicationGatewayListResultPage) Values() []ApplicationGateway
Values returns the slice of values for the current page or nil if there are no values.
ApplicationGatewayOperationalState enumerates the values for application gateway operational state.
const (
// Running ...
Running ApplicationGatewayOperationalState = "Running"
// Starting ...
Starting ApplicationGatewayOperationalState = "Starting"
// Stopped ...
Stopped ApplicationGatewayOperationalState = "Stopped"
// Stopping ...
Stopping ApplicationGatewayOperationalState = "Stopping"
)func PossibleApplicationGatewayOperationalStateValues() []ApplicationGatewayOperationalState
PossibleApplicationGatewayOperationalStateValues returns an array of possible values for the ApplicationGatewayOperationalState const type.
type ApplicationGatewayPathRule struct {
*ApplicationGatewayPathRulePropertiesFormat `json:"properties,omitempty"`
// Name - Name of the resource that is unique within a resource group. This name can be used to access the resource.
Name *string `json:"name,omitempty"`
// Etag - A unique read-only string that changes whenever the resource is updated.
Etag *string `json:"etag,omitempty"`
// ID - Resource ID.
ID *string `json:"id,omitempty"`
}ApplicationGatewayPathRule path rule of URL path map of an application gateway.
func (agpr ApplicationGatewayPathRule) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ApplicationGatewayPathRule.
func (agpr *ApplicationGatewayPathRule) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ApplicationGatewayPathRule struct.
type ApplicationGatewayPathRulePropertiesFormat struct {
// Paths - Path rules of URL path map.
Paths *[]string `json:"paths,omitempty"`
// BackendAddressPool - Backend address pool resource of URL path map.
BackendAddressPool *SubResource `json:"backendAddressPool,omitempty"`
// BackendHTTPSettings - Backend http settings resource of URL path map.
BackendHTTPSettings *SubResource `json:"backendHttpSettings,omitempty"`
// ProvisioningState - Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.
ProvisioningState *string `json:"provisioningState,omitempty"`
}ApplicationGatewayPathRulePropertiesFormat properties of probe of an application gateway.
type ApplicationGatewayProbe struct {
*ApplicationGatewayProbePropertiesFormat `json:"properties,omitempty"`
// Name - Name of the resource that is unique within a resource group. This name can be used to access the resource.
Name *string `json:"name,omitempty"`
// Etag - A unique read-only string that changes whenever the resource is updated.
Etag *string `json:"etag,omitempty"`
// ID - Resource ID.
ID *string `json:"id,omitempty"`
}ApplicationGatewayProbe probe of the application gateway.
func (agp ApplicationGatewayProbe) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ApplicationGatewayProbe.
func (agp *ApplicationGatewayProbe) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ApplicationGatewayProbe struct.
type ApplicationGatewayProbePropertiesFormat struct {
// Protocol - Protocol. Possible values include: 'HTTP', 'HTTPS'
Protocol ApplicationGatewayProtocol `json:"protocol,omitempty"`
// Host - Host name to send the probe to.
Host *string `json:"host,omitempty"`
// Path - Relative path of probe. Valid path starts from '/'. Probe is sent to <Protocol>://<host>:<port><path>
Path *string `json:"path,omitempty"`
// Interval - The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds.
Interval *int32 `json:"interval,omitempty"`
// Timeout - the probe timeout in seconds. Probe marked as failed if valid response is not received with this timeout period. Acceptable values are from 1 second to 86400 seconds.
Timeout *int32 `json:"timeout,omitempty"`
// UnhealthyThreshold - The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20.
UnhealthyThreshold *int32 `json:"unhealthyThreshold,omitempty"`
// ProvisioningState - Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.
ProvisioningState *string `json:"provisioningState,omitempty"`
}ApplicationGatewayProbePropertiesFormat properties of probe of an application gateway.
type ApplicationGatewayPropertiesFormat struct {
// Sku - SKU of the application gateway resource.
Sku *ApplicationGatewaySku `json:"sku,omitempty"`
// SslPolicy - SSL policy of the application gateway resource.
SslPolicy *ApplicationGatewaySslPolicy `json:"sslPolicy,omitempty"`
// OperationalState - READ-ONLY; Operational state of the application gateway resource. Possible values include: 'Stopped', 'Starting', 'Running', 'Stopping'
OperationalState ApplicationGatewayOperationalState `json:"operationalState,omitempty"`
// GatewayIPConfigurations - Subnets of application the gateway resource.
GatewayIPConfigurations *[]ApplicationGatewayIPConfiguration `json:"gatewayIPConfigurations,omitempty"`
// AuthenticationCertificates - Authentication certificates of the application gateway resource.
AuthenticationCertificates *[]ApplicationGatewayAuthenticationCertificate `json:"authenticationCertificates,omitempty"`
// SslCertificates - SSL certificates of the application gateway resource.
SslCertificates *[]ApplicationGatewaySslCertificate `json:"sslCertificates,omitempty"`
// FrontendIPConfigurations - Frontend IP addresses of the application gateway resource.
FrontendIPConfigurations *[]ApplicationGatewayFrontendIPConfiguration `json:"frontendIPConfigurations,omitempty"`
// FrontendPorts - Frontend ports of the application gateway resource.
FrontendPorts *[]ApplicationGatewayFrontendPort `json:"frontendPorts,omitempty"`
// Probes - Probes of the application gateway resource.
Probes *[]ApplicationGatewayProbe `json:"probes,omitempty"`
// BackendAddressPools - Backend address pool of the application gateway resource.
BackendAddressPools *[]ApplicationGatewayBackendAddressPool `json:"backendAddressPools,omitempty"`
// BackendHTTPSettingsCollection - Backend http settings of the application gateway resource.
BackendHTTPSettingsCollection *[]ApplicationGatewayBackendHTTPSettings `json:"backendHttpSettingsCollection,omitempty"`
// HTTPListeners - Http listeners of the application gateway resource.
HTTPListeners *[]ApplicationGatewayHTTPListener `json:"httpListeners,omitempty"`
// URLPathMaps - URL path map of the application gateway resource.
URLPathMaps *[]ApplicationGatewayURLPathMap `json:"urlPathMaps,omitempty"`
// RequestRoutingRules - Request routing rules of the application gateway resource.
RequestRoutingRules *[]ApplicationGatewayRequestRoutingRule `json:"requestRoutingRules,omitempty"`
// WebApplicationFirewallConfiguration - Web application firewall configuration.
WebApplicationFirewallConfiguration *ApplicationGatewayWebApplicationFirewallConfiguration `json:"webApplicationFirewallConfiguration,omitempty"`
// ResourceGUID - Resource GUID property of the application gateway resource.
ResourceGUID *string `json:"resourceGuid,omitempty"`
// ProvisioningState - Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.
ProvisioningState *string `json:"provisioningState,omitempty"`
}ApplicationGatewayPropertiesFormat properties of the application gateway.
func (agpf ApplicationGatewayPropertiesFormat) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ApplicationGatewayPropertiesFormat.
ApplicationGatewayProtocol enumerates the values for application gateway protocol.
const (
// HTTP ...
HTTP ApplicationGatewayProtocol = "Http"
// HTTPS ...
HTTPS ApplicationGatewayProtocol = "Https"
)func PossibleApplicationGatewayProtocolValues() []ApplicationGatewayProtocol
PossibleApplicationGatewayProtocolValues returns an array of possible values for the ApplicationGatewayProtocol const type.
type ApplicationGatewayRequestRoutingRule struct {
*ApplicationGatewayRequestRoutingRulePropertiesFormat `json:"properties,omitempty"`
// Name - Name of the resource that is unique within a resource group. This name can be used to access the resource.
Name *string `json:"name,omitempty"`
// Etag - A unique read-only string that changes whenever the resource is updated.
Etag *string `json:"etag,omitempty"`
// ID - Resource ID.
ID *string `json:"id,omitempty"`
}ApplicationGatewayRequestRoutingRule request routing rule of an application gateway.
func (agrrr ApplicationGatewayRequestRoutingRule) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ApplicationGatewayRequestRoutingRule.
func (agrrr *ApplicationGatewayRequestRoutingRule) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ApplicationGatewayRequestRoutingRule struct.
type ApplicationGatewayRequestRoutingRulePropertiesFormat struct {
// RuleType - Rule type. Possible values include: 'Basic', 'PathBasedRouting'
RuleType ApplicationGatewayRequestRoutingRuleType `json:"ruleType,omitempty"`
// BackendAddressPool - Backend address pool resource of the application gateway.
BackendAddressPool *SubResource `json:"backendAddressPool,omitempty"`
// BackendHTTPSettings - Frontend port resource of the application gateway.
BackendHTTPSettings *SubResource `json:"backendHttpSettings,omitempty"`
// HTTPListener - Http listener resource of the application gateway.
HTTPListener *SubResource `json:"httpListener,omitempty"`
// URLPathMap - URL path map resource of the application gateway.
URLPathMap *SubResource `json:"urlPathMap,omitempty"`
// ProvisioningState - Provisioning state of the request routing rule resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.
ProvisioningState *string `json:"provisioningState,omitempty"`
}ApplicationGatewayRequestRoutingRulePropertiesFormat properties of request routing rule of the application gateway.
ApplicationGatewayRequestRoutingRuleType enumerates the values for application gateway request routing rule type.
const (
// Basic ...
Basic ApplicationGatewayRequestRoutingRuleType = "Basic"
// PathBasedRouting ...
PathBasedRouting ApplicationGatewayRequestRoutingRuleType = "PathBasedRouting"
)func PossibleApplicationGatewayRequestRoutingRuleTypeValues() []ApplicationGatewayRequestRoutingRuleType
PossibleApplicationGatewayRequestRoutingRuleTypeValues returns an array of possible values for the ApplicationGatewayRequestRoutingRuleType const type.
type ApplicationGatewaySku struct {
// Name - Name of an application gateway SKU. Possible values include: 'StandardSmall', 'StandardMedium', 'StandardLarge', 'WAFMedium', 'WAFLarge'
Name ApplicationGatewaySkuName `json:"name,omitempty"`
// Tier - Tier of an application gateway. Possible values include: 'Standard', 'WAF'
Tier ApplicationGatewayTier `json:"tier,omitempty"`
// Capacity - Capacity (instance count) of an application gateway.
Capacity *int32 `json:"capacity,omitempty"`
}ApplicationGatewaySku SKU of an application gateway
ApplicationGatewaySkuName enumerates the values for application gateway sku name.
const (
// StandardLarge ...
StandardLarge ApplicationGatewaySkuName = "Standard_Large"
// StandardMedium ...
StandardMedium ApplicationGatewaySkuName = "Standard_Medium"
// StandardSmall ...
StandardSmall ApplicationGatewaySkuName = "Standard_Small"
// WAFLarge ...
WAFLarge ApplicationGatewaySkuName = "WAF_Large"
// WAFMedium ...
WAFMedium ApplicationGatewaySkuName = "WAF_Medium"
)func PossibleApplicationGatewaySkuNameValues() []ApplicationGatewaySkuName
PossibleApplicationGatewaySkuNameValues returns an array of possible values for the ApplicationGatewaySkuName const type.
type ApplicationGatewaySslCertificate struct {
*ApplicationGatewaySslCertificatePropertiesFormat `json:"properties,omitempty"`
// Name - Name of the resource that is unique within a resource group. This name can be used to access the resource.
Name *string `json:"name,omitempty"`
// Etag - A unique read-only string that changes whenever the resource is updated.
Etag *string `json:"etag,omitempty"`
// ID - Resource ID.
ID *string `json:"id,omitempty"`
}ApplicationGatewaySslCertificate SSL certificates of an application gateway.
func (agsc ApplicationGatewaySslCertificate) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ApplicationGatewaySslCertificate.
func (agsc *ApplicationGatewaySslCertificate) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ApplicationGatewaySslCertificate struct.
type ApplicationGatewaySslCertificatePropertiesFormat struct {
// Data - Base-64 encoded pfx certificate. Only applicable in PUT Request.
Data *string `json:"data,omitempty"`
// Password - Password for the pfx file specified in data. Only applicable in PUT request.
Password *string `json:"password,omitempty"`
// PublicCertData - Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request.
PublicCertData *string `json:"publicCertData,omitempty"`
// ProvisioningState - Provisioning state of the SSL certificate resource Possible values are: 'Updating', 'Deleting', and 'Failed'.
ProvisioningState *string `json:"provisioningState,omitempty"`
}ApplicationGatewaySslCertificatePropertiesFormat properties of SSL certificates of an application gateway.
type ApplicationGatewaySslPolicy struct {
// DisabledSslProtocols - SSL protocols to be disabled on application gateway.
DisabledSslProtocols *[]ApplicationGatewaySslProtocol `json:"disabledSslProtocols,omitempty"`
}ApplicationGatewaySslPolicy application gateway SSL policy.
ApplicationGatewaySslProtocol enumerates the values for application gateway ssl protocol.
const (
// TLSv10 ...
TLSv10 ApplicationGatewaySslProtocol = "TLSv1_0"
// TLSv11 ...
TLSv11 ApplicationGatewaySslProtocol = "TLSv1_1"
// TLSv12 ...
TLSv12 ApplicationGatewaySslProtocol = "TLSv1_2"
)func PossibleApplicationGatewaySslProtocolValues() []ApplicationGatewaySslProtocol
PossibleApplicationGatewaySslProtocolValues returns an array of possible values for the ApplicationGatewaySslProtocol const type.
ApplicationGatewayTier enumerates the values for application gateway tier.
const (
// Standard ...
Standard ApplicationGatewayTier = "Standard"
// WAF ...
WAF ApplicationGatewayTier = "WAF"
)func PossibleApplicationGatewayTierValues() []ApplicationGatewayTier
PossibleApplicationGatewayTierValues returns an array of possible values for the ApplicationGatewayTier const type.
type ApplicationGatewayURLPathMap struct {
*ApplicationGatewayURLPathMapPropertiesFormat `json:"properties,omitempty"`
// Name - Name of the resource that is unique within a resource group. This name can be used to access the resource.
Name *string `json:"name,omitempty"`
// Etag - A unique read-only string that changes whenever the resource is updated.
Etag *string `json:"etag,omitempty"`
// ID - Resource ID.
ID *string `json:"id,omitempty"`
}ApplicationGatewayURLPathMap urlPathMaps give a url path to the backend mapping information for PathBasedRouting.
func (agupm ApplicationGatewayURLPathMap) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ApplicationGatewayURLPathMap.
func (agupm *ApplicationGatewayURLPathMap) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ApplicationGatewayURLPathMap struct.
type ApplicationGatewayURLPathMapPropertiesFormat struct {
// DefaultBackendAddressPool - Default backend address pool resource of URL path map.
DefaultBackendAddressPool *SubResource `json:"defaultBackendAddressPool,omitempty"`
// DefaultBackendHTTPSettings - Default backend http settings resource of URL path map.
DefaultBackendHTTPSettings *SubResource `json:"defaultBackendHttpSettings,omitempty"`
// PathRules - Path rule of URL path map resource.
PathRules *[]ApplicationGatewayPathRule `json:"pathRules,omitempty"`
// ProvisioningState - Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.
ProvisioningState *string `json:"provisioningState,omitempty"`
}ApplicationGatewayURLPathMapPropertiesFormat properties of UrlPathMap of the application gateway.
type ApplicationGatewayWebApplicationFirewallConfiguration struct {
// Enabled - Whether the web application firewall is enabled or not.
Enabled *bool `json:"enabled,omitempty"`
// FirewallMode - Web application firewall mode. Possible values include: 'Detection', 'Prevention'
FirewallMode ApplicationGatewayFirewallMode `json:"firewallMode,omitempty"`
// RuleSetType - The type of the web application firewall rule set. Possible values are: 'OWASP'.
RuleSetType *string `json:"ruleSetType,omitempty"`
// RuleSetVersion - The version of the rule set type.
RuleSetVersion *string `json:"ruleSetVersion,omitempty"`
// DisabledRuleGroups - The disabled rule groups.
DisabledRuleGroups *[]ApplicationGatewayFirewallDisabledRuleGroup `json:"disabledRuleGroups,omitempty"`
}ApplicationGatewayWebApplicationFirewallConfiguration application gateway web application firewall configuration.
type ApplicationGatewaysBackendHealthFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(ApplicationGatewaysClient) (ApplicationGatewayBackendHealth, error)
}ApplicationGatewaysBackendHealthFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type ApplicationGatewaysClient struct {
BaseClient
}ApplicationGatewaysClient is the network Client
func NewApplicationGatewaysClient(subscriptionID string) ApplicationGatewaysClient
NewApplicationGatewaysClient creates an instance of the ApplicationGatewaysClient client.
func NewApplicationGatewaysClientWithBaseURI(baseURI string, subscriptionID string) ApplicationGatewaysClient
NewApplicationGatewaysClientWithBaseURI creates an instance of the ApplicationGatewaysClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client ApplicationGatewaysClient) BackendHealth(ctx context.Context, resourceGroupName string, applicationGatewayName string, expand string) (result ApplicationGatewaysBackendHealthFuture, err error)
BackendHealth gets the backend health of the specified application gateway in a resource group. Parameters: resourceGroupName - the name of the resource group. applicationGatewayName - the name of the application gateway. expand - expands BackendAddressPool and BackendHttpSettings referenced in backend health.
func (client ApplicationGatewaysClient) BackendHealthPreparer(ctx context.Context, resourceGroupName string, applicationGatewayName string, expand string) (*http.Request, error)
BackendHealthPreparer prepares the BackendHealth request.
func (client ApplicationGatewaysClient) BackendHealthResponder(resp *http.Response) (result ApplicationGatewayBackendHealth, err error)
BackendHealthResponder handles the response to the BackendHealth request. The method always closes the http.Response Body.
func (client ApplicationGatewaysClient) BackendHealthSender(req *http.Request) (future ApplicationGatewaysBackendHealthFuture, err error)
BackendHealthSender sends the BackendHealth request. The method will close the http.Response Body if it receives an error.
func (client ApplicationGatewaysClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, applicationGatewayName string, parameters ApplicationGateway) (result ApplicationGatewaysCreateOrUpdateFuture, err error)
CreateOrUpdate creates or updates the specified application gateway. Parameters: resourceGroupName - the name of the resource group. applicationGatewayName - the name of the application gateway. parameters - parameters supplied to the create or update application gateway operation.
func (client ApplicationGatewaysClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, applicationGatewayName string, parameters ApplicationGateway) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client ApplicationGatewaysClient) CreateOrUpdateResponder(resp *http.Response) (result ApplicationGateway, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client ApplicationGatewaysClient) CreateOrUpdateSender(req *http.Request) (future ApplicationGatewaysCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client ApplicationGatewaysClient) Delete(ctx context.Context, resourceGroupName string, applicationGatewayName string) (result ApplicationGatewaysDeleteFuture, err error)
Delete deletes the specified application gateway. Parameters: resourceGroupName - the name of the resource group. applicationGatewayName - the name of the application gateway.
func (client ApplicationGatewaysClient) DeletePreparer(ctx context.Context, resourceGroupName string, applicationGatewayName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client ApplicationGatewaysClient) 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 (client ApplicationGatewaysClient) DeleteSender(req *http.Request) (future ApplicationGatewaysDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client ApplicationGatewaysClient) Get(ctx context.Context, resourceGroupName string, applicationGatewayName string) (result ApplicationGateway, err error)
Get gets the specified application gateway. Parameters: resourceGroupName - the name of the resource group. applicationGatewayName - the name of the application gateway.
func (client ApplicationGatewaysClient) GetPreparer(ctx context.Context, resourceGroupName string, applicationGatewayName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client ApplicationGatewaysClient) GetResponder(resp *http.Response) (result ApplicationGateway, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client ApplicationGatewaysClient) List(ctx context.Context, resourceGroupName string) (result ApplicationGatewayListResultPage, err error)
List lists all application gateways in a resource group. Parameters: resourceGroupName - the name of the resource group.
func (client ApplicationGatewaysClient) ListAll(ctx context.Context) (result ApplicationGatewayListResultPage, err error)
ListAll gets all the application gateways in a subscription.
func (client ApplicationGatewaysClient) ListAllComplete(ctx context.Context) (result ApplicationGatewayListResultIterator, err error)
ListAllComplete enumerates all values, automatically crossing page boundaries as required.
func (client ApplicationGatewaysClient) ListAllPreparer(ctx context.Context) (*http.Request, error)
ListAllPreparer prepares the ListAll request.
func (client ApplicationGatewaysClient) ListAllResponder(resp *http.Response) (result ApplicationGatewayListResult, err error)
ListAllResponder handles the response to the ListAll request. The method always closes the http.Response Body.
ListAllSender sends the ListAll request. The method will close the http.Response Body if it receives an error.
func (client ApplicationGatewaysClient) ListAvailableWafRuleSets(ctx context.Context) (result ApplicationGatewayAvailableWafRuleSetsResult, err error)
ListAvailableWafRuleSets lists all available web application firewall rule sets.
func (client ApplicationGatewaysClient) ListAvailableWafRuleSetsPreparer(ctx context.Context) (*http.Request, error)
ListAvailableWafRuleSetsPreparer prepares the ListAvailableWafRuleSets request.
func (client ApplicationGatewaysClient) ListAvailableWafRuleSetsResponder(resp *http.Response) (result ApplicationGatewayAvailableWafRuleSetsResult, err error)
ListAvailableWafRuleSetsResponder handles the response to the ListAvailableWafRuleSets request. The method always closes the http.Response Body.
func (client ApplicationGatewaysClient) ListAvailableWafRuleSetsSender(req *http.Request) (*http.Response, error)
ListAvailableWafRuleSetsSender sends the ListAvailableWafRuleSets request. The method will close the http.Response Body if it receives an error.
func (client ApplicationGatewaysClient) ListComplete(ctx context.Context, resourceGroupName string) (result ApplicationGatewayListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client ApplicationGatewaysClient) ListPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
ListPreparer prepares the List request.
func (client ApplicationGatewaysClient) ListResponder(resp *http.Response) (result ApplicationGatewayListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
func (client ApplicationGatewaysClient) Start(ctx context.Context, resourceGroupName string, applicationGatewayName string) (result ApplicationGatewaysStartFuture, err error)
Start starts the specified application gateway. Parameters: resourceGroupName - the name of the resource group. applicationGatewayName - the name of the application gateway.
func (client ApplicationGatewaysClient) StartPreparer(ctx context.Context, resourceGroupName string, applicationGatewayName string) (*http.Request, error)
StartPreparer prepares the Start request.
func (client ApplicationGatewaysClient) StartResponder(resp *http.Response) (result autorest.Response, err error)
StartResponder handles the response to the Start request. The method always closes the http.Response Body.
func (client ApplicationGatewaysClient) StartSender(req *http.Request) (future ApplicationGatewaysStartFuture, err error)
StartSender sends the Start request. The method will close the http.Response Body if it receives an error.
func (client ApplicationGatewaysClient) Stop(ctx context.Context, resourceGroupName string, applicationGatewayName string) (result ApplicationGatewaysStopFuture, err error)
Stop stops the specified application gateway in a resource group. Parameters: resourceGroupName - the name of the resource group. applicationGatewayName - the name of the application gateway.
func (client ApplicationGatewaysClient) StopPreparer(ctx context.Context, resourceGroupName string, applicationGatewayName string) (*http.Request, error)
StopPreparer prepares the Stop request.
func (client ApplicationGatewaysClient) 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 (client ApplicationGatewaysClient) StopSender(req *http.Request) (future ApplicationGatewaysStopFuture, err error)
StopSender sends the Stop request. The method will close the http.Response Body if it receives an error.
type ApplicationGatewaysCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(ApplicationGatewaysClient) (ApplicationGateway, error)
}ApplicationGatewaysCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type ApplicationGatewaysDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(ApplicationGatewaysClient) (autorest.Response, error)
}ApplicationGatewaysDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type ApplicationGatewaysStartFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(ApplicationGatewaysClient) (autorest.Response, error)
}ApplicationGatewaysStartFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type ApplicationGatewaysStopFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(ApplicationGatewaysClient) (autorest.Response, error)
}ApplicationGatewaysStopFuture an abstraction for monitoring and retrieving the results of a long-running operation.
AssociationType enumerates the values for association type.
const (
// Associated ...
Associated AssociationType = "Associated"
// Contains ...
Contains AssociationType = "Contains"
)func PossibleAssociationTypeValues() []AssociationType
PossibleAssociationTypeValues returns an array of possible values for the AssociationType const type.
type AuthorizationListResult struct {
autorest.Response `json:"-"`
// Value - The authorizations in an ExpressRoute Circuit.
Value *[]ExpressRouteCircuitAuthorization `json:"value,omitempty"`
// NextLink - The URL to get the next set of results.
NextLink *string `json:"nextLink,omitempty"`
}AuthorizationListResult response for ListAuthorizations API service call retrieves all authorizations that belongs to an ExpressRouteCircuit.
func (alr AuthorizationListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type AuthorizationListResultIterator struct {
// contains filtered or unexported fields
}AuthorizationListResultIterator provides access to a complete listing of ExpressRouteCircuitAuthorization values.
func NewAuthorizationListResultIterator(page AuthorizationListResultPage) AuthorizationListResultIterator
Creates a new instance of the AuthorizationListResultIterator type.
func (iter *AuthorizationListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *AuthorizationListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter AuthorizationListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter AuthorizationListResultIterator) Response() AuthorizationListResult
Response returns the raw server response from the last page request.
func (iter AuthorizationListResultIterator) Value() ExpressRouteCircuitAuthorization
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type AuthorizationListResultPage struct {
// contains filtered or unexported fields
}AuthorizationListResultPage contains a page of ExpressRouteCircuitAuthorization values.
func NewAuthorizationListResultPage(cur AuthorizationListResult, getNextPage func(context.Context, AuthorizationListResult) (AuthorizationListResult, error)) AuthorizationListResultPage
Creates a new instance of the AuthorizationListResultPage type.
func (page *AuthorizationListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *AuthorizationListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page AuthorizationListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page AuthorizationListResultPage) Response() AuthorizationListResult
Response returns the raw server response from the last page request.
func (page AuthorizationListResultPage) Values() []ExpressRouteCircuitAuthorization
Values returns the slice of values for the current page or nil if there are no values.
type AuthorizationPropertiesFormat struct {
// AuthorizationKey - The authorization key.
AuthorizationKey *string `json:"authorizationKey,omitempty"`
// AuthorizationUseStatus - AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'. Possible values include: 'Available', 'InUse'
AuthorizationUseStatus AuthorizationUseStatus `json:"authorizationUseStatus,omitempty"`
// ProvisioningState - Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.
ProvisioningState *string `json:"provisioningState,omitempty"`
}AuthorizationPropertiesFormat ...
AuthorizationUseStatus enumerates the values for authorization use status.
const (
// Available ...
Available AuthorizationUseStatus = "Available"
// InUse ...
InUse AuthorizationUseStatus = "InUse"
)func PossibleAuthorizationUseStatusValues() []AuthorizationUseStatus
PossibleAuthorizationUseStatusValues returns an array of possible values for the AuthorizationUseStatus const type.
type AzureAsyncOperationResult struct {
// Status - Status of the Azure async operation. Possible values are: 'InProgress', 'Succeeded', and 'Failed'. Possible values include: 'InProgress', 'Succeeded', 'Failed'
Status OperationStatus `json:"status,omitempty"`
Error *Error `json:"error,omitempty"`
}AzureAsyncOperationResult the response body contains the status of the specified asynchronous operation, indicating whether it has succeeded, is in progress, or has failed. Note that this status is distinct from the HTTP status code returned for the Get Operation Status operation itself. If the asynchronous operation succeeded, the response body includes the HTTP status code for the successful request. If the asynchronous operation failed, the response body includes the HTTP status code for the failed request and error information regarding the failure.
type BGPCommunity struct {
// ServiceSupportedRegion - The region which the service support. e.g. For O365, region is Global.
ServiceSupportedRegion *string `json:"serviceSupportedRegion,omitempty"`
// CommunityName - The name of the bgp community. e.g. Skype.
CommunityName *string `json:"communityName,omitempty"`
// CommunityValue - The value of the bgp community. For more information: https://docs.microsoft.com/en-us/azure/expressroute/expressroute-routing.
CommunityValue *string `json:"communityValue,omitempty"`
// CommunityPrefixes - The prefixes that the bgp community contains.
CommunityPrefixes *[]string `json:"communityPrefixes,omitempty"`
}BGPCommunity contains bgp community information offered in Service Community resources.
type BackendAddressPool struct {
*BackendAddressPoolPropertiesFormat `json:"properties,omitempty"`
// Name - Gets name of the resource that is unique within a resource group. This name can be used to access the resource.
Name *string `json:"name,omitempty"`
// Etag - A unique read-only string that changes whenever the resource is updated.
Etag *string `json:"etag,omitempty"`
// ID - Resource ID.
ID *string `json:"id,omitempty"`
}BackendAddressPool pool of backend IP addresses.
func (bap BackendAddressPool) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for BackendAddressPool.
func (bap *BackendAddressPool) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for BackendAddressPool struct.
type BackendAddressPoolPropertiesFormat struct {
// BackendIPConfigurations - READ-ONLY; Gets collection of references to IP addresses defined in network interfaces.
BackendIPConfigurations *[]InterfaceIPConfiguration `json:"backendIPConfigurations,omitempty"`
// LoadBalancingRules - READ-ONLY; Gets load balancing rules that use this backend address pool.
LoadBalancingRules *[]SubResource `json:"loadBalancingRules,omitempty"`
// OutboundNatRule - READ-ONLY; Gets outbound rules that use this backend address pool.
OutboundNatRule *SubResource `json:"outboundNatRule,omitempty"`
// ProvisioningState - Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.
ProvisioningState *string `json:"provisioningState,omitempty"`
}BackendAddressPoolPropertiesFormat properties of the backend address pool.
func (bappf BackendAddressPoolPropertiesFormat) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for BackendAddressPoolPropertiesFormat.
BaseClient is the base client for Network.
func New(subscriptionID string) BaseClient
New creates an instance of the BaseClient client.
func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient
NewWithBaseURI creates an instance of the BaseClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client BaseClient) CheckDNSNameAvailability(ctx context.Context, location string, domainNameLabel string) (result DNSNameAvailabilityResult, err error)
CheckDNSNameAvailability checks whether a domain name in the cloudapp.net zone is available for use. Parameters: location - the location of the domain name. domainNameLabel - the domain name to be verified. It must conform to the following regular expression: ^[a-z][a-z0-9-]{1,61}[a-z0-9]$.
func (client BaseClient) CheckDNSNameAvailabilityPreparer(ctx context.Context, location string, domainNameLabel string) (*http.Request, error)
CheckDNSNameAvailabilityPreparer prepares the CheckDNSNameAvailability request.
func (client BaseClient) CheckDNSNameAvailabilityResponder(resp *http.Response) (result DNSNameAvailabilityResult, err error)
CheckDNSNameAvailabilityResponder handles the response to the CheckDNSNameAvailability request. The method always closes the http.Response Body.
CheckDNSNameAvailabilitySender sends the CheckDNSNameAvailability request. The method will close the http.Response Body if it receives an error.
BgpPeerState enumerates the values for bgp peer state.
const (
// BgpPeerStateConnected ...
BgpPeerStateConnected BgpPeerState = "Connected"
// BgpPeerStateConnecting ...
BgpPeerStateConnecting BgpPeerState = "Connecting"
// BgpPeerStateIdle ...
BgpPeerStateIdle BgpPeerState = "Idle"
// BgpPeerStateStopped ...
BgpPeerStateStopped BgpPeerState = "Stopped"
// BgpPeerStateUnknown ...
BgpPeerStateUnknown BgpPeerState = "Unknown"
)func PossibleBgpPeerStateValues() []BgpPeerState
PossibleBgpPeerStateValues returns an array of possible values for the BgpPeerState const type.
type BgpPeerStatus struct {
// LocalAddress - READ-ONLY; The virtual network gateway's local address
LocalAddress *string `json:"localAddress,omitempty"`
// Neighbor - READ-ONLY; The remote BGP peer
Neighbor *string `json:"neighbor,omitempty"`
// Asn - READ-ONLY; The autonomous system number of the remote BGP peer
Asn *int32 `json:"asn,omitempty"`
// State - READ-ONLY; The BGP peer state. Possible values include: 'BgpPeerStateUnknown', 'BgpPeerStateStopped', 'BgpPeerStateIdle', 'BgpPeerStateConnecting', 'BgpPeerStateConnected'
State BgpPeerState `json:"state,omitempty"`
// ConnectedDuration - READ-ONLY; For how long the peering has been up
ConnectedDuration *string `json:"connectedDuration,omitempty"`
// RoutesReceived - READ-ONLY; The number of routes learned from this peer
RoutesReceived *int64 `json:"routesReceived,omitempty"`
// MessagesSent - READ-ONLY; The number of BGP messages sent
MessagesSent *int64 `json:"messagesSent,omitempty"`
// MessagesReceived - READ-ONLY; The number of BGP messages received
MessagesReceived *int64 `json:"messagesReceived,omitempty"`
}BgpPeerStatus BGP peer status details
type BgpPeerStatusListResult struct {
autorest.Response `json:"-"`
// Value - List of BGP peers
Value *[]BgpPeerStatus `json:"value,omitempty"`
}BgpPeerStatusListResult response for list BGP peer status API service call
type BgpServiceCommunitiesClient struct {
BaseClient
}BgpServiceCommunitiesClient is the network Client
func NewBgpServiceCommunitiesClient(subscriptionID string) BgpServiceCommunitiesClient
NewBgpServiceCommunitiesClient creates an instance of the BgpServiceCommunitiesClient client.
func NewBgpServiceCommunitiesClientWithBaseURI(baseURI string, subscriptionID string) BgpServiceCommunitiesClient
NewBgpServiceCommunitiesClientWithBaseURI creates an instance of the BgpServiceCommunitiesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client BgpServiceCommunitiesClient) List(ctx context.Context) (result BgpServiceCommunityListResultPage, err error)
List gets all the available bgp service communities.
func (client BgpServiceCommunitiesClient) ListComplete(ctx context.Context) (result BgpServiceCommunityListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
ListPreparer prepares the List request.
func (client BgpServiceCommunitiesClient) ListResponder(resp *http.Response) (result BgpServiceCommunityListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
type BgpServiceCommunity struct {
*BgpServiceCommunityPropertiesFormat `json:"properties,omitempty"`
// ID - Resource ID.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; Resource name.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; Resource type.
Type *string `json:"type,omitempty"`
// Location - Resource location.
Location *string `json:"location,omitempty"`
// Tags - Resource tags.
Tags map[string]*string `json:"tags"`
}BgpServiceCommunity service Community Properties.
func (bsc BgpServiceCommunity) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for BgpServiceCommunity.
func (bsc *BgpServiceCommunity) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for BgpServiceCommunity struct.
type BgpServiceCommunityListResult struct {
autorest.Response `json:"-"`
// Value - A list of service community resources.
Value *[]BgpServiceCommunity `json:"value,omitempty"`
// NextLink - The URL to get the next set of results.
NextLink *string `json:"nextLink,omitempty"`
}BgpServiceCommunityListResult response for the ListServiceCommunity API service call.
func (bsclr BgpServiceCommunityListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type BgpServiceCommunityListResultIterator struct {
// contains filtered or unexported fields
}BgpServiceCommunityListResultIterator provides access to a complete listing of BgpServiceCommunity values.
func NewBgpServiceCommunityListResultIterator(page BgpServiceCommunityListResultPage) BgpServiceCommunityListResultIterator
Creates a new instance of the BgpServiceCommunityListResultIterator type.
func (iter *BgpServiceCommunityListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *BgpServiceCommunityListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter BgpServiceCommunityListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter BgpServiceCommunityListResultIterator) Response() BgpServiceCommunityListResult
Response returns the raw server response from the last page request.
func (iter BgpServiceCommunityListResultIterator) Value() BgpServiceCommunity
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type BgpServiceCommunityListResultPage struct {
// contains filtered or unexported fields
}BgpServiceCommunityListResultPage contains a page of BgpServiceCommunity values.
func NewBgpServiceCommunityListResultPage(cur BgpServiceCommunityListResult, getNextPage func(context.Context, BgpServiceCommunityListResult) (BgpServiceCommunityListResult, error)) BgpServiceCommunityListResultPage
Creates a new instance of the BgpServiceCommunityListResultPage type.
func (page *BgpServiceCommunityListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *BgpServiceCommunityListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page BgpServiceCommunityListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page BgpServiceCommunityListResultPage) Response() BgpServiceCommunityListResult
Response returns the raw server response from the last page request.
func (page BgpServiceCommunityListResultPage) Values() []BgpServiceCommunity
Values returns the slice of values for the current page or nil if there are no values.
type BgpServiceCommunityPropertiesFormat struct {
// ServiceName - The name of the bgp community. e.g. Skype.
ServiceName *string `json:"serviceName,omitempty"`
// BgpCommunities - Get a list of bgp communities.
BgpCommunities *[]BGPCommunity `json:"bgpCommunities,omitempty"`
}BgpServiceCommunityPropertiesFormat properties of Service Community.
type BgpSettings struct {
// Asn - The BGP speaker's ASN.
Asn *int64 `json:"asn,omitempty"`
// BgpPeeringAddress - The BGP peering address and BGP identifier of this BGP speaker.
BgpPeeringAddress *string `json:"bgpPeeringAddress,omitempty"`
// PeerWeight - The weight added to routes learned from this BGP speaker.
PeerWeight *int32 `json:"peerWeight,omitempty"`
}BgpSettings BGP settings details
type ConnectionResetSharedKey struct {
autorest.Response `json:"-"`
// KeyLength - The virtual network connection reset shared key length, should between 1 and 128.
*int32 `json:"keyLength,omitempty"`
}ConnectionResetSharedKey the virtual network connection reset shared key
type ConnectionSharedKey struct {
autorest.Response `json:"-"`
// Value - The virtual network connection shared key value.
*string `json:"value,omitempty"`
}ConnectionSharedKey response for GetConnectionSharedKey API service call
ConnectionStatus enumerates the values for connection status.
const (
// ConnectionStatusConnected ...
ConnectionStatusConnected ConnectionStatus = "Connected"
// ConnectionStatusDegraded ...
ConnectionStatusDegraded ConnectionStatus = "Degraded"
// ConnectionStatusDisconnected ...
ConnectionStatusDisconnected ConnectionStatus = "Disconnected"
// ConnectionStatusUnknown ...
ConnectionStatusUnknown ConnectionStatus = "Unknown"
)func PossibleConnectionStatusValues() []ConnectionStatus
PossibleConnectionStatusValues returns an array of possible values for the ConnectionStatus const type.
type ConnectivityDestination struct {
// ResourceID - The ID of the resource to which a connection attempt will be made.
ResourceID *string `json:"resourceId,omitempty"`
// Address - The IP address or URI the resource to which a connection attempt will be made.
Address *string `json:"address,omitempty"`
// Port - Port on which check connectivity will be performed.
Port *int32 `json:"port,omitempty"`
}ConnectivityDestination parameters that define destination of connection.
type ConnectivityHop struct {
// Type - READ-ONLY; The type of the hop.
Type *string `json:"type,omitempty"`
// ID - READ-ONLY; The ID of the hop.
ID *string `json:"id,omitempty"`
// Address - READ-ONLY; The IP address of the hop.
Address *string `json:"address,omitempty"`
// ResourceID - READ-ONLY; The ID of the resource corresponding to this hop.
ResourceID *string `json:"resourceId,omitempty"`
// NextHopIds - READ-ONLY; List of next hop identifiers.
NextHopIds *[]string `json:"nextHopIds,omitempty"`
// Issues - READ-ONLY; List of issues.
Issues *[]ConnectivityIssue `json:"issues,omitempty"`
}ConnectivityHop information about a hop between the source and the destination.
type ConnectivityInformation struct {
autorest.Response `json:"-"`
// Hops - READ-ONLY; List of hops between the source and the destination.
Hops *[]ConnectivityHop `json:"hops,omitempty"`
// ConnectionStatus - READ-ONLY; The connection status. Possible values include: 'ConnectionStatusUnknown', 'ConnectionStatusConnected', 'ConnectionStatusDisconnected', 'ConnectionStatusDegraded'
ConnectionStatus ConnectionStatus `json:"connectionStatus,omitempty"`
// AvgLatencyInMs - READ-ONLY; Average latency in milliseconds.
AvgLatencyInMs *int32 `json:"avgLatencyInMs,omitempty"`
// MinLatencyInMs - READ-ONLY; Minimum latency in milliseconds.
MinLatencyInMs *int32 `json:"minLatencyInMs,omitempty"`
// MaxLatencyInMs - READ-ONLY; Maximum latency in milliseconds.
MaxLatencyInMs *int32 `json:"maxLatencyInMs,omitempty"`
// ProbesSent - READ-ONLY; Total number of probes sent.
ProbesSent *int32 `json:"probesSent,omitempty"`
// ProbesFailed - READ-ONLY; Number of failed probes.
ProbesFailed *int32 `json:"probesFailed,omitempty"`
}ConnectivityInformation information on the connectivity status.
type ConnectivityIssue struct {
// Origin - READ-ONLY; The origin of the issue. Possible values include: 'OriginLocal', 'OriginInbound', 'OriginOutbound'
Origin Origin `json:"origin,omitempty"`
// Severity - READ-ONLY; The severity of the issue. Possible values include: 'SeverityError', 'SeverityWarning'
Severity Severity `json:"severity,omitempty"`
// Type - READ-ONLY; The type of issue. Possible values include: 'IssueTypeUnknown', 'IssueTypeAgentStopped', 'IssueTypeGuestFirewall', 'IssueTypeDNSResolution', 'IssueTypeSocketBind', 'IssueTypeNetworkSecurityRule', 'IssueTypeUserDefinedRoute', 'IssueTypePortThrottled', 'IssueTypePlatform'
Type IssueType `json:"type,omitempty"`
// Context - READ-ONLY; Provides additional context on the issue.
Context *[]map[string]*string `json:"context,omitempty"`
}ConnectivityIssue information about an issue encountered in the process of checking for connectivity.
type ConnectivityParameters struct {
Source *ConnectivitySource `json:"source,omitempty"`
Destination *ConnectivityDestination `json:"destination,omitempty"`
}ConnectivityParameters parameters that determine how the connectivity check will be performed.
type ConnectivitySource struct {
// ResourceID - The ID of the resource from which a connectivity check will be initiated.
ResourceID *string `json:"resourceId,omitempty"`
// Port - The source port from which a connectivity check will be performed.
Port *int32 `json:"port,omitempty"`
}ConnectivitySource parameters that define the source of the connection.
type DNSNameAvailabilityResult struct {
autorest.Response `json:"-"`
// Available - Domain availability (True/False).
Available *bool `json:"available,omitempty"`
}DNSNameAvailabilityResult response for the CheckDnsNameAvailability API service call.
DhGroup enumerates the values for dh group.
const (
// DHGroup1 ...
DHGroup1 DhGroup = "DHGroup1"
// DHGroup14 ...
DHGroup14 DhGroup = "DHGroup14"
// DHGroup2 ...
DHGroup2 DhGroup = "DHGroup2"
// DHGroup2048 ...
DHGroup2048 DhGroup = "DHGroup2048"
// DHGroup24 ...
DHGroup24 DhGroup = "DHGroup24"
// ECP256 ...
ECP256 DhGroup = "ECP256"
// ECP384 ...
ECP384 DhGroup = "ECP384"
// None ...
None DhGroup = "None"
)PossibleDhGroupValues returns an array of possible values for the DhGroup const type.
type DhcpOptions struct {
// DNSServers - The list of DNS servers IP addresses.
DNSServers *[]string `json:"dnsServers,omitempty"`
}DhcpOptions dhcpOptions contains an array of DNS servers available to VMs deployed in the virtual network. Standard DHCP option for a subnet overrides VNET DHCP options.
Direction enumerates the values for direction.
const (
// Inbound ...
Inbound Direction = "Inbound"
// Outbound ...
Outbound Direction = "Outbound"
)PossibleDirectionValues returns an array of possible values for the Direction const type.
type EffectiveNetworkSecurityGroup struct {
// NetworkSecurityGroup - The ID of network security group that is applied.
NetworkSecurityGroup *SubResource `json:"networkSecurityGroup,omitempty"`
Association *EffectiveNetworkSecurityGroupAssociation `json:"association,omitempty"`
// EffectiveSecurityRules - A collection of effective security rules.
EffectiveSecurityRules *[]EffectiveNetworkSecurityRule `json:"effectiveSecurityRules,omitempty"`
}EffectiveNetworkSecurityGroup effective network security group.
type EffectiveNetworkSecurityGroupAssociation struct {
// Subnet - The ID of the subnet if assigned.
Subnet *SubResource `json:"subnet,omitempty"`
// NetworkInterface - The ID of the network interface if assigned.
NetworkInterface *SubResource `json:"networkInterface,omitempty"`
}EffectiveNetworkSecurityGroupAssociation the effective network security group association.
type EffectiveNetworkSecurityGroupListResult struct {
autorest.Response `json:"-"`
// Value - A list of effective network security groups.
Value *[]EffectiveNetworkSecurityGroup `json:"value,omitempty"`
// NextLink - The URL to get the next set of results.
NextLink *string `json:"nextLink,omitempty"`
}EffectiveNetworkSecurityGroupListResult response for list effective network security groups API service call.
type EffectiveNetworkSecurityRule struct {
// Name - The name of the security rule specified by the user (if created by the user).
Name *string `json:"name,omitempty"`
// Protocol - The network protocol this rule applies to. Possible values are: 'Tcp', 'Udp', and '*'. Possible values include: 'SecurityRuleProtocolTCP', 'SecurityRuleProtocolUDP', 'SecurityRuleProtocolAsterisk'
Protocol SecurityRuleProtocol `json:"protocol,omitempty"`
// SourcePortRange - The source port or range.
SourcePortRange *string `json:"sourcePortRange,omitempty"`
// DestinationPortRange - The destination port or range.
DestinationPortRange *string `json:"destinationPortRange,omitempty"`
// SourceAddressPrefix - The source address prefix.
SourceAddressPrefix *string `json:"sourceAddressPrefix,omitempty"`
// DestinationAddressPrefix - The destination address prefix.
DestinationAddressPrefix *string `json:"destinationAddressPrefix,omitempty"`
// ExpandedSourceAddressPrefix - The expanded source address prefix.
ExpandedSourceAddressPrefix *[]string `json:"expandedSourceAddressPrefix,omitempty"`
// ExpandedDestinationAddressPrefix - Expanded destination address prefix.
ExpandedDestinationAddressPrefix *[]string `json:"expandedDestinationAddressPrefix,omitempty"`
// Access - Whether network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. Possible values include: 'SecurityRuleAccessAllow', 'SecurityRuleAccessDeny'
Access SecurityRuleAccess `json:"access,omitempty"`
// Priority - The priority of the rule.
Priority *int32 `json:"priority,omitempty"`
// Direction - The direction of the rule. Possible values are: 'Inbound and Outbound'. Possible values include: 'SecurityRuleDirectionInbound', 'SecurityRuleDirectionOutbound'
Direction SecurityRuleDirection `json:"direction,omitempty"`
}EffectiveNetworkSecurityRule effective network security rules.
type EffectiveRoute struct {
// Name - The name of the user defined route. This is optional.
Name *string `json:"name,omitempty"`
// Source - Who created the route. Possible values are: 'Unknown', 'User', 'VirtualNetworkGateway', and 'Default'. Possible values include: 'EffectiveRouteSourceUnknown', 'EffectiveRouteSourceUser', 'EffectiveRouteSourceVirtualNetworkGateway', 'EffectiveRouteSourceDefault'
Source EffectiveRouteSource `json:"source,omitempty"`
// State - The value of effective route. Possible values are: 'Active' and 'Invalid'. Possible values include: 'Active', 'Invalid'
State EffectiveRouteState `json:"state,omitempty"`
// AddressPrefix - The address prefixes of the effective routes in CIDR notation.
AddressPrefix *[]string `json:"addressPrefix,omitempty"`
// NextHopIPAddress - The IP address of the next hop of the effective route.
NextHopIPAddress *[]string `json:"nextHopIpAddress,omitempty"`
// NextHopType - The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. Possible values include: 'RouteNextHopTypeVirtualNetworkGateway', 'RouteNextHopTypeVnetLocal', 'RouteNextHopTypeInternet', 'RouteNextHopTypeVirtualAppliance', 'RouteNextHopTypeNone'
NextHopType RouteNextHopType `json:"nextHopType,omitempty"`
}EffectiveRoute effective Route
type EffectiveRouteListResult struct {
autorest.Response `json:"-"`
// Value - A list of effective routes.
Value *[]EffectiveRoute `json:"value,omitempty"`
// NextLink - The URL to get the next set of results.
NextLink *string `json:"nextLink,omitempty"`
}EffectiveRouteListResult response for list effective route API service call.
EffectiveRouteSource enumerates the values for effective route source.
const (
// EffectiveRouteSourceDefault ...
EffectiveRouteSourceDefault EffectiveRouteSource = "Default"
// EffectiveRouteSourceUnknown ...
EffectiveRouteSourceUnknown EffectiveRouteSource = "Unknown"
// EffectiveRouteSourceUser ...
EffectiveRouteSourceUser EffectiveRouteSource = "User"
// EffectiveRouteSourceVirtualNetworkGateway ...
EffectiveRouteSourceVirtualNetworkGateway EffectiveRouteSource = "VirtualNetworkGateway"
)func PossibleEffectiveRouteSourceValues() []EffectiveRouteSource
PossibleEffectiveRouteSourceValues returns an array of possible values for the EffectiveRouteSource const type.
EffectiveRouteState enumerates the values for effective route state.
const (
// Active ...
Active EffectiveRouteState = "Active"
// Invalid ...
Invalid EffectiveRouteState = "Invalid"
)func PossibleEffectiveRouteStateValues() []EffectiveRouteState
PossibleEffectiveRouteStateValues returns an array of possible values for the EffectiveRouteState const type.
type Error struct {
Code *string `json:"code,omitempty"`
Message *string `json:"message,omitempty"`
Target *string `json:"target,omitempty"`
Details *[]ErrorDetails `json:"details,omitempty"`
InnerError *string `json:"innerError,omitempty"`
}Error ...
type ErrorDetails struct {
Code *string `json:"code,omitempty"`
Target *string `json:"target,omitempty"`
Message *string `json:"message,omitempty"`
}ErrorDetails ...
type ExpressRouteCircuit struct {
autorest.Response `json:"-"`
// Sku - The SKU.
Sku *ExpressRouteCircuitSku `json:"sku,omitempty"`
*ExpressRouteCircuitPropertiesFormat `json:"properties,omitempty"`
// Etag - READ-ONLY; Gets a unique read-only string that changes whenever the resource is updated.
Etag *string `json:"etag,omitempty"`
// ID - Resource ID.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; Resource name.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; Resource type.
Type *string `json:"type,omitempty"`
// Location - Resource location.
Location *string `json:"location,omitempty"`
// Tags - Resource tags.
Tags map[string]*string `json:"tags"`
}ExpressRouteCircuit expressRouteCircuit resource
func (erc ExpressRouteCircuit) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ExpressRouteCircuit.
func (erc *ExpressRouteCircuit) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ExpressRouteCircuit struct.
type ExpressRouteCircuitArpTable struct {
// Age - Age
Age *int32 `json:"age,omitempty"`
// Interface - Interface
Interface *string `json:"interface,omitempty"`
// IPAddress - The IP address.
IPAddress *string `json:"ipAddress,omitempty"`
// MacAddress - The MAC address.
MacAddress *string `json:"macAddress,omitempty"`
}ExpressRouteCircuitArpTable the ARP table associated with the ExpressRouteCircuit.
type ExpressRouteCircuitAuthorization struct {
autorest.Response `json:"-"`
*AuthorizationPropertiesFormat `json:"properties,omitempty"`
// Name - Gets name of the resource that is unique within a resource group. This name can be used to access the resource.
Name *string `json:"name,omitempty"`
// Etag - READ-ONLY; A unique read-only string that changes whenever the resource is updated.
Etag *string `json:"etag,omitempty"`
// ID - Resource ID.
ID *string `json:"id,omitempty"`
}ExpressRouteCircuitAuthorization authorization in an ExpressRouteCircuit resource.
func (erca ExpressRouteCircuitAuthorization) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ExpressRouteCircuitAuthorization.
func (erca *ExpressRouteCircuitAuthorization) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ExpressRouteCircuitAuthorization struct.
type ExpressRouteCircuitAuthorizationsClient struct {
BaseClient
}ExpressRouteCircuitAuthorizationsClient is the network Client
func NewExpressRouteCircuitAuthorizationsClient(subscriptionID string) ExpressRouteCircuitAuthorizationsClient
NewExpressRouteCircuitAuthorizationsClient creates an instance of the ExpressRouteCircuitAuthorizationsClient client.
func NewExpressRouteCircuitAuthorizationsClientWithBaseURI(baseURI string, subscriptionID string) ExpressRouteCircuitAuthorizationsClient
NewExpressRouteCircuitAuthorizationsClientWithBaseURI creates an instance of the ExpressRouteCircuitAuthorizationsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client ExpressRouteCircuitAuthorizationsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, circuitName string, authorizationName string, authorizationParameters ExpressRouteCircuitAuthorization) (result ExpressRouteCircuitAuthorizationsCreateOrUpdateFuture, err error)
CreateOrUpdate creates or updates an authorization in the specified express route circuit. Parameters: resourceGroupName - the name of the resource group. circuitName - the name of the express route circuit. authorizationName - the name of the authorization. authorizationParameters - parameters supplied to the create or update express route circuit authorization operation.
func (client ExpressRouteCircuitAuthorizationsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, circuitName string, authorizationName string, authorizationParameters ExpressRouteCircuitAuthorization) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client ExpressRouteCircuitAuthorizationsClient) CreateOrUpdateResponder(resp *http.Response) (result ExpressRouteCircuitAuthorization, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client ExpressRouteCircuitAuthorizationsClient) CreateOrUpdateSender(req *http.Request) (future ExpressRouteCircuitAuthorizationsCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client ExpressRouteCircuitAuthorizationsClient) Delete(ctx context.Context, resourceGroupName string, circuitName string, authorizationName string) (result ExpressRouteCircuitAuthorizationsDeleteFuture, err error)
Delete deletes the specified authorization from the specified express route circuit. Parameters: resourceGroupName - the name of the resource group. circuitName - the name of the express route circuit. authorizationName - the name of the authorization.
func (client ExpressRouteCircuitAuthorizationsClient) DeletePreparer(ctx context.Context, resourceGroupName string, circuitName string, authorizationName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client ExpressRouteCircuitAuthorizationsClient) 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 (client ExpressRouteCircuitAuthorizationsClient) DeleteSender(req *http.Request) (future ExpressRouteCircuitAuthorizationsDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client ExpressRouteCircuitAuthorizationsClient) Get(ctx context.Context, resourceGroupName string, circuitName string, authorizationName string) (result ExpressRouteCircuitAuthorization, err error)
Get gets the specified authorization from the specified express route circuit. Parameters: resourceGroupName - the name of the resource group. circuitName - the name of the express route circuit. authorizationName - the name of the authorization.
func (client ExpressRouteCircuitAuthorizationsClient) GetPreparer(ctx context.Context, resourceGroupName string, circuitName string, authorizationName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client ExpressRouteCircuitAuthorizationsClient) GetResponder(resp *http.Response) (result ExpressRouteCircuitAuthorization, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client ExpressRouteCircuitAuthorizationsClient) 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 (client ExpressRouteCircuitAuthorizationsClient) List(ctx context.Context, resourceGroupName string, circuitName string) (result AuthorizationListResultPage, err error)
List gets all authorizations in an express route circuit. Parameters: resourceGroupName - the name of the resource group. circuitName - the name of the circuit.
func (client ExpressRouteCircuitAuthorizationsClient) ListComplete(ctx context.Context, resourceGroupName string, circuitName string) (result AuthorizationListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client ExpressRouteCircuitAuthorizationsClient) ListPreparer(ctx context.Context, resourceGroupName string, circuitName string) (*http.Request, error)
ListPreparer prepares the List request.
func (client ExpressRouteCircuitAuthorizationsClient) ListResponder(resp *http.Response) (result AuthorizationListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client ExpressRouteCircuitAuthorizationsClient) 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.
type ExpressRouteCircuitAuthorizationsCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(ExpressRouteCircuitAuthorizationsClient) (ExpressRouteCircuitAuthorization, error)
}ExpressRouteCircuitAuthorizationsCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type ExpressRouteCircuitAuthorizationsDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(ExpressRouteCircuitAuthorizationsClient) (autorest.Response, error)
}ExpressRouteCircuitAuthorizationsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type ExpressRouteCircuitListResult struct {
autorest.Response `json:"-"`
// Value - A list of ExpressRouteCircuits in a resource group.
Value *[]ExpressRouteCircuit `json:"value,omitempty"`
// NextLink - The URL to get the next set of results.
NextLink *string `json:"nextLink,omitempty"`
}ExpressRouteCircuitListResult response for ListExpressRouteCircuit API service call.
func (erclr ExpressRouteCircuitListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type ExpressRouteCircuitListResultIterator struct {
// contains filtered or unexported fields
}ExpressRouteCircuitListResultIterator provides access to a complete listing of ExpressRouteCircuit values.
func NewExpressRouteCircuitListResultIterator(page ExpressRouteCircuitListResultPage) ExpressRouteCircuitListResultIterator
Creates a new instance of the ExpressRouteCircuitListResultIterator type.
func (iter *ExpressRouteCircuitListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *ExpressRouteCircuitListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter ExpressRouteCircuitListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter ExpressRouteCircuitListResultIterator) Response() ExpressRouteCircuitListResult
Response returns the raw server response from the last page request.
func (iter ExpressRouteCircuitListResultIterator) Value() ExpressRouteCircuit
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type ExpressRouteCircuitListResultPage struct {
// contains filtered or unexported fields
}ExpressRouteCircuitListResultPage contains a page of ExpressRouteCircuit values.
func NewExpressRouteCircuitListResultPage(cur ExpressRouteCircuitListResult, getNextPage func(context.Context, ExpressRouteCircuitListResult) (ExpressRouteCircuitListResult, error)) ExpressRouteCircuitListResultPage
Creates a new instance of the ExpressRouteCircuitListResultPage type.
func (page *ExpressRouteCircuitListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *ExpressRouteCircuitListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page ExpressRouteCircuitListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page ExpressRouteCircuitListResultPage) Response() ExpressRouteCircuitListResult
Response returns the raw server response from the last page request.
func (page ExpressRouteCircuitListResultPage) Values() []ExpressRouteCircuit
Values returns the slice of values for the current page or nil if there are no values.
type ExpressRouteCircuitPeering struct {
autorest.Response `json:"-"`
*ExpressRouteCircuitPeeringPropertiesFormat `json:"properties,omitempty"`
// Name - Gets name of the resource that is unique within a resource group. This name can be used to access the resource.
Name *string `json:"name,omitempty"`
// Etag - READ-ONLY; A unique read-only string that changes whenever the resource is updated.
Etag *string `json:"etag,omitempty"`
// ID - Resource ID.
ID *string `json:"id,omitempty"`
}ExpressRouteCircuitPeering peering in an ExpressRouteCircuit resource.
func (ercp ExpressRouteCircuitPeering) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ExpressRouteCircuitPeering.
func (ercp *ExpressRouteCircuitPeering) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ExpressRouteCircuitPeering struct.
ExpressRouteCircuitPeeringAdvertisedPublicPrefixState enumerates the values for express route circuit peering advertised public prefix state.
const (
// Configured ...
Configured ExpressRouteCircuitPeeringAdvertisedPublicPrefixState = "Configured"
// Configuring ...
Configuring ExpressRouteCircuitPeeringAdvertisedPublicPrefixState = "Configuring"
// NotConfigured ...
NotConfigured ExpressRouteCircuitPeeringAdvertisedPublicPrefixState = "NotConfigured"
// ValidationNeeded ...
ValidationNeeded ExpressRouteCircuitPeeringAdvertisedPublicPrefixState = "ValidationNeeded"
)func PossibleExpressRouteCircuitPeeringAdvertisedPublicPrefixStateValues() []ExpressRouteCircuitPeeringAdvertisedPublicPrefixState
PossibleExpressRouteCircuitPeeringAdvertisedPublicPrefixStateValues returns an array of possible values for the ExpressRouteCircuitPeeringAdvertisedPublicPrefixState const type.
type ExpressRouteCircuitPeeringConfig struct {
// AdvertisedPublicPrefixes - The reference of AdvertisedPublicPrefixes.
AdvertisedPublicPrefixes *[]string `json:"advertisedPublicPrefixes,omitempty"`
// AdvertisedPublicPrefixesState - AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. Possible values include: 'NotConfigured', 'Configuring', 'Configured', 'ValidationNeeded'
AdvertisedPublicPrefixesState ExpressRouteCircuitPeeringAdvertisedPublicPrefixState `json:"advertisedPublicPrefixesState,omitempty"`
// CustomerASN - The CustomerASN of the peering.
CustomerASN *int32 `json:"customerASN,omitempty"`
// RoutingRegistryName - The RoutingRegistryName of the configuration.
RoutingRegistryName *string `json:"routingRegistryName,omitempty"`
}ExpressRouteCircuitPeeringConfig specifies the peering configuration.
type ExpressRouteCircuitPeeringListResult struct {
autorest.Response `json:"-"`
// Value - The peerings in an express route circuit.
Value *[]ExpressRouteCircuitPeering `json:"value,omitempty"`
// NextLink - The URL to get the next set of results.
NextLink *string `json:"nextLink,omitempty"`
}ExpressRouteCircuitPeeringListResult response for ListPeering API service call retrieves all peerings that belong to an ExpressRouteCircuit.
func (ercplr ExpressRouteCircuitPeeringListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type ExpressRouteCircuitPeeringListResultIterator struct {
// contains filtered or unexported fields
}ExpressRouteCircuitPeeringListResultIterator provides access to a complete listing of ExpressRouteCircuitPeering values.
func NewExpressRouteCircuitPeeringListResultIterator(page ExpressRouteCircuitPeeringListResultPage) ExpressRouteCircuitPeeringListResultIterator
Creates a new instance of the ExpressRouteCircuitPeeringListResultIterator type.
func (iter *ExpressRouteCircuitPeeringListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *ExpressRouteCircuitPeeringListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter ExpressRouteCircuitPeeringListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter ExpressRouteCircuitPeeringListResultIterator) Response() ExpressRouteCircuitPeeringListResult
Response returns the raw server response from the last page request.
func (iter ExpressRouteCircuitPeeringListResultIterator) Value() ExpressRouteCircuitPeering
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type ExpressRouteCircuitPeeringListResultPage struct {
// contains filtered or unexported fields
}ExpressRouteCircuitPeeringListResultPage contains a page of ExpressRouteCircuitPeering values.
func NewExpressRouteCircuitPeeringListResultPage(cur ExpressRouteCircuitPeeringListResult, getNextPage func(context.Context, ExpressRouteCircuitPeeringListResult) (ExpressRouteCircuitPeeringListResult, error)) ExpressRouteCircuitPeeringListResultPage
Creates a new instance of the ExpressRouteCircuitPeeringListResultPage type.
func (page *ExpressRouteCircuitPeeringListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *ExpressRouteCircuitPeeringListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page ExpressRouteCircuitPeeringListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page ExpressRouteCircuitPeeringListResultPage) Response() ExpressRouteCircuitPeeringListResult
Response returns the raw server response from the last page request.
func (page ExpressRouteCircuitPeeringListResultPage) Values() []ExpressRouteCircuitPeering
Values returns the slice of values for the current page or nil if there are no values.
type ExpressRouteCircuitPeeringPropertiesFormat struct {
// PeeringType - The PeeringType. Possible values are: 'AzurePublicPeering', 'AzurePrivatePeering', and 'MicrosoftPeering'. Possible values include: 'AzurePublicPeering', 'AzurePrivatePeering', 'MicrosoftPeering'
PeeringType ExpressRouteCircuitPeeringType `json:"peeringType,omitempty"`
// State - The state of peering. Possible values are: 'Disabled' and 'Enabled'. Possible values include: 'ExpressRouteCircuitPeeringStateDisabled', 'ExpressRouteCircuitPeeringStateEnabled'
State ExpressRouteCircuitPeeringState `json:"state,omitempty"`
// AzureASN - The Azure ASN.
AzureASN *int32 `json:"azureASN,omitempty"`
// PeerASN - The peer ASN.
PeerASN *int32 `json:"peerASN,omitempty"`
// PrimaryPeerAddressPrefix - The primary address prefix.
PrimaryPeerAddressPrefix *string `json:"primaryPeerAddressPrefix,omitempty"`
// SecondaryPeerAddressPrefix - The secondary address prefix.
SecondaryPeerAddressPrefix *string `json:"secondaryPeerAddressPrefix,omitempty"`
// PrimaryAzurePort - The primary port.
PrimaryAzurePort *string `json:"primaryAzurePort,omitempty"`
// SecondaryAzurePort - The secondary port.
SecondaryAzurePort *string `json:"secondaryAzurePort,omitempty"`
// SharedKey - The shared key.
*string `json:"sharedKey,omitempty"`
// VlanID - The VLAN ID.
VlanID *int32 `json:"vlanId,omitempty"`
// MicrosoftPeeringConfig - The Microsoft peering configuration.
MicrosoftPeeringConfig *ExpressRouteCircuitPeeringConfig `json:"microsoftPeeringConfig,omitempty"`
// Stats - Gets peering stats.
Stats *ExpressRouteCircuitStats `json:"stats,omitempty"`
// ProvisioningState - Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.
ProvisioningState *string `json:"provisioningState,omitempty"`
// GatewayManagerEtag - The GatewayManager Etag.
GatewayManagerEtag *string `json:"gatewayManagerEtag,omitempty"`
// LastModifiedBy - Gets whether the provider or the customer last modified the peering.
LastModifiedBy *string `json:"lastModifiedBy,omitempty"`
// RouteFilter - The reference of the RouteFilter resource.
RouteFilter *RouteFilter `json:"routeFilter,omitempty"`
// Ipv6PeeringConfig - The IPv6 peering configuration.
Ipv6PeeringConfig *Ipv6ExpressRouteCircuitPeeringConfig `json:"ipv6PeeringConfig,omitempty"`
}ExpressRouteCircuitPeeringPropertiesFormat ...
ExpressRouteCircuitPeeringState enumerates the values for express route circuit peering state.
const (
// ExpressRouteCircuitPeeringStateDisabled ...
ExpressRouteCircuitPeeringStateDisabled ExpressRouteCircuitPeeringState = "Disabled"
// ExpressRouteCircuitPeeringStateEnabled ...
ExpressRouteCircuitPeeringStateEnabled ExpressRouteCircuitPeeringState = "Enabled"
)func PossibleExpressRouteCircuitPeeringStateValues() []ExpressRouteCircuitPeeringState
PossibleExpressRouteCircuitPeeringStateValues returns an array of possible values for the ExpressRouteCircuitPeeringState const type.
ExpressRouteCircuitPeeringType enumerates the values for express route circuit peering type.
const (
// AzurePrivatePeering ...
AzurePrivatePeering ExpressRouteCircuitPeeringType = "AzurePrivatePeering"
// AzurePublicPeering ...
AzurePublicPeering ExpressRouteCircuitPeeringType = "AzurePublicPeering"
// MicrosoftPeering ...
MicrosoftPeering ExpressRouteCircuitPeeringType = "MicrosoftPeering"
)func PossibleExpressRouteCircuitPeeringTypeValues() []ExpressRouteCircuitPeeringType
PossibleExpressRouteCircuitPeeringTypeValues returns an array of possible values for the ExpressRouteCircuitPeeringType const type.
type ExpressRouteCircuitPeeringsClient struct {
BaseClient
}ExpressRouteCircuitPeeringsClient is the network Client
func NewExpressRouteCircuitPeeringsClient(subscriptionID string) ExpressRouteCircuitPeeringsClient
NewExpressRouteCircuitPeeringsClient creates an instance of the ExpressRouteCircuitPeeringsClient client.
func NewExpressRouteCircuitPeeringsClientWithBaseURI(baseURI string, subscriptionID string) ExpressRouteCircuitPeeringsClient
NewExpressRouteCircuitPeeringsClientWithBaseURI creates an instance of the ExpressRouteCircuitPeeringsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client ExpressRouteCircuitPeeringsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, circuitName string, peeringName string, peeringParameters ExpressRouteCircuitPeering) (result ExpressRouteCircuitPeeringsCreateOrUpdateFuture, err error)
CreateOrUpdate creates or updates a peering in the specified express route circuits. Parameters: resourceGroupName - the name of the resource group. circuitName - the name of the express route circuit. peeringName - the name of the peering. peeringParameters - parameters supplied to the create or update express route circuit peering operation.
func (client ExpressRouteCircuitPeeringsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, circuitName string, peeringName string, peeringParameters ExpressRouteCircuitPeering) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client ExpressRouteCircuitPeeringsClient) CreateOrUpdateResponder(resp *http.Response) (result ExpressRouteCircuitPeering, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client ExpressRouteCircuitPeeringsClient) CreateOrUpdateSender(req *http.Request) (future ExpressRouteCircuitPeeringsCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client ExpressRouteCircuitPeeringsClient) Delete(ctx context.Context, resourceGroupName string, circuitName string, peeringName string) (result ExpressRouteCircuitPeeringsDeleteFuture, err error)
Delete deletes the specified peering from the specified express route circuit. Parameters: resourceGroupName - the name of the resource group. circuitName - the name of the express route circuit. peeringName - the name of the peering.
func (client ExpressRouteCircuitPeeringsClient) DeletePreparer(ctx context.Context, resourceGroupName string, circuitName string, peeringName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client ExpressRouteCircuitPeeringsClient) 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 (client ExpressRouteCircuitPeeringsClient) DeleteSender(req *http.Request) (future ExpressRouteCircuitPeeringsDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client ExpressRouteCircuitPeeringsClient) Get(ctx context.Context, resourceGroupName string, circuitName string, peeringName string) (result ExpressRouteCircuitPeering, err error)
Get gets the specified authorization from the specified express route circuit. Parameters: resourceGroupName - the name of the resource group. circuitName - the name of the express route circuit. peeringName - the name of the peering.
func (client ExpressRouteCircuitPeeringsClient) GetPreparer(ctx context.Context, resourceGroupName string, circuitName string, peeringName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client ExpressRouteCircuitPeeringsClient) GetResponder(resp *http.Response) (result ExpressRouteCircuitPeering, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client ExpressRouteCircuitPeeringsClient) 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 (client ExpressRouteCircuitPeeringsClient) List(ctx context.Context, resourceGroupName string, circuitName string) (result ExpressRouteCircuitPeeringListResultPage, err error)
List gets all peerings in a specified express route circuit. Parameters: resourceGroupName - the name of the resource group. circuitName - the name of the express route circuit.
func (client ExpressRouteCircuitPeeringsClient) ListComplete(ctx context.Context, resourceGroupName string, circuitName string) (result ExpressRouteCircuitPeeringListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client ExpressRouteCircuitPeeringsClient) ListPreparer(ctx context.Context, resourceGroupName string, circuitName string) (*http.Request, error)
ListPreparer prepares the List request.
func (client ExpressRouteCircuitPeeringsClient) ListResponder(resp *http.Response) (result ExpressRouteCircuitPeeringListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client ExpressRouteCircuitPeeringsClient) 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.
type ExpressRouteCircuitPeeringsCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(ExpressRouteCircuitPeeringsClient) (ExpressRouteCircuitPeering, error)
}ExpressRouteCircuitPeeringsCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type ExpressRouteCircuitPeeringsDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(ExpressRouteCircuitPeeringsClient) (autorest.Response, error)
}ExpressRouteCircuitPeeringsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type ExpressRouteCircuitPropertiesFormat struct {
// AllowClassicOperations - Allow classic operations
AllowClassicOperations *bool `json:"allowClassicOperations,omitempty"`
// CircuitProvisioningState - The CircuitProvisioningState state of the resource.
CircuitProvisioningState *string `json:"circuitProvisioningState,omitempty"`
// ServiceProviderProvisioningState - The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'. Possible values include: 'NotProvisioned', 'Provisioning', 'Provisioned', 'Deprovisioning'
ServiceProviderProvisioningState ServiceProviderProvisioningState `json:"serviceProviderProvisioningState,omitempty"`
// Authorizations - The list of authorizations.
Authorizations *[]ExpressRouteCircuitAuthorization `json:"authorizations,omitempty"`
// Peerings - The list of peerings.
Peerings *[]ExpressRouteCircuitPeering `json:"peerings,omitempty"`
// ServiceKey - The ServiceKey.
ServiceKey *string `json:"serviceKey,omitempty"`
// ServiceProviderNotes - The ServiceProviderNotes.
ServiceProviderNotes *string `json:"serviceProviderNotes,omitempty"`
// ServiceProviderProperties - The ServiceProviderProperties.
ServiceProviderProperties *ExpressRouteCircuitServiceProviderProperties `json:"serviceProviderProperties,omitempty"`
// ProvisioningState - Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.
ProvisioningState *string `json:"provisioningState,omitempty"`
// GatewayManagerEtag - The GatewayManager Etag.
GatewayManagerEtag *string `json:"gatewayManagerEtag,omitempty"`
}ExpressRouteCircuitPropertiesFormat properties of ExpressRouteCircuit.
type ExpressRouteCircuitRoutesTable struct {
// NetworkProperty - network
NetworkProperty *string `json:"network,omitempty"`
// NextHop - nextHop
NextHop *string `json:"nextHop,omitempty"`
// LocPrf - locPrf
LocPrf *string `json:"locPrf,omitempty"`
// Weight - weight.
Weight *int32 `json:"weight,omitempty"`
// Path - path
Path *string `json:"path,omitempty"`
}ExpressRouteCircuitRoutesTable the routes table associated with the ExpressRouteCircuit
type ExpressRouteCircuitRoutesTableSummary struct {
// Neighbor - Neighbor
Neighbor *string `json:"neighbor,omitempty"`
// V - BGP version number spoken to the neighbor.
V *int32 `json:"v,omitempty"`
// As - Autonomous system number.
As *int32 `json:"as,omitempty"`
// UpDown - The length of time that the BGP session has been in the Established state, or the current status if not in the Established state.
UpDown *string `json:"upDown,omitempty"`
// StatePfxRcd - Current state of the BGP session, and the number of prefixes that have been received from a neighbor or peer group.
StatePfxRcd *string `json:"statePfxRcd,omitempty"`
}ExpressRouteCircuitRoutesTableSummary the routes table associated with the ExpressRouteCircuit.
type ExpressRouteCircuitServiceProviderProperties struct {
// ServiceProviderName - The serviceProviderName.
ServiceProviderName *string `json:"serviceProviderName,omitempty"`
// PeeringLocation - The peering location.
PeeringLocation *string `json:"peeringLocation,omitempty"`
// BandwidthInMbps - The BandwidthInMbps.
BandwidthInMbps *int32 `json:"bandwidthInMbps,omitempty"`
}ExpressRouteCircuitServiceProviderProperties contains ServiceProviderProperties in an ExpressRouteCircuit.
type ExpressRouteCircuitSku struct {
// Name - The name of the SKU.
Name *string `json:"name,omitempty"`
// Tier - The tier of the SKU. Possible values are 'Standard' and 'Premium'. Possible values include: 'ExpressRouteCircuitSkuTierStandard', 'ExpressRouteCircuitSkuTierPremium'
Tier ExpressRouteCircuitSkuTier `json:"tier,omitempty"`
// Family - The family of the SKU. Possible values are: 'UnlimitedData' and 'MeteredData'. Possible values include: 'UnlimitedData', 'MeteredData'
Family ExpressRouteCircuitSkuFamily `json:"family,omitempty"`
}ExpressRouteCircuitSku contains SKU in an ExpressRouteCircuit.
ExpressRouteCircuitSkuFamily enumerates the values for express route circuit sku family.
const (
// MeteredData ...
MeteredData ExpressRouteCircuitSkuFamily = "MeteredData"
// UnlimitedData ...
UnlimitedData ExpressRouteCircuitSkuFamily = "UnlimitedData"
)func PossibleExpressRouteCircuitSkuFamilyValues() []ExpressRouteCircuitSkuFamily
PossibleExpressRouteCircuitSkuFamilyValues returns an array of possible values for the ExpressRouteCircuitSkuFamily const type.
ExpressRouteCircuitSkuTier enumerates the values for express route circuit sku tier.
const (
// ExpressRouteCircuitSkuTierPremium ...
ExpressRouteCircuitSkuTierPremium ExpressRouteCircuitSkuTier = "Premium"
// ExpressRouteCircuitSkuTierStandard ...
ExpressRouteCircuitSkuTierStandard ExpressRouteCircuitSkuTier = "Standard"
)func PossibleExpressRouteCircuitSkuTierValues() []ExpressRouteCircuitSkuTier
PossibleExpressRouteCircuitSkuTierValues returns an array of possible values for the ExpressRouteCircuitSkuTier const type.
type ExpressRouteCircuitStats struct {
autorest.Response `json:"-"`
// PrimarybytesIn - Gets BytesIn of the peering.
PrimarybytesIn *int64 `json:"primarybytesIn,omitempty"`
// PrimarybytesOut - Gets BytesOut of the peering.
PrimarybytesOut *int64 `json:"primarybytesOut,omitempty"`
// SecondarybytesIn - Gets BytesIn of the peering.
SecondarybytesIn *int64 `json:"secondarybytesIn,omitempty"`
// SecondarybytesOut - Gets BytesOut of the peering.
SecondarybytesOut *int64 `json:"secondarybytesOut,omitempty"`
}ExpressRouteCircuitStats contains stats associated with the peering.
type ExpressRouteCircuitsArpTableListResult struct {
autorest.Response `json:"-"`
// Value - Gets list of the ARP table.
Value *[]ExpressRouteCircuitArpTable `json:"value,omitempty"`
// NextLink - The URL to get the next set of results.
NextLink *string `json:"nextLink,omitempty"`
}ExpressRouteCircuitsArpTableListResult response for ListArpTable associated with the Express Route Circuits API.
type ExpressRouteCircuitsClient struct {
BaseClient
}ExpressRouteCircuitsClient is the network Client
func NewExpressRouteCircuitsClient(subscriptionID string) ExpressRouteCircuitsClient
NewExpressRouteCircuitsClient creates an instance of the ExpressRouteCircuitsClient client.
func NewExpressRouteCircuitsClientWithBaseURI(baseURI string, subscriptionID string) ExpressRouteCircuitsClient
NewExpressRouteCircuitsClientWithBaseURI creates an instance of the ExpressRouteCircuitsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client ExpressRouteCircuitsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, circuitName string, parameters ExpressRouteCircuit) (result ExpressRouteCircuitsCreateOrUpdateFuture, err error)
CreateOrUpdate creates or updates an express route circuit. Parameters: resourceGroupName - the name of the resource group. circuitName - the name of the circuit. parameters - parameters supplied to the create or update express route circuit operation.
func (client ExpressRouteCircuitsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, circuitName string, parameters ExpressRouteCircuit) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client ExpressRouteCircuitsClient) CreateOrUpdateResponder(resp *http.Response) (result ExpressRouteCircuit, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client ExpressRouteCircuitsClient) CreateOrUpdateSender(req *http.Request) (future ExpressRouteCircuitsCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client ExpressRouteCircuitsClient) Delete(ctx context.Context, resourceGroupName string, circuitName string) (result ExpressRouteCircuitsDeleteFuture, err error)
Delete deletes the specified express route circuit. Parameters: resourceGroupName - the name of the resource group. circuitName - the name of the express route circuit.
func (client ExpressRouteCircuitsClient) DeletePreparer(ctx context.Context, resourceGroupName string, circuitName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client ExpressRouteCircuitsClient) 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 (client ExpressRouteCircuitsClient) DeleteSender(req *http.Request) (future ExpressRouteCircuitsDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client ExpressRouteCircuitsClient) Get(ctx context.Context, resourceGroupName string, circuitName string) (result ExpressRouteCircuit, err error)
Get gets information about the specified express route circuit. Parameters: resourceGroupName - the name of the resource group. circuitName - the name of express route circuit.
func (client ExpressRouteCircuitsClient) GetPeeringStats(ctx context.Context, resourceGroupName string, circuitName string, peeringName string) (result ExpressRouteCircuitStats, err error)
GetPeeringStats gets all stats from an express route circuit in a resource group. Parameters: resourceGroupName - the name of the resource group. circuitName - the name of the express route circuit. peeringName - the name of the peering.
func (client ExpressRouteCircuitsClient) GetPeeringStatsPreparer(ctx context.Context, resourceGroupName string, circuitName string, peeringName string) (*http.Request, error)
GetPeeringStatsPreparer prepares the GetPeeringStats request.
func (client ExpressRouteCircuitsClient) GetPeeringStatsResponder(resp *http.Response) (result ExpressRouteCircuitStats, err error)
GetPeeringStatsResponder handles the response to the GetPeeringStats request. The method always closes the http.Response Body.
func (client ExpressRouteCircuitsClient) GetPeeringStatsSender(req *http.Request) (*http.Response, error)
GetPeeringStatsSender sends the GetPeeringStats request. The method will close the http.Response Body if it receives an error.
func (client ExpressRouteCircuitsClient) GetPreparer(ctx context.Context, resourceGroupName string, circuitName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client ExpressRouteCircuitsClient) GetResponder(resp *http.Response) (result ExpressRouteCircuit, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client ExpressRouteCircuitsClient) GetStats(ctx context.Context, resourceGroupName string, circuitName string) (result ExpressRouteCircuitStats, err error)
GetStats gets all the stats from an express route circuit in a resource group. Parameters: resourceGroupName - the name of the resource group. circuitName - the name of the express route circuit.
func (client ExpressRouteCircuitsClient) GetStatsPreparer(ctx context.Context, resourceGroupName string, circuitName string) (*http.Request, error)
GetStatsPreparer prepares the GetStats request.
func (client ExpressRouteCircuitsClient) GetStatsResponder(resp *http.Response) (result ExpressRouteCircuitStats, err error)
GetStatsResponder handles the response to the GetStats request. The method always closes the http.Response Body.
GetStatsSender sends the GetStats request. The method will close the http.Response Body if it receives an error.
func (client ExpressRouteCircuitsClient) List(ctx context.Context, resourceGroupName string) (result ExpressRouteCircuitListResultPage, err error)
List gets all the express route circuits in a resource group. Parameters: resourceGroupName - the name of the resource group.
func (client ExpressRouteCircuitsClient) ListAll(ctx context.Context) (result ExpressRouteCircuitListResultPage, err error)
ListAll gets all the express route circuits in a subscription.
func (client ExpressRouteCircuitsClient) ListAllComplete(ctx context.Context) (result ExpressRouteCircuitListResultIterator, err error)
ListAllComplete enumerates all values, automatically crossing page boundaries as required.
func (client ExpressRouteCircuitsClient) ListAllPreparer(ctx context.Context) (*http.Request, error)
ListAllPreparer prepares the ListAll request.
func (client ExpressRouteCircuitsClient) ListAllResponder(resp *http.Response) (result ExpressRouteCircuitListResult, err error)
ListAllResponder handles the response to the ListAll request. The method always closes the http.Response Body.
ListAllSender sends the ListAll request. The method will close the http.Response Body if it receives an error.
func (client ExpressRouteCircuitsClient) ListArpTable(ctx context.Context, resourceGroupName string, circuitName string, peeringName string, devicePath string) (result ExpressRouteCircuitsListArpTableFuture, err error)
ListArpTable gets the currently advertised ARP table associated with the express route circuit in a resource group. Parameters: resourceGroupName - the name of the resource group. circuitName - the name of the express route circuit. peeringName - the name of the peering. devicePath - the path of the device.
func (client ExpressRouteCircuitsClient) ListArpTablePreparer(ctx context.Context, resourceGroupName string, circuitName string, peeringName string, devicePath string) (*http.Request, error)
ListArpTablePreparer prepares the ListArpTable request.
func (client ExpressRouteCircuitsClient) ListArpTableResponder(resp *http.Response) (result ExpressRouteCircuitsArpTableListResult, err error)
ListArpTableResponder handles the response to the ListArpTable request. The method always closes the http.Response Body.
func (client ExpressRouteCircuitsClient) ListArpTableSender(req *http.Request) (future ExpressRouteCircuitsListArpTableFuture, err error)
ListArpTableSender sends the ListArpTable request. The method will close the http.Response Body if it receives an error.
func (client ExpressRouteCircuitsClient) ListComplete(ctx context.Context, resourceGroupName string) (result ExpressRouteCircuitListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client ExpressRouteCircuitsClient) ListPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
ListPreparer prepares the List request.
func (client ExpressRouteCircuitsClient) ListResponder(resp *http.Response) (result ExpressRouteCircuitListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client ExpressRouteCircuitsClient) ListRoutesTable(ctx context.Context, resourceGroupName string, circuitName string, peeringName string, devicePath string) (result ExpressRouteCircuitsListRoutesTableFuture, err error)
ListRoutesTable gets the currently advertised routes table associated with the express route circuit in a resource group. Parameters: resourceGroupName - the name of the resource group. circuitName - the name of the express route circuit. peeringName - the name of the peering. devicePath - the path of the device.
func (client ExpressRouteCircuitsClient) ListRoutesTablePreparer(ctx context.Context, resourceGroupName string, circuitName string, peeringName string, devicePath string) (*http.Request, error)
ListRoutesTablePreparer prepares the ListRoutesTable request.
func (client ExpressRouteCircuitsClient) ListRoutesTableResponder(resp *http.Response) (result ExpressRouteCircuitsRoutesTableListResult, err error)
ListRoutesTableResponder handles the response to the ListRoutesTable request. The method always closes the http.Response Body.
func (client ExpressRouteCircuitsClient) ListRoutesTableSender(req *http.Request) (future ExpressRouteCircuitsListRoutesTableFuture, err error)
ListRoutesTableSender sends the ListRoutesTable request. The method will close the http.Response Body if it receives an error.
func (client ExpressRouteCircuitsClient) ListRoutesTableSummary(ctx context.Context, resourceGroupName string, circuitName string, peeringName string, devicePath string) (result ExpressRouteCircuitsListRoutesTableSummaryFuture, err error)
ListRoutesTableSummary gets the currently advertised routes table summary associated with the express route circuit in a resource group. Parameters: resourceGroupName - the name of the resource group. circuitName - the name of the express route circuit. peeringName - the name of the peering. devicePath - the path of the device.
func (client ExpressRouteCircuitsClient) ListRoutesTableSummaryPreparer(ctx context.Context, resourceGroupName string, circuitName string, peeringName string, devicePath string) (*http.Request, error)
ListRoutesTableSummaryPreparer prepares the ListRoutesTableSummary request.
func (client ExpressRouteCircuitsClient) ListRoutesTableSummaryResponder(resp *http.Response) (result ExpressRouteCircuitsRoutesTableSummaryListResult, err error)
ListRoutesTableSummaryResponder handles the response to the ListRoutesTableSummary request. The method always closes the http.Response Body.
func (client ExpressRouteCircuitsClient) ListRoutesTableSummarySender(req *http.Request) (future ExpressRouteCircuitsListRoutesTableSummaryFuture, err error)
ListRoutesTableSummarySender sends the ListRoutesTableSummary request. The method will close the http.Response Body if it receives an error.
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
type ExpressRouteCircuitsCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(ExpressRouteCircuitsClient) (ExpressRouteCircuit, error)
}ExpressRouteCircuitsCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type ExpressRouteCircuitsDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(ExpressRouteCircuitsClient) (autorest.Response, error)
}ExpressRouteCircuitsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type ExpressRouteCircuitsListArpTableFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(ExpressRouteCircuitsClient) (ExpressRouteCircuitsArpTableListResult, error)
}ExpressRouteCircuitsListArpTableFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type ExpressRouteCircuitsListRoutesTableFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(ExpressRouteCircuitsClient) (ExpressRouteCircuitsRoutesTableListResult, error)
}ExpressRouteCircuitsListRoutesTableFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type ExpressRouteCircuitsListRoutesTableSummaryFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(ExpressRouteCircuitsClient) (ExpressRouteCircuitsRoutesTableSummaryListResult, error)
}ExpressRouteCircuitsListRoutesTableSummaryFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type ExpressRouteCircuitsRoutesTableListResult struct {
autorest.Response `json:"-"`
// Value - The list of routes table.
Value *[]ExpressRouteCircuitRoutesTable `json:"value,omitempty"`
// NextLink - The URL to get the next set of results.
NextLink *string `json:"nextLink,omitempty"`
}ExpressRouteCircuitsRoutesTableListResult response for ListRoutesTable associated with the Express Route Circuits API.
type ExpressRouteCircuitsRoutesTableSummaryListResult struct {
autorest.Response `json:"-"`
// Value - A list of the routes table.
Value *[]ExpressRouteCircuitRoutesTableSummary `json:"value,omitempty"`
// NextLink - The URL to get the next set of results.
NextLink *string `json:"nextLink,omitempty"`
}ExpressRouteCircuitsRoutesTableSummaryListResult response for ListRoutesTable associated with the Express Route Circuits API.
type ExpressRouteServiceProvider struct {
*ExpressRouteServiceProviderPropertiesFormat `json:"properties,omitempty"`
// ID - Resource ID.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; Resource name.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; Resource type.
Type *string `json:"type,omitempty"`
// Location - Resource location.
Location *string `json:"location,omitempty"`
// Tags - Resource tags.
Tags map[string]*string `json:"tags"`
}ExpressRouteServiceProvider a ExpressRouteResourceProvider object.
func (ersp ExpressRouteServiceProvider) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ExpressRouteServiceProvider.
func (ersp *ExpressRouteServiceProvider) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ExpressRouteServiceProvider struct.
type ExpressRouteServiceProviderBandwidthsOffered struct {
// OfferName - The OfferName.
OfferName *string `json:"offerName,omitempty"`
// ValueInMbps - The ValueInMbps.
ValueInMbps *int32 `json:"valueInMbps,omitempty"`
}ExpressRouteServiceProviderBandwidthsOffered contains bandwidths offered in ExpressRouteServiceProvider resources.
type ExpressRouteServiceProviderListResult struct {
autorest.Response `json:"-"`
// Value - A list of ExpressRouteResourceProvider resources.
Value *[]ExpressRouteServiceProvider `json:"value,omitempty"`
// NextLink - The URL to get the next set of results.
NextLink *string `json:"nextLink,omitempty"`
}ExpressRouteServiceProviderListResult response for the ListExpressRouteServiceProvider API service call.
func (ersplr ExpressRouteServiceProviderListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type ExpressRouteServiceProviderListResultIterator struct {
// contains filtered or unexported fields
}ExpressRouteServiceProviderListResultIterator provides access to a complete listing of ExpressRouteServiceProvider values.
func NewExpressRouteServiceProviderListResultIterator(page ExpressRouteServiceProviderListResultPage) ExpressRouteServiceProviderListResultIterator
Creates a new instance of the ExpressRouteServiceProviderListResultIterator type.
func (iter *ExpressRouteServiceProviderListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *ExpressRouteServiceProviderListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter ExpressRouteServiceProviderListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter ExpressRouteServiceProviderListResultIterator) Response() ExpressRouteServiceProviderListResult
Response returns the raw server response from the last page request.
func (iter ExpressRouteServiceProviderListResultIterator) Value() ExpressRouteServiceProvider
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type ExpressRouteServiceProviderListResultPage struct {
// contains filtered or unexported fields
}ExpressRouteServiceProviderListResultPage contains a page of ExpressRouteServiceProvider values.
func NewExpressRouteServiceProviderListResultPage(cur ExpressRouteServiceProviderListResult, getNextPage func(context.Context, ExpressRouteServiceProviderListResult) (ExpressRouteServiceProviderListResult, error)) ExpressRouteServiceProviderListResultPage
Creates a new instance of the ExpressRouteServiceProviderListResultPage type.
func (page *ExpressRouteServiceProviderListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *ExpressRouteServiceProviderListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page ExpressRouteServiceProviderListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page ExpressRouteServiceProviderListResultPage) Response() ExpressRouteServiceProviderListResult
Response returns the raw server response from the last page request.
func (page ExpressRouteServiceProviderListResultPage) Values() []ExpressRouteServiceProvider
Values returns the slice of values for the current page or nil if there are no values.
type ExpressRouteServiceProviderPropertiesFormat struct {
// PeeringLocations - Get a list of peering locations.
PeeringLocations *[]string `json:"peeringLocations,omitempty"`
// BandwidthsOffered - Gets bandwidths offered.
BandwidthsOffered *[]ExpressRouteServiceProviderBandwidthsOffered `json:"bandwidthsOffered,omitempty"`
// ProvisioningState - Gets the provisioning state of the resource.
ProvisioningState *string `json:"provisioningState,omitempty"`
}ExpressRouteServiceProviderPropertiesFormat properties of ExpressRouteServiceProvider.
type ExpressRouteServiceProvidersClient struct {
BaseClient
}ExpressRouteServiceProvidersClient is the network Client
func NewExpressRouteServiceProvidersClient(subscriptionID string) ExpressRouteServiceProvidersClient
NewExpressRouteServiceProvidersClient creates an instance of the ExpressRouteServiceProvidersClient client.
func NewExpressRouteServiceProvidersClientWithBaseURI(baseURI string, subscriptionID string) ExpressRouteServiceProvidersClient
NewExpressRouteServiceProvidersClientWithBaseURI creates an instance of the ExpressRouteServiceProvidersClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client ExpressRouteServiceProvidersClient) List(ctx context.Context) (result ExpressRouteServiceProviderListResultPage, err error)
List gets all the available express route service providers.
func (client ExpressRouteServiceProvidersClient) ListComplete(ctx context.Context) (result ExpressRouteServiceProviderListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client ExpressRouteServiceProvidersClient) ListPreparer(ctx context.Context) (*http.Request, error)
ListPreparer prepares the List request.
func (client ExpressRouteServiceProvidersClient) ListResponder(resp *http.Response) (result ExpressRouteServiceProviderListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client ExpressRouteServiceProvidersClient) 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.
type FlowLogInformation struct {
autorest.Response `json:"-"`
// TargetResourceID - The ID of the resource to configure for flow logging.
TargetResourceID *string `json:"targetResourceId,omitempty"`
*FlowLogProperties `json:"properties,omitempty"`
}FlowLogInformation information on the configuration of flow log.
func (fli FlowLogInformation) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for FlowLogInformation.
func (fli *FlowLogInformation) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for FlowLogInformation struct.
type FlowLogProperties struct {
// StorageID - ID of the storage account which is used to store the flow log.
StorageID *string `json:"storageId,omitempty"`
// Enabled - Flag to enable/disable flow logging.
Enabled *bool `json:"enabled,omitempty"`
RetentionPolicy *RetentionPolicyParameters `json:"retentionPolicy,omitempty"`
}FlowLogProperties parameters that define the configuration of flow log.
type FlowLogStatusParameters struct {
// TargetResourceID - The target resource where getting the flow logging status.
TargetResourceID *string `json:"targetResourceId,omitempty"`
}FlowLogStatusParameters parameters that define a resource to query flow log status.
type FrontendIPConfiguration struct {
*FrontendIPConfigurationPropertiesFormat `json:"properties,omitempty"`
// Name - The name of the resource that is unique within a resource group. This name can be used to access the resource.
Name *string `json:"name,omitempty"`
// Etag - A unique read-only string that changes whenever the resource is updated.
Etag *string `json:"etag,omitempty"`
// ID - Resource ID.
ID *string `json:"id,omitempty"`
}FrontendIPConfiguration frontend IP address of the load balancer.
func (fic FrontendIPConfiguration) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for FrontendIPConfiguration.
func (fic *FrontendIPConfiguration) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for FrontendIPConfiguration struct.
type FrontendIPConfigurationPropertiesFormat struct {
// InboundNatRules - READ-ONLY; Read only. Inbound rules URIs that use this frontend IP.
InboundNatRules *[]SubResource `json:"inboundNatRules,omitempty"`
// InboundNatPools - READ-ONLY; Read only. Inbound pools URIs that use this frontend IP.
InboundNatPools *[]SubResource `json:"inboundNatPools,omitempty"`
// OutboundNatRules - READ-ONLY; Read only. Outbound rules URIs that use this frontend IP.
OutboundNatRules *[]SubResource `json:"outboundNatRules,omitempty"`
// LoadBalancingRules - READ-ONLY; Gets load balancing rules URIs that use this frontend IP.
LoadBalancingRules *[]SubResource `json:"loadBalancingRules,omitempty"`
// PrivateIPAddress - The private IP address of the IP configuration.
PrivateIPAddress *string `json:"privateIPAddress,omitempty"`
// PrivateIPAllocationMethod - The Private IP allocation method. Possible values are: 'Static' and 'Dynamic'. Possible values include: 'Static', 'Dynamic'
PrivateIPAllocationMethod IPAllocationMethod `json:"privateIPAllocationMethod,omitempty"`
// Subnet - The reference of the subnet resource.
Subnet *Subnet `json:"subnet,omitempty"`
// PublicIPAddress - The reference of the Public IP resource.
PublicIPAddress *PublicIPAddress `json:"publicIPAddress,omitempty"`
// ProvisioningState - Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.
ProvisioningState *string `json:"provisioningState,omitempty"`
}FrontendIPConfigurationPropertiesFormat properties of Frontend IP Configuration of the load balancer.
func (ficpf FrontendIPConfigurationPropertiesFormat) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for FrontendIPConfigurationPropertiesFormat.
type GatewayRoute struct {
// LocalAddress - READ-ONLY; The gateway's local address
LocalAddress *string `json:"localAddress,omitempty"`
// NetworkProperty - READ-ONLY; The route's network prefix
NetworkProperty *string `json:"network,omitempty"`
// NextHop - READ-ONLY; The route's next hop
NextHop *string `json:"nextHop,omitempty"`
// SourcePeer - READ-ONLY; The peer this route was learned from
SourcePeer *string `json:"sourcePeer,omitempty"`
// Origin - READ-ONLY; The source this route was learned from
Origin *string `json:"origin,omitempty"`
// AsPath - READ-ONLY; The route's AS path sequence
AsPath *string `json:"asPath,omitempty"`
// Weight - READ-ONLY; The route's weight
Weight *int32 `json:"weight,omitempty"`
}GatewayRoute gateway routing details
type GatewayRouteListResult struct {
autorest.Response `json:"-"`
// Value - List of gateway routes
Value *[]GatewayRoute `json:"value,omitempty"`
}GatewayRouteListResult list of virtual network gateway routes
type IPAddressAvailabilityResult struct {
autorest.Response `json:"-"`
// Available - Private IP address availability.
Available *bool `json:"available,omitempty"`
// AvailableIPAddresses - Contains other available private IP addresses if the asked for address is taken.
AvailableIPAddresses *[]string `json:"availableIPAddresses,omitempty"`
}IPAddressAvailabilityResult response for CheckIPAddressAvailability API service call
IPAllocationMethod enumerates the values for ip allocation method.
const (
// Dynamic ...
Dynamic IPAllocationMethod = "Dynamic"
// Static ...
Static IPAllocationMethod = "Static"
)func PossibleIPAllocationMethodValues() []IPAllocationMethod
PossibleIPAllocationMethodValues returns an array of possible values for the IPAllocationMethod const type.
type IPConfiguration struct {
*IPConfigurationPropertiesFormat `json:"properties,omitempty"`
// Name - The name of the resource that is unique within a resource group. This name can be used to access the resource.
Name *string `json:"name,omitempty"`
// Etag - A unique read-only string that changes whenever the resource is updated.
Etag *string `json:"etag,omitempty"`
// ID - Resource ID.
ID *string `json:"id,omitempty"`
}IPConfiguration iPConfiguration
func (ic IPConfiguration) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for IPConfiguration.
func (ic *IPConfiguration) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for IPConfiguration struct.
type IPConfigurationPropertiesFormat struct {
// PrivateIPAddress - The private IP address of the IP configuration.
PrivateIPAddress *string `json:"privateIPAddress,omitempty"`
// PrivateIPAllocationMethod - The private IP allocation method. Possible values are 'Static' and 'Dynamic'. Possible values include: 'Static', 'Dynamic'
PrivateIPAllocationMethod IPAllocationMethod `json:"privateIPAllocationMethod,omitempty"`
// Subnet - The reference of the subnet resource.
Subnet *Subnet `json:"subnet,omitempty"`
// PublicIPAddress - The reference of the public IP resource.
PublicIPAddress *PublicIPAddress `json:"publicIPAddress,omitempty"`
// ProvisioningState - Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.
ProvisioningState *string `json:"provisioningState,omitempty"`
}IPConfigurationPropertiesFormat properties of IP configuration.
IPVersion enumerates the values for ip version.
PossibleIPVersionValues returns an array of possible values for the IPVersion const type.
IkeEncryption enumerates the values for ike encryption.
const (
// AES128 ...
AES128 IkeEncryption = "AES128"
// AES192 ...
AES192 IkeEncryption = "AES192"
// AES256 ...
AES256 IkeEncryption = "AES256"
// DES ...
DES IkeEncryption = "DES"
// DES3 ...
DES3 IkeEncryption = "DES3"
)func PossibleIkeEncryptionValues() []IkeEncryption
PossibleIkeEncryptionValues returns an array of possible values for the IkeEncryption const type.
IkeIntegrity enumerates the values for ike integrity.
const (
// MD5 ...
MD5 IkeIntegrity = "MD5"
// SHA1 ...
SHA1 IkeIntegrity = "SHA1"
// SHA256 ...
SHA256 IkeIntegrity = "SHA256"
// SHA384 ...
SHA384 IkeIntegrity = "SHA384"
)func PossibleIkeIntegrityValues() []IkeIntegrity
PossibleIkeIntegrityValues returns an array of possible values for the IkeIntegrity const type.
type InboundNatPool struct {
*InboundNatPoolPropertiesFormat `json:"properties,omitempty"`
// Name - The name of the resource that is unique within a resource group. This name can be used to access the resource.
Name *string `json:"name,omitempty"`
// Etag - A unique read-only string that changes whenever the resource is updated.
Etag *string `json:"etag,omitempty"`
// ID - Resource ID.
ID *string `json:"id,omitempty"`
}InboundNatPool inbound NAT pool of the load balancer.
func (inp InboundNatPool) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for InboundNatPool.
func (inp *InboundNatPool) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for InboundNatPool struct.
type InboundNatPoolPropertiesFormat struct {
// FrontendIPConfiguration - A reference to frontend IP addresses.
FrontendIPConfiguration *SubResource `json:"frontendIPConfiguration,omitempty"`
// Protocol - The transport protocol for the endpoint. Possible values are: 'Udp' or 'Tcp'. Possible values include: 'TransportProtocolUDP', 'TransportProtocolTCP'
Protocol TransportProtocol `json:"protocol,omitempty"`
// FrontendPortRangeStart - The first port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65534.
FrontendPortRangeStart *int32 `json:"frontendPortRangeStart,omitempty"`
// FrontendPortRangeEnd - The last port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65535.
FrontendPortRangeEnd *int32 `json:"frontendPortRangeEnd,omitempty"`
// BackendPort - The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535.
BackendPort *int32 `json:"backendPort,omitempty"`
// ProvisioningState - Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.
ProvisioningState *string `json:"provisioningState,omitempty"`
}InboundNatPoolPropertiesFormat properties of Inbound NAT pool.
type InboundNatRule struct {
*InboundNatRulePropertiesFormat `json:"properties,omitempty"`
// Name - Gets name of the resource that is unique within a resource group. This name can be used to access the resource.
Name *string `json:"name,omitempty"`
// Etag - A unique read-only string that changes whenever the resource is updated.
Etag *string `json:"etag,omitempty"`
// ID - Resource ID.
ID *string `json:"id,omitempty"`
}InboundNatRule inbound NAT rule of the load balancer.
func (inr InboundNatRule) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for InboundNatRule.
func (inr *InboundNatRule) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for InboundNatRule struct.
type InboundNatRulePropertiesFormat struct {
// FrontendIPConfiguration - A reference to frontend IP addresses.
FrontendIPConfiguration *SubResource `json:"frontendIPConfiguration,omitempty"`
// BackendIPConfiguration - READ-ONLY; A reference to a private IP address defined on a network interface of a VM. Traffic sent to the frontend port of each of the frontend IP configurations is forwarded to the backed IP.
BackendIPConfiguration *InterfaceIPConfiguration `json:"backendIPConfiguration,omitempty"`
// Protocol - The transport protocol for the endpoint. Possible values are: 'Udp' or 'Tcp'. Possible values include: 'TransportProtocolUDP', 'TransportProtocolTCP'
Protocol TransportProtocol `json:"protocol,omitempty"`
// FrontendPort - The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values range from 1 to 65534.
FrontendPort *int32 `json:"frontendPort,omitempty"`
// BackendPort - The port used for the internal endpoint. Acceptable values range from 1 to 65535.
BackendPort *int32 `json:"backendPort,omitempty"`
// IdleTimeoutInMinutes - The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.
IdleTimeoutInMinutes *int32 `json:"idleTimeoutInMinutes,omitempty"`
// EnableFloatingIP - Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.
EnableFloatingIP *bool `json:"enableFloatingIP,omitempty"`
// ProvisioningState - Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.
ProvisioningState *string `json:"provisioningState,omitempty"`
}InboundNatRulePropertiesFormat properties of the inbound NAT rule.
func (inrpf InboundNatRulePropertiesFormat) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for InboundNatRulePropertiesFormat.
type Interface struct {
autorest.Response `json:"-"`
*InterfacePropertiesFormat `json:"properties,omitempty"`
// Etag - A unique read-only string that changes whenever the resource is updated.
Etag *string `json:"etag,omitempty"`
// ID - Resource ID.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; Resource name.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; Resource type.
Type *string `json:"type,omitempty"`
// Location - Resource location.
Location *string `json:"location,omitempty"`
// Tags - Resource tags.
Tags map[string]*string `json:"tags"`
}Interface a network interface in a resource group.
MarshalJSON is the custom marshaler for Interface.
UnmarshalJSON is the custom unmarshaler for Interface struct.
type InterfaceAssociation struct {
// ID - READ-ONLY; Network interface ID.
ID *string `json:"id,omitempty"`
// SecurityRules - Collection of custom security rules.
SecurityRules *[]SecurityRule `json:"securityRules,omitempty"`
}InterfaceAssociation network interface and its custom security rules.
func (ia InterfaceAssociation) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for InterfaceAssociation.
type InterfaceDNSSettings struct {
// DNSServers - List of DNS servers IP addresses. Use 'AzureProvidedDNS' to switch to azure provided DNS resolution. 'AzureProvidedDNS' value cannot be combined with other IPs, it must be the only value in dnsServers collection.
DNSServers *[]string `json:"dnsServers,omitempty"`
// AppliedDNSServers - If the VM that uses this NIC is part of an Availability Set, then this list will have the union of all DNS servers from all NICs that are part of the Availability Set. This property is what is configured on each of those VMs.
AppliedDNSServers *[]string `json:"appliedDnsServers,omitempty"`
// InternalDNSNameLabel - Relative DNS name for this NIC used for internal communications between VMs in the same virtual network.
InternalDNSNameLabel *string `json:"internalDnsNameLabel,omitempty"`
// InternalFqdn - Fully qualified DNS name supporting internal communications between VMs in the same virtual network.
InternalFqdn *string `json:"internalFqdn,omitempty"`
// InternalDomainNameSuffix - Even if internalDnsNameLabel is not specified, a DNS entry is created for the primary NIC of the VM. This DNS name can be constructed by concatenating the VM name with the value of internalDomainNameSuffix.
InternalDomainNameSuffix *string `json:"internalDomainNameSuffix,omitempty"`
}InterfaceDNSSettings DNS settings of a network interface.
type InterfaceIPConfiguration struct {
*InterfaceIPConfigurationPropertiesFormat `json:"properties,omitempty"`
// Name - The name of the resource that is unique within a resource group. This name can be used to access the resource.
Name *string `json:"name,omitempty"`
// Etag - A unique read-only string that changes whenever the resource is updated.
Etag *string `json:"etag,omitempty"`
// ID - Resource ID.
ID *string `json:"id,omitempty"`
}InterfaceIPConfiguration iPConfiguration in a network interface.
func (iic InterfaceIPConfiguration) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for InterfaceIPConfiguration.
func (iic *InterfaceIPConfiguration) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for InterfaceIPConfiguration struct.
type InterfaceIPConfigurationPropertiesFormat struct {
// ApplicationGatewayBackendAddressPools - The reference of ApplicationGatewayBackendAddressPool resource.
ApplicationGatewayBackendAddressPools *[]ApplicationGatewayBackendAddressPool `json:"applicationGatewayBackendAddressPools,omitempty"`
// LoadBalancerBackendAddressPools - The reference of LoadBalancerBackendAddressPool resource.
LoadBalancerBackendAddressPools *[]BackendAddressPool `json:"loadBalancerBackendAddressPools,omitempty"`
// LoadBalancerInboundNatRules - A list of references of LoadBalancerInboundNatRules.
LoadBalancerInboundNatRules *[]InboundNatRule `json:"loadBalancerInboundNatRules,omitempty"`
PrivateIPAddress *string `json:"privateIPAddress,omitempty"`
// PrivateIPAllocationMethod - Defines how a private IP address is assigned. Possible values are: 'Static' and 'Dynamic'. Possible values include: 'Static', 'Dynamic'
PrivateIPAllocationMethod IPAllocationMethod `json:"privateIPAllocationMethod,omitempty"`
// PrivateIPAddressVersion - Available from Api-Version 2016-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. Possible values include: 'IPv4', 'IPv6'
PrivateIPAddressVersion IPVersion `json:"privateIPAddressVersion,omitempty"`
Subnet *Subnet `json:"subnet,omitempty"`
// Primary - Gets whether this is a primary customer address on the network interface.
Primary *bool `json:"primary,omitempty"`
PublicIPAddress *PublicIPAddress `json:"publicIPAddress,omitempty"`
ProvisioningState *string `json:"provisioningState,omitempty"`
}InterfaceIPConfigurationPropertiesFormat properties of IP configuration.
type InterfaceListResult struct {
autorest.Response `json:"-"`
// Value - A list of network interfaces in a resource group.
Value *[]Interface `json:"value,omitempty"`
// NextLink - The URL to get the next set of results.
NextLink *string `json:"nextLink,omitempty"`
}InterfaceListResult response for the ListNetworkInterface API service call.
func (ilr InterfaceListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type InterfaceListResultIterator struct {
// contains filtered or unexported fields
}InterfaceListResultIterator provides access to a complete listing of Interface values.
func NewInterfaceListResultIterator(page InterfaceListResultPage) InterfaceListResultIterator
Creates a new instance of the InterfaceListResultIterator type.
func (iter *InterfaceListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *InterfaceListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter InterfaceListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter InterfaceListResultIterator) Response() InterfaceListResult
Response returns the raw server response from the last page request.
func (iter InterfaceListResultIterator) Value() Interface
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type InterfaceListResultPage struct {
// contains filtered or unexported fields
}InterfaceListResultPage contains a page of Interface values.
func NewInterfaceListResultPage(cur InterfaceListResult, getNextPage func(context.Context, InterfaceListResult) (InterfaceListResult, error)) InterfaceListResultPage
Creates a new instance of the InterfaceListResultPage type.
func (page *InterfaceListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *InterfaceListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page InterfaceListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page InterfaceListResultPage) Response() InterfaceListResult
Response returns the raw server response from the last page request.
func (page InterfaceListResultPage) Values() []Interface
Values returns the slice of values for the current page or nil if there are no values.
type InterfacePropertiesFormat struct {
// VirtualMachine - The reference of a virtual machine.
VirtualMachine *SubResource `json:"virtualMachine,omitempty"`
// NetworkSecurityGroup - The reference of the NetworkSecurityGroup resource.
NetworkSecurityGroup *SecurityGroup `json:"networkSecurityGroup,omitempty"`
// IPConfigurations - A list of IPConfigurations of the network interface.
IPConfigurations *[]InterfaceIPConfiguration `json:"ipConfigurations,omitempty"`
// DNSSettings - The DNS settings in network interface.
DNSSettings *InterfaceDNSSettings `json:"dnsSettings,omitempty"`
// MacAddress - The MAC address of the network interface.
MacAddress *string `json:"macAddress,omitempty"`
// Primary - Gets whether this is a primary network interface on a virtual machine.
Primary *bool `json:"primary,omitempty"`
// EnableAcceleratedNetworking - If the network interface is accelerated networking enabled.
EnableAcceleratedNetworking *bool `json:"enableAcceleratedNetworking,omitempty"`
// EnableIPForwarding - Indicates whether IP forwarding is enabled on this network interface.
EnableIPForwarding *bool `json:"enableIPForwarding,omitempty"`
// ResourceGUID - The resource GUID property of the network interface resource.
ResourceGUID *string `json:"resourceGuid,omitempty"`
// ProvisioningState - The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.
ProvisioningState *string `json:"provisioningState,omitempty"`
}InterfacePropertiesFormat networkInterface properties.
type InterfacesClient struct {
BaseClient
}InterfacesClient is the network Client
func NewInterfacesClient(subscriptionID string) InterfacesClient
NewInterfacesClient creates an instance of the InterfacesClient client.
func NewInterfacesClientWithBaseURI(baseURI string, subscriptionID string) InterfacesClient
NewInterfacesClientWithBaseURI creates an instance of the InterfacesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client InterfacesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, networkInterfaceName string, parameters Interface) (result InterfacesCreateOrUpdateFuture, err error)
CreateOrUpdate creates or updates a network interface. Parameters: resourceGroupName - the name of the resource group. networkInterfaceName - the name of the network interface. parameters - parameters supplied to the create or update network interface operation.
func (client InterfacesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, networkInterfaceName string, parameters Interface) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client InterfacesClient) CreateOrUpdateResponder(resp *http.Response) (result Interface, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client InterfacesClient) CreateOrUpdateSender(req *http.Request) (future InterfacesCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client InterfacesClient) Delete(ctx context.Context, resourceGroupName string, networkInterfaceName string) (result InterfacesDeleteFuture, err error)
Delete deletes the specified network interface. Parameters: resourceGroupName - the name of the resource group. networkInterfaceName - the name of the network interface.
func (client InterfacesClient) DeletePreparer(ctx context.Context, resourceGroupName string, networkInterfaceName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client InterfacesClient) 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 (client InterfacesClient) DeleteSender(req *http.Request) (future InterfacesDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client InterfacesClient) Get(ctx context.Context, resourceGroupName string, networkInterfaceName string, expand string) (result Interface, err error)
Get gets information about the specified network interface. Parameters: resourceGroupName - the name of the resource group. networkInterfaceName - the name of the network interface. expand - expands referenced resources.
func (client InterfacesClient) GetEffectiveRouteTable(ctx context.Context, resourceGroupName string, networkInterfaceName string) (result InterfacesGetEffectiveRouteTableFuture, err error)
GetEffectiveRouteTable gets all route tables applied to a network interface. Parameters: resourceGroupName - the name of the resource group. networkInterfaceName - the name of the network interface.
func (client InterfacesClient) GetEffectiveRouteTablePreparer(ctx context.Context, resourceGroupName string, networkInterfaceName string) (*http.Request, error)
GetEffectiveRouteTablePreparer prepares the GetEffectiveRouteTable request.
func (client InterfacesClient) GetEffectiveRouteTableResponder(resp *http.Response) (result EffectiveRouteListResult, err error)
GetEffectiveRouteTableResponder handles the response to the GetEffectiveRouteTable request. The method always closes the http.Response Body.
func (client InterfacesClient) GetEffectiveRouteTableSender(req *http.Request) (future InterfacesGetEffectiveRouteTableFuture, err error)
GetEffectiveRouteTableSender sends the GetEffectiveRouteTable request. The method will close the http.Response Body if it receives an error.
func (client InterfacesClient) GetPreparer(ctx context.Context, resourceGroupName string, networkInterfaceName string, expand string) (*http.Request, error)
GetPreparer prepares the Get request.
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client InterfacesClient) GetVirtualMachineScaleSetNetworkInterface(ctx context.Context, resourceGroupName string, virtualMachineScaleSetName string, virtualmachineIndex string, networkInterfaceName string, expand string) (result Interface, err error)
GetVirtualMachineScaleSetNetworkInterface get the specified network interface in a virtual machine scale set. Parameters: resourceGroupName - the name of the resource group. virtualMachineScaleSetName - the name of the virtual machine scale set. virtualmachineIndex - the virtual machine index. networkInterfaceName - the name of the network interface. expand - expands referenced resources.