import "github.com/Azure/azure-sdk-for-go/services/network/mgmt/2015-06-15/network"
Package network implements the Azure ARM Network service API version 2015-06-15.
Network Client
applicationgateways.go client.go expressroutecircuitauthorizations.go expressroutecircuitpeerings.go expressroutecircuits.go expressrouteserviceproviders.go interfacesgroup.go loadbalancers.go localnetworkgateways.go models.go publicipaddresses.go routes.go routetables.go securitygroups.go securityrules.go subnets.go usages.go version.go virtualnetworkgatewayconnections.go virtualnetworkgateways.go virtualnetworks.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.
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 Identifier.
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 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 Identifier.
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 Identifier.
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 are: 'Http' and 'Https'. Possible values include: 'HTTP', 'HTTPS'
Protocol ApplicationGatewayProtocol `json:"protocol,omitempty"`
// CookieBasedAffinity - Cookie based affinity. Possible values are: 'Enabled' and 'Disabled'. 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"`
// ProvisioningState - Gets or sets Provisioning state of the backend http settings resource Updating/Deleting/Failed
ProvisioningState *string `json:"provisioningState,omitempty"`
}ApplicationGatewayBackendHTTPSettingsPropertiesFormat properties of Backend address pool settings of an application gateway.
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 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 Identifier.
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 are: 'Static' and 'Dynamic'. 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 Identifier.
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 Identifier.
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 are: 'Http' and 'Https'. 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 Identifier.
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(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 Identifier.
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 Identifier.
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 are: 'Http' and 'Https'. 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"`
// OperationalState - READ-ONLY; Operational state of the application gateway resource. Possible values are: 'Stopped', 'Started', 'Running', and 'Stopping'. Possible values include: 'Stopped', 'Starting', 'Running', 'Stopping'
OperationalState ApplicationGatewayOperationalState `json:"operationalState,omitempty"`
// GatewayIPConfigurations - Gets or sets subnets of application gateway resource
GatewayIPConfigurations *[]ApplicationGatewayIPConfiguration `json:"gatewayIPConfigurations,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"`
// 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.
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 Identifier.
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 are: 'Basic' and 'PathBasedRouting'. 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 are: 'Standard_Small', 'Standard_Medium', 'Standard_Large', 'WAF_Medium', and 'WAF_Large'. Possible values include: 'StandardSmall', 'StandardMedium', 'StandardLarge'
Name ApplicationGatewaySkuName `json:"name,omitempty"`
// Tier - Tier of an application gateway. Possible values include: 'Standard'
Tier ApplicationGatewayTier `json:"tier,omitempty"`
// Capacity - Capacity (instance count) of an application gateway.
Capacity *int32 `json:"capacity,omitempty"`
}ApplicationGatewaySku SKU of 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"
)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 Identifier.
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.
ApplicationGatewayTier enumerates the values for application gateway tier.
const (
// Standard ...
Standard ApplicationGatewayTier = "Standard"
)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 Identifier.
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 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) 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) 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.
ApplicationGatewaysCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
func (future *ApplicationGatewaysCreateOrUpdateFuture) Result(client ApplicationGatewaysClient) (ag ApplicationGateway, err error)
Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.
ApplicationGatewaysDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
func (future *ApplicationGatewaysDeleteFuture) Result(client ApplicationGatewaysClient) (ar autorest.Response, err error)
Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.
ApplicationGatewaysStartFuture an abstraction for monitoring and retrieving the results of a long-running operation.
func (future *ApplicationGatewaysStartFuture) Result(client ApplicationGatewaysClient) (ar autorest.Response, err error)
Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.
ApplicationGatewaysStopFuture an abstraction for monitoring and retrieving the results of a long-running operation.
func (future *ApplicationGatewaysStopFuture) Result(client ApplicationGatewaysClient) (ar autorest.Response, err error)
Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.
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(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 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 Identifier.
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 - 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 - 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.
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.
type BgpSettings struct {
// Asn - Gets or sets this BGP speaker's ASN
Asn *int64 `json:"asn,omitempty"`
// BgpPeeringAddress - Gets or sets the BGP peering address and BGP identifier of this BGP speaker
BgpPeeringAddress *string `json:"bgpPeeringAddress,omitempty"`
// PeerWeight - Gets or sets the weight added to routes learned from this BGP speaker
PeerWeight *int32 `json:"peerWeight,omitempty"`
}BgpSettings ...
type ConnectionResetSharedKey struct {
autorest.Response `json:"-"`
// KeyLength - The virtual network connection reset shared key length
*int64 `json:"keyLength,omitempty"`
}ConnectionResetSharedKey ...
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
type ConnectionSharedKeyResult struct {
autorest.Response `json:"-"`
// Value - The virtual network connection shared key value
*string `json:"value,omitempty"`
}ConnectionSharedKeyResult response for CheckConnectionSharedKey API service call
type DNSNameAvailabilityResult struct {
autorest.Response `json:"-"`
// Available - Domain availability (True/False).
Available *bool `json:"available,omitempty"`
}DNSNameAvailabilityResult response for the CheckDnsNameAvailability API service call.
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.
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 error object properties
type ErrorDetails struct {
Code *string `json:"code,omitempty"`
Target *string `json:"target,omitempty"`
Message *string `json:"message,omitempty"`
}ErrorDetails error details properties
type ExpressRouteCircuit struct {
autorest.Response `json:"-"`
// Sku - The SKU.
Sku *ExpressRouteCircuitSku `json:"sku,omitempty"`
*ExpressRouteCircuitPropertiesFormat `json:"properties,omitempty"`
// Etag - Gets a unique read-only string that changes whenever the resource is updated.
Etag *string `json:"etag,omitempty"`
// ID - Resource Identifier.
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 {
// 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 - A unique read-only string that changes whenever the resource is updated.
Etag *string `json:"etag,omitempty"`
// ID - Resource Identifier.
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.
ExpressRouteCircuitAuthorizationsCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
func (future *ExpressRouteCircuitAuthorizationsCreateOrUpdateFuture) Result(client ExpressRouteCircuitAuthorizationsClient) (erca ExpressRouteCircuitAuthorization, err error)
Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.
ExpressRouteCircuitAuthorizationsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
func (future *ExpressRouteCircuitAuthorizationsDeleteFuture) Result(client ExpressRouteCircuitAuthorizationsClient) (ar autorest.Response, err error)
Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.
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(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 - A unique read-only string that changes whenever the resource is updated.
Etag *string `json:"etag,omitempty"`
// ID - Resource Identifier.
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(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"`
}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.
ExpressRouteCircuitPeeringsCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
func (future *ExpressRouteCircuitPeeringsCreateOrUpdateFuture) Result(client ExpressRouteCircuitPeeringsClient) (ercp ExpressRouteCircuitPeering, err error)
Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.
ExpressRouteCircuitPeeringsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
func (future *ExpressRouteCircuitPeeringsDeleteFuture) Result(client ExpressRouteCircuitPeeringsClient) (ar autorest.Response, err error)
Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.
type ExpressRouteCircuitPropertiesFormat struct {
// 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"`
}ExpressRouteCircuitPropertiesFormat properties of ExpressRouteCircuit.
type ExpressRouteCircuitRoutesTable struct {
// AddressPrefix - Gets AddressPrefix.
AddressPrefix *string `json:"addressPrefix,omitempty"`
// NextHopType - Gets NextHopType. Possible values include: 'RouteNextHopTypeVirtualNetworkGateway', 'RouteNextHopTypeVnetLocal', 'RouteNextHopTypeInternet', 'RouteNextHopTypeVirtualAppliance', 'RouteNextHopTypeNone'
NextHopType RouteNextHopType `json:"nextHopType,omitempty"`
// NextHopIP - Gets NextHopIP.
NextHopIP *string `json:"nextHopIP,omitempty"`
// AsPath - Gets AsPath.
AsPath *string `json:"asPath,omitempty"`
}ExpressRouteCircuitRoutesTable 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 {
// BytesIn - Gets BytesIn of the peering.
BytesIn *int32 `json:"bytesIn,omitempty"`
// BytesOut - Gets BytesOut of the peering.
BytesOut *int32 `json:"bytesOut,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.
func (ercatlr ExpressRouteCircuitsArpTableListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type ExpressRouteCircuitsArpTableListResultIterator struct {
// contains filtered or unexported fields
}ExpressRouteCircuitsArpTableListResultIterator provides access to a complete listing of ExpressRouteCircuitArpTable values.
func NewExpressRouteCircuitsArpTableListResultIterator(page ExpressRouteCircuitsArpTableListResultPage) ExpressRouteCircuitsArpTableListResultIterator
Creates a new instance of the ExpressRouteCircuitsArpTableListResultIterator type.
func (iter *ExpressRouteCircuitsArpTableListResultIterator) 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 *ExpressRouteCircuitsArpTableListResultIterator) 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 ExpressRouteCircuitsArpTableListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter ExpressRouteCircuitsArpTableListResultIterator) Response() ExpressRouteCircuitsArpTableListResult
Response returns the raw server response from the last page request.
func (iter ExpressRouteCircuitsArpTableListResultIterator) Value() ExpressRouteCircuitArpTable
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type ExpressRouteCircuitsArpTableListResultPage struct {
// contains filtered or unexported fields
}ExpressRouteCircuitsArpTableListResultPage contains a page of ExpressRouteCircuitArpTable values.
func NewExpressRouteCircuitsArpTableListResultPage(getNextPage func(context.Context, ExpressRouteCircuitsArpTableListResult) (ExpressRouteCircuitsArpTableListResult, error)) ExpressRouteCircuitsArpTableListResultPage
Creates a new instance of the ExpressRouteCircuitsArpTableListResultPage type.
func (page *ExpressRouteCircuitsArpTableListResultPage) 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 *ExpressRouteCircuitsArpTableListResultPage) 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 ExpressRouteCircuitsArpTableListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page ExpressRouteCircuitsArpTableListResultPage) Response() ExpressRouteCircuitsArpTableListResult
Response returns the raw server response from the last page request.
func (page ExpressRouteCircuitsArpTableListResultPage) Values() []ExpressRouteCircuitArpTable
Values returns the slice of values for the current page or nil if there are no values.
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) 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) 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) (result ExpressRouteCircuitsArpTableListResultPage, err error)
ListArpTable the ListArpTable from ExpressRouteCircuit operation retrieves the currently advertised arp table associated with the ExpressRouteCircuits in a resource group. Parameters: resourceGroupName - the name of the resource group. circuitName - the name of the circuit.
func (client ExpressRouteCircuitsClient) ListArpTableComplete(ctx context.Context, resourceGroupName string, circuitName string) (result ExpressRouteCircuitsArpTableListResultIterator, err error)
ListArpTableComplete enumerates all values, automatically crossing page boundaries as required.
func (client ExpressRouteCircuitsClient) ListArpTablePreparer(ctx context.Context, resourceGroupName string, circuitName 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) (*http.Response, 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) (result ExpressRouteCircuitsRoutesTableListResultPage, err error)
ListRoutesTable the ListRoutesTable from ExpressRouteCircuit operation retrieves the currently advertised routes table associated with the ExpressRouteCircuits in a resource group. Parameters: resourceGroupName - the name of the resource group. circuitName - the name of the circuit.
func (client ExpressRouteCircuitsClient) ListRoutesTableComplete(ctx context.Context, resourceGroupName string, circuitName string) (result ExpressRouteCircuitsRoutesTableListResultIterator, err error)
ListRoutesTableComplete enumerates all values, automatically crossing page boundaries as required.
func (client ExpressRouteCircuitsClient) ListRoutesTablePreparer(ctx context.Context, resourceGroupName string, circuitName 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) (*http.Response, error)
ListRoutesTableSender sends the ListRoutesTable 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.
func (client ExpressRouteCircuitsClient) ListStats(ctx context.Context, resourceGroupName string, circuitName string) (result ExpressRouteCircuitsStatsListResultPage, err error)
ListStats the ListStats ExpressRouteCircuit operation retrieves all the stats from a ExpressRouteCircuits in a resource group. Parameters: resourceGroupName - the name of the resource group. circuitName - the name of the loadBalancer.
func (client ExpressRouteCircuitsClient) ListStatsComplete(ctx context.Context, resourceGroupName string, circuitName string) (result ExpressRouteCircuitsStatsListResultIterator, err error)
ListStatsComplete enumerates all values, automatically crossing page boundaries as required.
func (client ExpressRouteCircuitsClient) ListStatsPreparer(ctx context.Context, resourceGroupName string, circuitName string) (*http.Request, error)
ListStatsPreparer prepares the ListStats request.
func (client ExpressRouteCircuitsClient) ListStatsResponder(resp *http.Response) (result ExpressRouteCircuitsStatsListResult, err error)
ListStatsResponder handles the response to the ListStats request. The method always closes the http.Response Body.
func (client ExpressRouteCircuitsClient) ListStatsSender(req *http.Request) (*http.Response, error)
ListStatsSender sends the ListStats request. The method will close the http.Response Body if it receives an error.
ExpressRouteCircuitsCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
func (future *ExpressRouteCircuitsCreateOrUpdateFuture) Result(client ExpressRouteCircuitsClient) (erc ExpressRouteCircuit, err error)
Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.
ExpressRouteCircuitsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
func (future *ExpressRouteCircuitsDeleteFuture) Result(client ExpressRouteCircuitsClient) (ar autorest.Response, err error)
Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.
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.
func (ercrtlr ExpressRouteCircuitsRoutesTableListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type ExpressRouteCircuitsRoutesTableListResultIterator struct {
// contains filtered or unexported fields
}ExpressRouteCircuitsRoutesTableListResultIterator provides access to a complete listing of ExpressRouteCircuitRoutesTable values.
func NewExpressRouteCircuitsRoutesTableListResultIterator(page ExpressRouteCircuitsRoutesTableListResultPage) ExpressRouteCircuitsRoutesTableListResultIterator
Creates a new instance of the ExpressRouteCircuitsRoutesTableListResultIterator type.
func (iter *ExpressRouteCircuitsRoutesTableListResultIterator) 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 *ExpressRouteCircuitsRoutesTableListResultIterator) 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 ExpressRouteCircuitsRoutesTableListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter ExpressRouteCircuitsRoutesTableListResultIterator) Response() ExpressRouteCircuitsRoutesTableListResult
Response returns the raw server response from the last page request.
func (iter ExpressRouteCircuitsRoutesTableListResultIterator) Value() ExpressRouteCircuitRoutesTable
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type ExpressRouteCircuitsRoutesTableListResultPage struct {
// contains filtered or unexported fields
}ExpressRouteCircuitsRoutesTableListResultPage contains a page of ExpressRouteCircuitRoutesTable values.
func NewExpressRouteCircuitsRoutesTableListResultPage(getNextPage func(context.Context, ExpressRouteCircuitsRoutesTableListResult) (ExpressRouteCircuitsRoutesTableListResult, error)) ExpressRouteCircuitsRoutesTableListResultPage
Creates a new instance of the ExpressRouteCircuitsRoutesTableListResultPage type.
func (page *ExpressRouteCircuitsRoutesTableListResultPage) 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 *ExpressRouteCircuitsRoutesTableListResultPage) 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 ExpressRouteCircuitsRoutesTableListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page ExpressRouteCircuitsRoutesTableListResultPage) Response() ExpressRouteCircuitsRoutesTableListResult
Response returns the raw server response from the last page request.
func (page ExpressRouteCircuitsRoutesTableListResultPage) Values() []ExpressRouteCircuitRoutesTable
Values returns the slice of values for the current page or nil if there are no values.
type ExpressRouteCircuitsStatsListResult struct {
autorest.Response `json:"-"`
// Value - Gets List of Stats
Value *[]ExpressRouteCircuitStats `json:"value,omitempty"`
// NextLink - Gets the URL to get the next set of results.
NextLink *string `json:"nextLink,omitempty"`
}ExpressRouteCircuitsStatsListResult response for ListStats from Express Route Circuits Api service call
func (ercslr ExpressRouteCircuitsStatsListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type ExpressRouteCircuitsStatsListResultIterator struct {
// contains filtered or unexported fields
}ExpressRouteCircuitsStatsListResultIterator provides access to a complete listing of ExpressRouteCircuitStats values.
func NewExpressRouteCircuitsStatsListResultIterator(page ExpressRouteCircuitsStatsListResultPage) ExpressRouteCircuitsStatsListResultIterator
Creates a new instance of the ExpressRouteCircuitsStatsListResultIterator type.
func (iter *ExpressRouteCircuitsStatsListResultIterator) 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 *ExpressRouteCircuitsStatsListResultIterator) 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 ExpressRouteCircuitsStatsListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter ExpressRouteCircuitsStatsListResultIterator) Response() ExpressRouteCircuitsStatsListResult
Response returns the raw server response from the last page request.
func (iter ExpressRouteCircuitsStatsListResultIterator) Value() ExpressRouteCircuitStats
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type ExpressRouteCircuitsStatsListResultPage struct {
// contains filtered or unexported fields
}ExpressRouteCircuitsStatsListResultPage contains a page of ExpressRouteCircuitStats values.
func NewExpressRouteCircuitsStatsListResultPage(getNextPage func(context.Context, ExpressRouteCircuitsStatsListResult) (ExpressRouteCircuitsStatsListResult, error)) ExpressRouteCircuitsStatsListResultPage
Creates a new instance of the ExpressRouteCircuitsStatsListResultPage type.
func (page *ExpressRouteCircuitsStatsListResultPage) 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 *ExpressRouteCircuitsStatsListResultPage) 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 ExpressRouteCircuitsStatsListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page ExpressRouteCircuitsStatsListResultPage) Response() ExpressRouteCircuitsStatsListResult
Response returns the raw server response from the last page request.
func (page ExpressRouteCircuitsStatsListResultPage) Values() []ExpressRouteCircuitStats
Values returns the slice of values for the current page or nil if there are no values.
type ExpressRouteServiceProvider struct {
*ExpressRouteServiceProviderPropertiesFormat `json:"properties,omitempty"`
// ID - Resource Identifier.
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(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 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 Identifier.
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. Inbound rules URIs that use this frontend IP.
InboundNatRules *[]SubResource `json:"inboundNatRules,omitempty"`
// InboundNatPools - Read only. Inbound pools URIs that use this frontend IP.
InboundNatPools *[]SubResource `json:"inboundNatPools,omitempty"`
// OutboundNatRules - Read only. Outbound rules URIs that use this frontend IP.
OutboundNatRules *[]SubResource `json:"outboundNatRules,omitempty"`
// LoadBalancingRules - 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.
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 Identifier.
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.
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 Identifier.
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 Identifier.
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 - 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.
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 Identifier.
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 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"`
}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 Identifier.
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 {
// 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"`
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(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"`
// 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) 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.
func (client InterfacesClient) GetVirtualMachineScaleSetNetworkInterfacePreparer(ctx context.Context, resourceGroupName string, virtualMachineScaleSetName string, virtualmachineIndex string, networkInterfaceName string, expand string) (*http.Request, error)
GetVirtualMachineScaleSetNetworkInterfacePreparer prepares the GetVirtualMachineScaleSetNetworkInterface request.
func (client InterfacesClient) GetVirtualMachineScaleSetNetworkInterfaceResponder(resp *http.Response) (result Interface, err error)
GetVirtualMachineScaleSetNetworkInterfaceResponder handles the response to the GetVirtualMachineScaleSetNetworkInterface request. The method always closes the http.Response Body.
func (client InterfacesClient) GetVirtualMachineScaleSetNetworkInterfaceSender(req *http.Request) (*http.Response, error)
GetVirtualMachineScaleSetNetworkInterfaceSender sends the GetVirtualMachineScaleSetNetworkInterface request. The method will close the http.Response Body if it receives an error.
func (client InterfacesClient) List(ctx context.Context, resourceGroupName string) (result InterfaceListResultPage, err error)
List gets all network interfaces in a resource group. Parameters: resourceGroupName - the name of the resource group.
func (client InterfacesClient) ListAll(ctx context.Context) (result InterfaceListResultPage, err error)
ListAll gets all network interfaces in a subscription.
func (client InterfacesClient) ListAllComplete(ctx context.Context) (result InterfaceListResultIterator, err error)
ListAllComplete enumerates all values, automatically crossing page boundaries as required.
ListAllPreparer prepares the ListAll request.
func (client InterfacesClient) ListAllResponder(resp *http.Response) (result InterfaceListResult, 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 InterfacesClient) ListComplete(ctx context.Context, resourceGroupName string) (result InterfaceListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client InterfacesClient) ListPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
ListPreparer prepares the List request.
func (client InterfacesClient) ListResponder(resp *http.Response) (result InterfaceListResult, 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 InterfacesClient) ListVirtualMachineScaleSetNetworkInterfaces(ctx context.Context, resourceGroupName string, virtualMachineScaleSetName string) (result InterfaceListResultPage, err error)
ListVirtualMachineScaleSetNetworkInterfaces gets all network interfaces in a virtual machine scale set. Parameters: resourceGroupName - the name of the resource group. virtualMachineScaleSetName - the name of the virtual machine scale set.
func (client InterfacesClient) ListVirtualMachineScaleSetNetworkInterfacesComplete(ctx context.Context, resourceGroupName string, virtualMachineScaleSetName string) (result InterfaceListResultIterator, err error)
ListVirtualMachineScaleSetNetworkInterfacesComplete enumerates all values, automatically crossing page boundaries as required.
func (client InterfacesClient) ListVirtualMachineScaleSetNetworkInterfacesPreparer(ctx context.Context, resourceGroupName string, virtualMachineScaleSetName string) (*http.Request, error)
ListVirtualMachineScaleSetNetworkInterfacesPreparer prepares the ListVirtualMachineScaleSetNetworkInterfaces request.
func (client InterfacesClient) ListVirtualMachineScaleSetNetworkInterfacesResponder(resp *http.Response) (result InterfaceListResult, err error)
ListVirtualMachineScaleSetNetworkInterfacesResponder handles the response to the ListVirtualMachineScaleSetNetworkInterfaces request. The method always closes the http.Response Body.
func (client InterfacesClient) ListVirtualMachineScaleSetNetworkInterfacesSender(req *http.Request) (*http.Response, error)
ListVirtualMachineScaleSetNetworkInterfacesSender sends the ListVirtualMachineScaleSetNetworkInterfaces request. The method will close the http.Response Body if it receives an error.
func (client InterfacesClient) ListVirtualMachineScaleSetVMNetworkInterfaces(ctx context.Context, resourceGroupName string, virtualMachineScaleSetName string, virtualmachineIndex string) (result InterfaceListResultPage, err error)
ListVirtualMachineScaleSetVMNetworkInterfaces gets information about all network interfaces in a virtual machine 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.
func (client InterfacesClient) ListVirtualMachineScaleSetVMNetworkInterfacesComplete(ctx context.Context, resourceGroupName string, virtualMachineScaleSetName string, virtualmachineIndex string) (result InterfaceListResultIterator, err error)
ListVirtualMachineScaleSetVMNetworkInterfacesComplete enumerates all values, automatically crossing page boundaries as required.
func (client InterfacesClient) ListVirtualMachineScaleSetVMNetworkInterfacesPreparer(ctx context.Context, resourceGroupName string, virtualMachineScaleSetName string, virtualmachineIndex string) (*http.Request, error)
ListVirtualMachineScaleSetVMNetworkInterfacesPreparer prepares the ListVirtualMachineScaleSetVMNetworkInterfaces request.
func (client InterfacesClient) ListVirtualMachineScaleSetVMNetworkInterfacesResponder(resp *http.Response) (result InterfaceListResult, err error)
ListVirtualMachineScaleSetVMNetworkInterfacesResponder handles the response to the ListVirtualMachineScaleSetVMNetworkInterfaces request. The method always closes the http.Response Body.
func (client InterfacesClient) ListVirtualMachineScaleSetVMNetworkInterfacesSender(req *http.Request) (*http.Response, error)
ListVirtualMachineScaleSetVMNetworkInterfacesSender sends the ListVirtualMachineScaleSetVMNetworkInterfaces request. The method will close the http.Response Body if it receives an error.
InterfacesCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
func (future *InterfacesCreateOrUpdateFuture) Result(client InterfacesClient) (i Interface, err error)
Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.
InterfacesDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
func (future *InterfacesDeleteFuture) Result(client InterfacesClient) (ar autorest.Response, err error)
Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.
type LoadBalancer struct {
autorest.Response `json:"-"`
*LoadBalancerPropertiesFormat `json:"properties,omitempty"`
// Etag - A unique read-only string that changes whenever the resource is updated.
Etag *string `json:"etag,omitempty"`
// ID - Resource Identifier.
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"`
}LoadBalancer loadBalancer resource
func (lb LoadBalancer) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for LoadBalancer.
func (lb *LoadBalancer) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for LoadBalancer struct.
type LoadBalancerListResult struct {
autorest.Response `json:"-"`
// Value - A list of load balancers in a resource group.
Value *[]LoadBalancer `json:"value,omitempty"`
// NextLink - The URL to get the next set of results.
NextLink *string `json:"nextLink,omitempty"`
}LoadBalancerListResult response for ListLoadBalancers API service call.
func (lblr LoadBalancerListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type LoadBalancerListResultIterator struct {
// contains filtered or unexported fields
}LoadBalancerListResultIterator provides access to a complete listing of LoadBalancer values.
func NewLoadBalancerListResultIterator(page LoadBalancerListResultPage) LoadBalancerListResultIterator
Creates a new instance of the LoadBalancerListResultIterator type.
func (iter *LoadBalancerListResultIterator) 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 *LoadBalancerListResultIterator) 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 LoadBalancerListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter LoadBalancerListResultIterator) Response() LoadBalancerListResult
Response returns the raw server response from the last page request.
func (iter LoadBalancerListResultIterator) Value() LoadBalancer
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type LoadBalancerListResultPage struct {
// contains filtered or unexported fields
}LoadBalancerListResultPage contains a page of LoadBalancer values.
func NewLoadBalancerListResultPage(getNextPage func(context.Context, LoadBalancerListResult) (LoadBalancerListResult, error)) LoadBalancerListResultPage
Creates a new instance of the LoadBalancerListResultPage type.
func (page *LoadBalancerListResultPage) 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 *LoadBalancerListResultPage) 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 LoadBalancerListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page LoadBalancerListResultPage) Response() LoadBalancerListResult
Response returns the raw server response from the last page request.
func (page LoadBalancerListResultPage) Values() []LoadBalancer
Values returns the slice of values for the current page or nil if there are no values.
type LoadBalancerPropertiesFormat struct {
// FrontendIPConfigurations - Object representing the frontend IPs to be used for the load balancer
FrontendIPConfigurations *[]FrontendIPConfiguration `json:"frontendIPConfigurations,omitempty"`
// BackendAddressPools - Collection of backend address pools used by a load balancer
BackendAddressPools *[]BackendAddressPool `json:"backendAddressPools,omitempty"`
// LoadBalancingRules - Object collection representing the load balancing rules Gets the provisioning
LoadBalancingRules *[]LoadBalancingRule `json:"loadBalancingRules,omitempty"`
// Probes - Collection of probe objects used in the load balancer
Probes *[]Probe `json:"probes,omitempty"`
// InboundNatRules - Collection of inbound NAT Rules used by a load balancer. Defining inbound NAT rules on your load balancer is mutually exclusive with defining an inbound NAT pool. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an Inbound NAT pool. They have to reference individual inbound NAT rules.
InboundNatRules *[]InboundNatRule `json:"inboundNatRules,omitempty"`
// InboundNatPools - Defines an external port range for inbound NAT to a single backend port on NICs associated with a load balancer. Inbound NAT rules are created automatically for each NIC associated with the Load Balancer using an external port from this range. Defining an Inbound NAT pool on your Load Balancer is mutually exclusive with defining inbound Nat rules. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an inbound NAT pool. They have to reference individual inbound NAT rules.
InboundNatPools *[]InboundNatPool `json:"inboundNatPools,omitempty"`
// OutboundNatRules - The outbound NAT rules.
OutboundNatRules *[]OutboundNatRule `json:"outboundNatRules,omitempty"`
// ResourceGUID - The resource GUID property of the load balancer resource.
ResourceGUID *string `json:"resourceGuid,omitempty"`
// ProvisioningState - Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.
ProvisioningState *string `json:"provisioningState,omitempty"`
}LoadBalancerPropertiesFormat properties of the load balancer.
type LoadBalancersClient struct {
BaseClient
}LoadBalancersClient is the network Client
func NewLoadBalancersClient(subscriptionID string) LoadBalancersClient
NewLoadBalancersClient creates an instance of the LoadBalancersClient client.
func NewLoadBalancersClientWithBaseURI(baseURI string, subscriptionID string) LoadBalancersClient
NewLoadBalancersClientWithBaseURI creates an instance of the LoadBalancersClient 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 LoadBalancersClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, loadBalancerName string, parameters LoadBalancer) (result LoadBalancersCreateOrUpdateFuture, err error)
CreateOrUpdate creates or updates a load balancer. Parameters: resourceGroupName - the name of the resource group. loadBalancerName - the name of the load balancer. parameters - parameters supplied to the create or update load balancer operation.
func (client LoadBalancersClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, loadBalancerName string, parameters LoadBalancer) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client LoadBalancersClient) CreateOrUpdateResponder(resp *http.Response) (result LoadBalancer, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client LoadBalancersClient) CreateOrUpdateSender(req *http.Request) (future LoadBalancersCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client LoadBalancersClient) Delete(ctx context.Context, resourceGroupName string, loadBalancerName string) (result LoadBalancersDeleteFuture, err error)
Delete deletes the specified load balancer. Parameters: resourceGroupName - the name of the resource group. loadBalancerName - the name of the load balancer.
func (client LoadBalancersClient) DeletePreparer(ctx context.Context, resourceGroupName string, loadBalancerName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client LoadBalancersClient) 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 LoadBalancersClient) DeleteSender(req *http.Request) (future LoadBalancersDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client LoadBalancersClient) Get(ctx context.Context, resourceGroupName string, loadBalancerName string, expand string) (result LoadBalancer, err error)
Get gets the specified load balancer. Parameters: resourceGroupName - the name of the resource group. loadBalancerName - the name of the load balancer. expand - expands referenced resources.
func (client LoadBalancersClient) GetPreparer(ctx context.Context, resourceGroupName string, loadBalancerName string, expand string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client LoadBalancersClient) GetResponder(resp *http.Response) (result LoadBalancer, 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 LoadBalancersClient) List(ctx context.Context, resourceGroupName string) (result LoadBalancerListResultPage, err error)
List gets all the load balancers in a resource group. Parameters: resourceGroupName - the name of the resource group.
func (client LoadBalancersClient) ListAll(ctx context.Context) (result LoadBalancerListResultPage, err error)
ListAll gets all the load balancers in a subscription.
func (client LoadBalancersClient) ListAllComplete(ctx context.Context) (result LoadBalancerListResultIterator, err error)
ListAllComplete enumerates all values, automatically crossing page boundaries as required.
ListAllPreparer prepares the ListAll request.
func (client LoadBalancersClient) ListAllResponder(resp *http.Response) (result LoadBalancerListResult, 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 LoadBalancersClient) ListComplete(ctx context.Context, resourceGroupName string) (result LoadBalancerListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client LoadBalancersClient) ListPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
ListPreparer prepares the List request.
func (client LoadBalancersClient) ListResponder(resp *http.Response) (result LoadBalancerListResult, 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.
LoadBalancersCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
func (future *LoadBalancersCreateOrUpdateFuture) Result(client LoadBalancersClient) (lb LoadBalancer, err error)
Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.
LoadBalancersDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
func (future *LoadBalancersDeleteFuture) Result(client LoadBalancersClient) (ar autorest.Response, err error)
Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.
type LoadBalancingRule struct {
*LoadBalancingRulePropertiesFormat `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 Identifier.
ID *string `json:"id,omitempty"`
}LoadBalancingRule a load balancing rule for a load balancer.
func (lbr LoadBalancingRule) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for LoadBalancingRule.
func (lbr *LoadBalancingRule) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for LoadBalancingRule struct.
type LoadBalancingRulePropertiesFormat struct {
// FrontendIPConfiguration - A reference to frontend IP addresses.
FrontendIPConfiguration *SubResource `json:"frontendIPConfiguration,omitempty"`
// BackendAddressPool - A reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs.
BackendAddressPool *SubResource `json:"backendAddressPool,omitempty"`
// Probe - The reference of the load balancer probe used by the load balancing rule.
Probe *SubResource `json:"probe,omitempty"`
// Protocol - The transport protocol for the external endpoint. Possible values are 'Udp' or 'Tcp'. Possible values include: 'TransportProtocolUDP', 'TransportProtocolTCP'
Protocol TransportProtocol `json:"protocol,omitempty"`
// LoadDistribution - The load distribution policy for this rule. Possible values are 'Default', 'SourceIP', and 'SourceIPProtocol'. Possible values include: 'Default', 'SourceIP', 'SourceIPProtocol'
LoadDistribution LoadDistribution `json:"loadDistribution,omitempty"`
// FrontendPort - The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 1 and 65534.
FrontendPort *int32 `json:"frontendPort,omitempty"`
// BackendPort - The port used for internal connections on the endpoint. Acceptable values are between 1 and 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 PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.
ProvisioningState *string `json:"provisioningState,omitempty"`
}LoadBalancingRulePropertiesFormat properties of the load balancer.
LoadDistribution enumerates the values for load distribution.
const (
// Default ...
Default LoadDistribution = "Default"
// SourceIP ...
SourceIP LoadDistribution = "SourceIP"
// SourceIPProtocol ...
SourceIPProtocol LoadDistribution = "SourceIPProtocol"
)func PossibleLoadDistributionValues() []LoadDistribution
PossibleLoadDistributionValues returns an array of possible values for the LoadDistribution const type.
type LocalNetworkGateway struct {
autorest.Response `json:"-"`
*LocalNetworkGatewayPropertiesFormat `json:"properties,omitempty"`
// Etag - Gets a unique read-only string that changes whenever the resource is updated
Etag *string `json:"etag,omitempty"`
// ID - Resource Identifier.
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"`
}LocalNetworkGateway a common class for general resource information
func (lng LocalNetworkGateway) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for LocalNetworkGateway.
func (lng *LocalNetworkGateway) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for LocalNetworkGateway struct.
type LocalNetworkGatewayListResult struct {
autorest.Response `json:"-"`
// Value - A list of local network gateways that exists in a resource group.
Value *[]LocalNetworkGateway `json:"value,omitempty"`
// NextLink - The URL to get the next set of results.
NextLink *string `json:"nextLink,omitempty"`
}LocalNetworkGatewayListResult response for ListLocalNetworkGateways API service call.
func (lnglr LocalNetworkGatewayListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type LocalNetworkGatewayListResultIterator struct {
// contains filtered or unexported fields
}LocalNetworkGatewayListResultIterator provides access to a complete listing of LocalNetworkGateway values.
func NewLocalNetworkGatewayListResultIterator(page LocalNetworkGatewayListResultPage) LocalNetworkGatewayListResultIterator
Creates a new instance of the LocalNetworkGatewayListResultIterator type.
func (iter *LocalNetworkGatewayListResultIterator) 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 *LocalNetworkGatewayListResultIterator) 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 LocalNetworkGatewayListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter LocalNetworkGatewayListResultIterator) Response() LocalNetworkGatewayListResult
Response returns the raw server response from the last page request.
func (iter LocalNetworkGatewayListResultIterator) Value() LocalNetworkGateway
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type LocalNetworkGatewayListResultPage struct {
// contains filtered or unexported fields
}LocalNetworkGatewayListResultPage contains a page of LocalNetworkGateway values.
func NewLocalNetworkGatewayListResultPage(getNextPage func(context.Context, LocalNetworkGatewayListResult) (LocalNetworkGatewayListResult, error)) LocalNetworkGatewayListResultPage
Creates a new instance of the LocalNetworkGatewayListResultPage type.
func (page *LocalNetworkGatewayListResultPage) 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 *LocalNetworkGatewayListResultPage) 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 LocalNetworkGatewayListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page LocalNetworkGatewayListResultPage) Response() LocalNetworkGatewayListResult
Response returns the raw server response from the last page request.
func (page LocalNetworkGatewayListResultPage) Values() []LocalNetworkGateway
Values returns the slice of values for the current page or nil if there are no values.
type LocalNetworkGatewayPropertiesFormat struct {
// LocalNetworkAddressSpace - Local network site address space.
LocalNetworkAddressSpace *AddressSpace `json:"localNetworkAddressSpace,omitempty"`
// GatewayIPAddress - IP address of local network gateway.
GatewayIPAddress *string `json:"gatewayIpAddress,omitempty"`
// BgpSettings - Local network gateway's BGP speaker settings.
BgpSettings *BgpSettings `json:"bgpSettings,omitempty"`
// ResourceGUID - The resource GUID property of the LocalNetworkGateway resource.
ResourceGUID *string `json:"resourceGuid,omitempty"`
// ProvisioningState - Gets or sets Provisioning state of the LocalNetworkGateway resource Updating/Deleting/Failed
ProvisioningState *string `json:"provisioningState,omitempty"`
}LocalNetworkGatewayPropertiesFormat localNetworkGateway properties
type LocalNetworkGatewaysClient struct {
BaseClient
}LocalNetworkGatewaysClient is the network Client
func NewLocalNetworkGatewaysClient(subscriptionID string) LocalNetworkGatewaysClient
NewLocalNetworkGatewaysClient creates an instance of the LocalNetworkGatewaysClient client.
func NewLocalNetworkGatewaysClientWithBaseURI(baseURI string, subscriptionID string) LocalNetworkGatewaysClient
NewLocalNetworkGatewaysClientWithBaseURI creates an instance of the LocalNetworkGatewaysClient 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 LocalNetworkGatewaysClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, localNetworkGatewayName string, parameters LocalNetworkGateway) (result LocalNetworkGatewaysCreateOrUpdateFuture, err error)
CreateOrUpdate creates or updates a local network gateway in the specified resource group. Parameters: resourceGroupName - the name of the resource group. localNetworkGatewayName - the name of the local network gateway. parameters - parameters supplied to the create or update local network gateway operation.
func (client LocalNetworkGatewaysClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, localNetworkGatewayName string, parameters LocalNetworkGateway) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client LocalNetworkGatewaysClient) CreateOrUpdateResponder(resp *http.Response) (result LocalNetworkGateway, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client LocalNetworkGatewaysClient) CreateOrUpdateSender(req *http.Request) (future LocalNetworkGatewaysCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client LocalNetworkGatewaysClient) Delete(ctx context.Context, resourceGroupName string, localNetworkGatewayName string) (result LocalNetworkGatewaysDeleteFuture, err error)
Delete deletes the specified local network gateway. Parameters: resourceGroupName - the name of the resource group. localNetworkGatewayName - the name of the local network gateway.
func (client LocalNetworkGatewaysClient) DeletePreparer(ctx context.Context, resourceGroupName string, localNetworkGatewayName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client LocalNetworkGatewaysClient) 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 LocalNetworkGatewaysClient) DeleteSender(req *http.Request) (future LocalNetworkGatewaysDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client LocalNetworkGatewaysClient) Get(ctx context.Context, resourceGroupName string, localNetworkGatewayName string) (result LocalNetworkGateway, err error)
Get gets the specified local network gateway in a resource group. Parameters: resourceGroupName - the name of the resource group. localNetworkGatewayName - the name of the local network gateway.
func (client LocalNetworkGatewaysClient) GetPreparer(ctx context.Context, resourceGroupName string, localNetworkGatewayName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client LocalNetworkGatewaysClient) GetResponder(resp *http.Response) (result LocalNetworkGateway, 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 LocalNetworkGatewaysClient) List(ctx context.Context, resourceGroupName string) (result LocalNetworkGatewayListResultPage, err error)
List gets all the local network gateways in a resource group. Parameters: resourceGroupName - the name of the resource group.
func (client LocalNetworkGatewaysClient) ListComplete(ctx context.Context, resourceGroupName string) (result LocalNetworkGatewayListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client LocalNetworkGatewaysClient) ListPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
ListPreparer prepares the List request.
func (client LocalNetworkGatewaysClient) ListResponder(resp *http.Response) (result LocalNetworkGatewayListResult, 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.
LocalNetworkGatewaysCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
func (future *LocalNetworkGatewaysCreateOrUpdateFuture) Result(client LocalNetworkGatewaysClient) (lng LocalNetworkGateway, err error)
Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.
LocalNetworkGatewaysDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
func (future *LocalNetworkGatewaysDeleteFuture) Result(client LocalNetworkGatewaysClient) (ar autorest.Response, err error)
Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.
OperationStatus enumerates the values for operation status.
const (
// Failed ...
Failed OperationStatus = "Failed"
// InProgress ...
InProgress OperationStatus = "InProgress"
// Succeeded ...
Succeeded OperationStatus = "Succeeded"
)func PossibleOperationStatusValues() []OperationStatus
PossibleOperationStatusValues returns an array of possible values for the OperationStatus const type.
type OutboundNatRule struct {
*OutboundNatRulePropertiesFormat `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 Identifier.
ID *string `json:"id,omitempty"`
}OutboundNatRule outbound NAT pool of the load balancer.
func (onr OutboundNatRule) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for OutboundNatRule.
func (onr *OutboundNatRule) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for OutboundNatRule struct.
type OutboundNatRulePropertiesFormat struct {
// AllocatedOutboundPorts - The number of outbound ports to be used for NAT.
AllocatedOutboundPorts *int32 `json:"allocatedOutboundPorts,omitempty"`
// FrontendIPConfigurations - The Frontend IP addresses of the load balancer.
FrontendIPConfigurations *[]SubResource `json:"frontendIPConfigurations,omitempty"`
// BackendAddressPool - A reference to a pool of DIPs. Outbound traffic is randomly load balanced across IPs in the backend IPs.
BackendAddressPool *SubResource `json:"backendAddressPool,omitempty"`
// ProvisioningState - Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.
ProvisioningState *string `json:"provisioningState,omitempty"`
}OutboundNatRulePropertiesFormat outbound NAT pool of the load balancer.
type Probe struct {
*ProbePropertiesFormat `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 Identifier.
ID *string `json:"id,omitempty"`
}Probe a load balancer probe.
MarshalJSON is the custom marshaler for Probe.
UnmarshalJSON is the custom unmarshaler for Probe struct.
type ProbePropertiesFormat struct {
// LoadBalancingRules - The load balancer rules that use this probe.
LoadBalancingRules *[]SubResource `json:"loadBalancingRules,omitempty"`
// Protocol - The protocol of the end point. Possible values are: 'Http' or 'Tcp'. If 'Tcp' is specified, a received ACK is required for the probe to be successful. If 'Http' is specified, a 200 OK response from the specifies URI is required for the probe to be successful. Possible values include: 'ProbeProtocolHTTP', 'ProbeProtocolTCP'
Protocol ProbeProtocol `json:"protocol,omitempty"`
// Port - The port for communicating the probe. Possible values range from 1 to 65535, inclusive.
Port *int32 `json:"port,omitempty"`
// IntervalInSeconds - The interval, in seconds, for how frequently to probe the endpoint for health status. Typically, the interval is slightly less than half the allocated timeout period (in seconds) which allows two full probes before taking the instance out of rotation. The default value is 15, the minimum value is 5.
IntervalInSeconds *int32 `json:"intervalInSeconds,omitempty"`
// NumberOfProbes - The number of probes where if no response, will result in stopping further traffic from being delivered to the endpoint. This values allows endpoints to be taken out of rotation faster or slower than the typical times used in Azure.
NumberOfProbes *int32 `json:"numberOfProbes,omitempty"`
// RequestPath - The URI used for requesting health status from the VM. Path is required if a protocol is set to http. Otherwise, it is not allowed. There is no default value.
RequestPath *string `json:"requestPath,omitempty"`
// ProvisioningState - Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.
ProvisioningState *string `json:"provisioningState,omitempty"`
}ProbePropertiesFormat ...
ProbeProtocol enumerates the values for probe protocol.
const (
// ProbeProtocolHTTP ...
ProbeProtocolHTTP ProbeProtocol = "Http"
// ProbeProtocolTCP ...
ProbeProtocolTCP ProbeProtocol = "Tcp"
)func PossibleProbeProtocolValues() []ProbeProtocol
PossibleProbeProtocolValues returns an array of possible values for the ProbeProtocol const type.
ProcessorArchitecture enumerates the values for processor architecture.
const (
// Amd64 ...
Amd64 ProcessorArchitecture = "Amd64"
// X86 ...
X86 ProcessorArchitecture = "X86"
)func PossibleProcessorArchitectureValues() []ProcessorArchitecture
PossibleProcessorArchitectureValues returns an array of possible values for the ProcessorArchitecture const type.
type PublicIPAddress struct {
autorest.Response `json:"-"`
*PublicIPAddressPropertiesFormat `json:"properties,omitempty"`
// Etag - A unique read-only string that changes whenever the resource is updated.
Etag *string `json:"etag,omitempty"`
// ID - Resource Identifier.
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"`
}PublicIPAddress public IP address resource.
func (pia PublicIPAddress) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PublicIPAddress.
func (pia *PublicIPAddress) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for PublicIPAddress struct.
type PublicIPAddressDNSSettings struct {
// DomainNameLabel - Gets or sets the Domain name label.The concatenation of the domain name label and the regionalized DNS zone make up the fully qualified domain name associated with the public IP address. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system.
DomainNameLabel *string `json:"domainNameLabel,omitempty"`
// Fqdn - Gets the FQDN, Fully qualified domain name of the A DNS record associated with the public IP. This is the concatenation of the domainNameLabel and the regionalized DNS zone.
Fqdn *string `json:"fqdn,omitempty"`
// ReverseFqdn - Gets or Sets the Reverse FQDN. A user-visible, fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN.
ReverseFqdn *string `json:"reverseFqdn,omitempty"`
}PublicIPAddressDNSSettings contains FQDN of the DNS record associated with the public IP address
type PublicIPAddressListResult struct {
autorest.Response `json:"-"`
// Value - A list of public IP addresses that exists in a resource group.
Value *[]PublicIPAddress `json:"value,omitempty"`
// NextLink - The URL to get the next set of results.
NextLink *string `json:"nextLink,omitempty"`
}PublicIPAddressListResult response for ListPublicIpAddresses API service call.
func (pialr PublicIPAddressListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type PublicIPAddressListResultIterator struct {
// contains filtered or unexported fields
}PublicIPAddressListResultIterator provides access to a complete listing of PublicIPAddress values.
func NewPublicIPAddressListResultIterator(page PublicIPAddressListResultPage) PublicIPAddressListResultIterator
Creates a new instance of the PublicIPAddressListResultIterator type.
func (iter *PublicIPAddressListResultIterator) 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 *PublicIPAddressListResultIterator) 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 PublicIPAddressListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter PublicIPAddressListResultIterator) Response() PublicIPAddressListResult
Response returns the raw server response from the last page request.
func (iter PublicIPAddressListResultIterator) Value() PublicIPAddress
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type PublicIPAddressListResultPage struct {
// contains filtered or unexported fields
}PublicIPAddressListResultPage contains a page of PublicIPAddress values.